Loket.nl API (V2)
Download OpenAPI specification:
Is this your first time here? Please check out our introduction to Loket (API)
The initial loading time of this developer portal may be very long due to the large number of endpoints designs being rendered when loading the page. We are looking into an alternative solution but for now please bear in mind.
The Loket.nl API is a RESTful API that exposes the data and features of the Loket.nl platform. The API accepts and returns JSON and can only be accessed by registered users. This documentation describes version 2 of the API.
Are you looking to partner up and start building an integration based on the Loket RESTful API? Please check out the steps for partners on our website .
Have you received your client and user credentials from us? Check out the following Postman collection to help you start making your first API calls on our acceptance environment. We would recommend to install the Postman desktop app.
Do you want to contact us with any further questions or remarks regarding the Loket RESTful API? Please send an email to api@loket.nl, and we will get back to you.
The Loket.nl API has two different environments. The first environment is the "acceptance" environment which is used during development and returns test data. The second environment is the production environment which is to be used exclusively by approved applications. Both environments have their own URLs.
- The acceptance environment can be accessed at https://api.loket-acc.nl/v2/
- The production environment can be accessed at https://api.loket.nl/v2/
The endpoints are defined using the OpenAPI 3.1 specification, an industry-wide recognized standard for describing REST API's.
Please note: the endpoint documentation in this portal is not designed to be fully compatible with any automatic code generation tools.
Over the course of time the API, and policies regarding the API can and will change. These changes are subject to the following guidelines.
The following states hold true for the change policy for this API.
- Loket.nl may sometimes introduce changes to the API and policies without advance notice.
- Loket.nl will try to inform users of any (breaking) change in advance.
- Loket.nl will not be liable to you or any third party for such modifications or any adverse effects resulting from such modifications.
- Loket.nl will try to avoid breaking changes as much as possible.
In regard to changes Loket.nl will strive to adhere to the following notification periods per type of change. Due to our versioning strategy at resource level this API has the possibility to run multiple versions of the same resource at one time. This allows for a window in which both the old and new version are available. Allowing for a gradual move to the new version.
Type of change | Notification period | Support period old version |
---|---|---|
Non breaking change | 2 weeks | no new version |
Breaking change | 2 weeks | 6 months |
Critical | Due to the nature of these changes we might not be able to follow the normal procedure for change managment | depends on the severity of the issue |
We define a non breaking change as follows. Any change to the API that does not cause failures in the applications that consume that API.
- Introducing a new optional field to an existing resource
- Introducing a new endpoint
- Introducing a new operation (GET/PUT/POST/PATCH/DELETE)
- Introducing a new optional parameter to an endpoint
- Introducing a new version for a resource
We define a breaking change as follows. any change to an API that could potentially cause failures in the applications that consume that API.
- Changing an existing JSON element (name, datatype, pattern, min/max length etc)
- Removing a JSON element, endpoint, operation or parameter
- Introducing a required JSON element
- Introducing a required parameter to an endpoint
- Passing the
obsoleteDate
of a version for a resource
The Loket API uses two types of versioning. API versioning and resource versioning.
API versioning
API versioning is done via the path where after the domain URL (api.loket.nl) the path starts with the API version. The current version of the API is V2. The API version is expected to change rarely as resource versioning is available to tackle most issues that need versioning.
Resource versioning
Every JSON resource in the API is versioned via the Accept header.
Allowing users of the API to influence what version is returned by setting the mandatory accept header.
The Accept header of request should have a value like application/json;version=2018-01-01
.
Here, the second part of the header is used to refer to a specific version of the resource (2018-01-01).
When calling the API it is possible to supply other dates rather than the exact resources version(s).
The businesslogic will select the version that is ON or BEFORE the given date. If no accept header with a resource version is given the newest version of the resource is returned
For example: let's say there are two versions of a resource.
These are 2018-01-01 and 2018-09-01. When calling the API you supply application/json;version=2018-08-01
,
in that case the API will use the version 2018-01-01 as its the nearest version in the past.
A response returns what resourceVersion
was used and the 'obsoleteDate' of that version (in most cases this is NULL).
The obsoleteDate
indicates when the resources version will no longer be available via the API.
With the introduction of a new version of a resource the obsoleteDate
for the old version will be set to 6 months after the introduction of the new resource.
Allowing consumers of the resource 6 months to incorporate the change. Failure to do so will likely lead to failure in the implementation.
In this developer portal you can find the service contracts for each, active, version of a resource. If, only if, there are multiple versions of a resource you can select the corresponding schema at that resource.
The changelog for this API can be found here.
We strongly advise every user ofthe Loket REST API the subscribe to the email feed. Please check out the link on the changelog page.
Your use and access to the API is expressly conditioned on your compliance with the policies and restrictions related to the API. If Loket.nl believes that you have or attempted to violate any term, condition, or the spirit of these policies or agreements, your right to access and use the API may be temporarily or permanently revoked.
Authorization in the Loket API is based on the industry-standard OAuth 2.0 protocol. For general information on OAuth 2.0 we kindly refer to the publicly-available documentation, https://oauth.net/2/
An authorized user is required to call the Loket API.
Note: This is an SSL-only API.
Note: Only TLS 1.2 is supported.
Environment | TokenUrl |
---|---|
Acceptance | https://oauth.loket-acc.nl/token |
Production | https://oauth.loket.nl/token |
The following OAuth 2.0 flows are supported
- Authorization Code flow (standard)
- Refresh Token flow (extension on the Authorization Code Flow)
- SSO flow (single sign-on)
- Password flow
For most clients only the authorization_code (and thus refresh_token) will be supported. Password grant type is not available for an external client.
Please click the link below to see documentation on implementing the authorization code flow by external clients.
Documentation on implementing the OAuth 2.0 authorization code flow
After the authorization code flow yields a refresh token the refresh_token grant can be used to obtain an access/bearer token. The expire time of the access/bearer is also returned in the response please take this into account. With the refresh token flow the two factor step will be skipped.
Refresh token request example:
POST /token
grant_type=refresh_token&refresh_token={RefreshToken123}&client_Id={Client123}&client_secret={Secret123}
Refresh token response example:
{
"access_token": "JESJDhMBy0NPTM9SiXmYAzW45clOiQ5wSyDq3VWluguGNoKym4WPSiJoTDx67TQ",
"token_type": "bearer",
"expires_in": 3599,
"refresh_token": "nGJtF6j6SeQbHAg",
"two_factor_state": "None"
}
The SSO (single sign-on) flow is based on OAuth 2.0 and requires the authorization flow to be completed.
For more information see: Documentation on OAuth 2.0 SSO flow (for allowed clients)
Please note: Among other things, it is possible to set up an SSO flow with both Loket en Werknemerloket.
The password flow is typically NOT enabled for external clients. Only by exception will the password flow be enabled for security (and practical) reasons.
Password token request examples:
POST /token
grant_type=password&username={UserName123}&password={Password123}&client_Id={Client123}&client_secret={Secret123}
Whether client_secret is required is dependent on the configuration of the client.
In this section we explain how the API authorization service determines if a request is authorized or not.
In almost all use-cases a Loket user should meet the following requirements to successfully setup an integration with that user.
- The user must be a normal Loket user (so NOT a webservice user)
- The user must be active (not blocked)
- The user must have access to an employer
- For provider users this is done by assigning the user to the appropriate Team(s)
- For employer users this is done by creating a user for or linking the user to the appropriate employer(s)
- The user must have all appropriate rights
- For provider users this is done by assigning appropriate rights via Team (or alternatively, directly to the user)
- For employer users this is done by assigning appropriate rights to the user on employer level
How to setup an integration is described in the Authentication section.
Side notes:
- A user can have access to multiple employers with different rights per employer.
- Please note that users set up to use the SOAP webservices (webservicegebruikers) are in no way suited to perform calls to the RESTful API, these require entirely different user set-ups.
- User management on production is typically done by the provider (i.e. the accountant) and sometimes the employer. This is NOT something Loket.nl itself can do.
The Loket.nl API accepts and returns JSON. Comform the OpenAPI 3.0 specification the following data types are supported:
- string
- number (point is used to separate the integer part from the fractional part of a number)
- integer (from OpenAPI)
- object
- array
- boolean
For most of these types, further specifications can be found in the format
and pattern
specifications in the service contract.
For example a format: date
added to a string field indicates a valid date must be supplied.
Fields of the type 'metadata' are fields for which the possible values can be acquired via the metadata endpoint of the resource.
The metedata can be obtained by appending /metadata to the current endpoint. Using the GET verb the endpoint will return a JSON output with "all" the metadata for the given resource. In some cases multiple requests are needed to obtain all the metadata required, an exmple is given below. Typically different metadata endpoints are availalbe for the POST and the PUT endpoint.
If metadata endpoints are avaible for a given endpoint/resource is mentioned in the description of that endpoint.
Example response
{[
{
"field": "gender"
options: [
{
"key": 1,
"value":"Man"
}
{
"key": 2,
"value":"Vrouw"
}
]
},
{
"field": "country"
options: [
{
"isoCode":"NL",
"key": 530,
"value":"Nederland"
}
{
"isoCode":"BE",
"key": 540,
"value":"België"
}
]
}
]}
Example urls
Acquiring metadata for a POST Wage
/v2/providers/employers/employees/employments/{employmentId}/wages/metadata
Acquiring metadata for a PUT employee
/v2/providers/employers/employees/{employeeId}/metadata
Multiple requests to get all the metadata
In some cases there are metadata fields dependant on the selected value off another metadata field. Such is the case when adding a new concept employee. This is done in the employer context while several of the metadata fields are dependant on the payrollAdministration context.
For example:
Request 1, first of a normal metadata request is performed. The response for this request will contain a list of payrolladministration for the given employer.
/v2/providers/employers/b869ded6-0659-4d8d-9a8a-f9e22425ec9c/jobapplicant/metadata
Request 2, when a payrolladministration is selected perform a second request to acquire the payrolladministration specific metadata.
/v2/providers/employers/jobapplicant/metadata/payrolladministration/54369214-14a1-41ab-892a-ea8438e34d6f
Request 3, if a payScale
is selected perform a third request to acquire the payGrade
for that payScale
.
/v2/providers/employers/jobapplicant/metadata/salaryScaleType/54369214-14a1-41ab-892a-ea8438e34d6f
Types of metadata
We diferentiate between two types of metadata.
- Generic metadata field. The possible values for these fields are the same for every object no matter the provider, employer or employee etc. Examples are: country, gender and nationality.
- Context specific metadata field. Examples of contexts are employer, payroll administration, provider and Loket.nl. In most cases the possible values for these field are resources in themselves and can be managed via the API. If a metadata field is context specific the context is given in the description of the field. Examples are: function, department and leaveType.
Note: some context specific metadata field can have multiple contexts.
For example: it is possible to define an export set in the provider context. Making that export set available for all payroll administrations linked to the provider. It is also possible to add an export set in the payroll administration context. That export set is only available to that payroll administration. When requesting the metadata of export set the user will be presented with a combined list of the provider and payroll administration export sets.
Many fields in the API have a default value.
In order to assist our API users to adhere to these defaults when creating a record (POST) we provide /defaults
endpoints.
- An object returned by the
defaults
endpoint resembles a fully expanded GET-object of that resource. The only case when a part of the object is NOT fully expanded is for a metaData-object that does not have a default value (for example '"gender":NULL').- Whether an object within the resource is of the type metaData is indicated in the service contracts of that resource.
- Context is determined by the GUID given in the Path. Examples are employer, payroll administration, employee and employment.
- A scope is sometimes required to determine the defaults values. A scope could be a date by which Loket.nl can determine what default was active on that date. The scope can be set by supplying additional paraments in the request. If a scope is required but none is given the currently active or last know value is returned.
- The fields with no default will be set to null (even if the field is normally non-nullable).
- Because the GET-object is returned the readonly fields are also returned.
An example endpoint would be:
/v2/providers/employers/employees/employments/{employmentId}/payrollperioddata/defaults
resulting in the following output:
{
"payrollPeriod": null,
"shift": {
"shiftNumber": 1
},
"payslipType": {
"key": 2
},
"payslipText": null,
"distributionUnit": {
"key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
},
"costCenter": {
"key": 2
},
"costUnit": {
"key": 2
},
"payrollComponents": []
}
Note: Defaults endpoints are not yet generically available. If a Defaults endpoint exists this will be explicitly stated at that specific resource.
For most of the resources with a startDate and endDate a chain is maintained. Chain meaning that no records can overlap in time. Loket.nl has two types of chains.
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.
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.
Note: Chains are sometimes maintained with an additional context. For example, For benefits and deductions
the broken chain is maintained per payrollComponent
.
It is possible to have multiple active records for different payrollComponent
never two active records for the same payrollComponent
.
For some GET (list) endpoints the API supports exporting (part of) the output JSON as a XML/CSV file. This is done by setting the X-ReportInput
and Accept
header.
The Accept
header supports the following 2 options:
- CSV (text/csv;version=yyyy-MM-dd)
- Excel (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;version=yyyy-MM-dd)
The X-ReportInput
is a custom header that requires a JSON object with the following structure as input.
- fileNameWithoutExtension --> The filename without extension for the report 'FileNameWithoutExtension'
- delimiter --> The delimiter to be used. If not set "," is used
- decimalSeparator --> The decimalSepartor for number fields. If not set "." is used.
- fields --> Array of fields.
The 'fields' object contains one or more fields with the following properties:
- fieldName --> A Xpath reference to the field to be included in the export
- reportColumnName --> The column name for the field
- format --> Allows only for date formatting. e.g. dd-MM-yyyy for csv or dd-mm-yyyy for Excel (Excel only usses lowercase)
3.1 For CSV: see https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings
3.2 For Excel: https://support.microsoft.com/en-us/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68
Example X-ReportInput
:
{
"fileNameWithoutExtension":"MyExport",
"delimiter": ";",
"decimalSepartor": ",",
"fields":
[
{
"fieldName": "startDate",
"reportColumnName": "In dienst datum",
"format": "dd-MM-yyyy"
},
{
"fieldName": "personalDetails.firstName",
"reportColumnName": "First Name"
},
{
"fieldName": "personalDetails.lastName",
"reportColumnName": "Last Name"
}
]
}
Example request:
curl
--location
--request GET 'https://api.loket.nl/v2/providers/employers/155c8440-8ff6-4776-98db-5d2243a073e3/employees?orderby=employeeNumber' \
--header 'Content-Type: application/json' \
--header 'Accept: text/csv;version=2020-08-18' \
--header 'X-ReportInput: {"FileNameWithoutExtension":"MyExport","Fields":[{"fieldName":"personalDetails.initials","reportColumnName":"Initials"},{"fieldName":"personalDetails.firstName","reportColumnName":"First name"},{"fieldName":"personalDetails.lastName","reportColumnName":"Last name"}]}' \--header 'Authorization: Bearer ZKoiC_g_NfYA3v0' \
A request to the Loket.nl API consists of several components. Each of these components are discussed in this section.
The API can be accessed at https://api.loket.nl.
The version of the API is specified in the URL. The current version of the Loket.nl API is version 2. To access version 2 of the API, one simply appends v2
to the base URL. The full base URL of the API is therefore https://api.loket.nl/v2.
The endpoints defined in the OpenAPI definition of the Loket.nl API are appended to the base URL. For example, the endpoint /providers/employers/{employerId}/employees
can be accessed at https://api.loket.nl/v2/providers/employers/{employerId}/employees.
Most endpoints require path parameter(s) in order to specify the context of the request. For example, the endpoint /providers/employers/{employerId}/employees
contains the employerId
path parameter. A path parameter is a unique identifier that identifies a specific resource, in this case an employer.
The API supports two query parameters to control the pagination of the results: pageNumber
and pageSize
. Both of these query parameters only apply to endpoints that return lists of entities.
The pageNumber
query parameter specifies which page of the collection to return. By default pageNumber
is set to 1 which returns the first page of the collection. Note: the pageNumber refers to the page (with a given number of entities), NOT to a specific entity within a page!
The pageSize
query parameter influences the number of entities per page. By default pageSize
is set to 250. Note that this default may change in the future. It is not recommended to depend on this default when developing for the Loket.nl API.
Examples:
?pageNumber=2
to return the second page?pageSize=2
to set the page size to two
The API supports output filtering via the querystring parameter filter
.
Filtering is possible on all fields of the following datatypes:
- string
- integer
- boolean
- date-time
- decimals
The following operators are available:
Operator | Description | Example |
---|---|---|
Comparison Operators | ||
eq | Equal | city eq 'Redmond' |
ne | Not equal | city ne 'London' |
lk | Like | city lk 'Lond' |
gt | Greater than | price gt 20 |
ge | Greater than or equal | price ge 10 |
lt | Less than | price lt 20 |
le | Less than or equal | price le 100 |
Logical Operators | ||
and | Logical and | price le 200 and price gt 3.5 |
or | Logical or | price le 3.5 or price gt 200 |
Both field names and values are case insensitive. It is possible to filter on nested fields by adding the parent object before the field with a '.' to separate them. Do remember to URL encode the filter parameters.
Examples
All employments with a cancellation periode in months (the value 4 corresponds to months time unit).
/v2/providers/employers/{{employerId}}/employees/employments?filter=cancellationPeriodTimeUnit.key eq 4
All employments with no endDate.s
/v2/providers/employers/{{employerId}}/employees/employments?filter=enddate eq null
All employments with an end date less or equal to 2017-01-01
/v2/providers/employers/{{employerId}}/employees/employments?filter=enddate le '2017-01-01'
All employees with a employee number greater or equal 1 and less or equal 5
/v2/providers/employers/{{employerId}}/employees?filter=employeeNumber ge 1 and employeeNumber le 5
All Loket.nl API resources support ordering of the elements in the response on a specific field. All fields can be used in ordering. The list can be ordered in ascending or descending order, with ascending being the default one. Ordering on multiple fields is also by using a ',' as a separator.
Examples
Order employers by company name ascending
/v2/providers/employers?orderBy=companyName
Order employers by company name descending
/v2/providers/employers?orderBy=-companyName
Order employers by company name descending then by house number ascending
/v2/providers/employers?orderBy=-companyName,address.houseNumber
In order to access the endpoints of the Loket.nl API, at least two request headers need to be set.
1) the Authorization
header is required in order to authorize the API call.
The value of this header is the word Bearer followed by a space and the access token acquired from the /token
endpoint.
For example, if the acquired access token is AbCdEf123456
, the value of the Authorization
headers would be:
Authorization: Bearer v69uloc3wcEFLePw2unot0FfAJfBocrvSwsrCo75JLUG7aE54zqSUnU
2) The second header that is required for proper usage of the API, is the Accept
header.
This header is used for the resource versioning feature and is therefore crucial for making sure the response remains the same when new resource versions are introduced.
The value of the Accept
header differs per endpoint is defined in the OpenAPI documentation of the endpoints.
Accept: application/json;version=2018-01-01
In addition to the responses defined in the OpenAPI documentation, the Loket.nl API also provides additional fields that give more information about the response and the entities requested. This section will explain the full response given by the Loket.nl API by examining the example response below.
Example 400 response
{
"version": {
"obsoleteDate": null,
"versionNumber": "2018-01-01,
},
"messages": [
{
"code": 83,
"id": null,
"type": "BrokenBusinessRule",
"description": "[field] has an invalid length",
"properties": []
}
],
"_embedded": []
}
Example 200 response
{
"totalSize": 1,
"pageSize": 250,
"totalPages": 1,
"currentPage": 1,
"version": {
"obsoleteDate": null,
"resourceVersion": "2018-01-01"
},
"messages": [],
"content": {
"id": "2b4c119c-527c-4cbb-a5b2-f3a11e4b76cx",
...
}
}
totalSize
has an integer value indicating the total number of entities irrespective of the page size.pageSize
has an integer value indicating the maximum number of entities returned per page. The page size can be influenced by setting thepageSize
query parameter. See the section Query Parameters for more information.totalPages
has an integer value indicating the number of pages the requested collection holds given the specific pagesize.currentPage
has an integer value indicating the current page number. The current page number can be influenced by setting thepageNumber
query parameter. See the section Query Parameters for more information.
The version
object provides information regarding the resource version of the entity requested.
obsoleteDate
contains the date of discontinuation for the requested resource version. The value of this field can benull
indicating that the requested resource version is not planned to be obsoleted at the time of the request.resourceVersion
shows the version of the requested entity. The resource version can be influenced by setting theAccept
header.
The messages
field contains a list of message objects related to the request made. Any warnings and errors will be communicated in this list of messages
type
has a string value indicating the type of message. At this time the Loket.nl API supports five types of messages:BrokenBusinessRule
,Warning
,Exception
andNotFound
.description
has a string value that describes the message that has occurred.code
is an identifying code for the message. Please note that this code may change in the future. See the documentation portal for possible message codes for an endpoint.id
relates the message to a specific entity in the reponse list. For example, in cases where a warning occurs for one of the entities in a list, the value of this field can be used to identify to which entity the warning applies. Currently implemented for endpoints where a multi-patch is performed (multiple actions are performed within one call) for example updating the status of one or more leaveRequests.properties
an array that can contain additional information regarding the message. Currently not yet fully implemented._embedded
contains the list of entities as defined for each endpoint in the OpenAPI documentation. Please refer to that documentation for the contents of the_embedded
field for each endpoint. For endpoints that return only one entity (detail endpoints) the_embedded
field is replaced with acontent
field. The content of this field can also be found in the documentation for each endpoint.
Expires
header is returned with every response to indicate how long a response can be cachedContent-Disposition
header is used in case of downloads to provide a file name
The Loket.nl API supports the following http status codes.
Code | Is returned when |
---|---|
200 | The request to GET, PUT, PATCH or DELETE and object was recived and processed successfully. The response might still contain messages of the type warning. |
201 | The request to insert (POST) a new object was recived and processed successfully. The response might still contain messages of the type warning. |
400 | The request was received but could not be processed. The reason(s) will be given in the response. The content type of the response may be text/plain for API-level error messages, such as when trying to call the API without SSL otherwise the content will be application/json. |
401 | The bearer token provided in the authorization header is invalid. Do not retry the request until a new (valid) bearer token is acquired. |
403 | The user is not authorized to access the resource. The reason will be given in the response. Do not retry the request until the, configuration, issue is resolved. |
404 | The resource requested was not found/does not exist. |
50* | A unforseen error occurred. Please check the request if everything seems te be in order on your side contact the support team. Provide as much information as possible to resolve the issue. |
Note: for a limited number of endpoint a so-called multi-patch may be performed (multiple actions within one call). In that case the status code will be 200 if at least on of the actions succeeds, if other any action(s) in that call fail(s) a message will be returned including the given id of that entity.
The API uses the Expires
header to indicate how long the item can be reused from the local cache.
In most cases caching is not allowed for resources.
Exceptions excist, such as pictures like the employer logo and the employee photo, in these cases the cache duration is mentioned in the description of the resource.
List of providers
Activity name : GetProvidersByUser Get a list of all providers accessible to the current user. Note: With the current functioning of Loket, the list will always contain 1 provider. Note: This endpoint is typically not relevant for most external parties, as the GetEmployerByUser endpoint will be much more relevant as starting point.
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Van Spaendonck Online B.V."
}
]
}
Download the provider logo
Activity name : GetProviderLogo This activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour. Caching: This resource changes very infrequently and can be cached for a longer time. Get the logo of the provider of the user. In case no logo is know the service will return a 404.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Download the provider logo
Activity name : GetProviderLogo This activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour. Caching: This resource changes very infrequently and can be cached for a longer time. Get the logo of the provider of the user. In case no logo is know the service will return a 404.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
version required | string <uuid> 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. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Retrieve provider contact information
Activity name : GetProviderContactInformationByProviderId Haal de contactinformatie op van de opgegeven providerId. Bevat onder andere adres- en contactgegevens.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "string",
- "contact": {
- "name": "string",
- "email": "string",
- "phonenumber": "string",
- "faxnumber": "string"
}, - "address": {
- "street": "string",
- "city": "string",
- "houseNumber": "string",
- "houseNumberAddition": "string",
- "furtherAddition": {
- "key": "string",
- "value": "string"
}, - "postalCode": "string",
- "location": "string",
- "country": {
- "key": "string",
- "value": "string"
}
}
}
Logos at providerlevel
Activity name : GetProviderLogosByProviderId
Get 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.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "attribute": "Logo 1",
- "name": "ProviderLogo",
}
]
}
Upload a logo for the provider
Activity name : PostProviderLogoByProviderId
Upload 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.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Logo to be uploaded for the provider.
attribute | string <= 10 characters the attribute of the logo. |
name | string <= 50 characters The name of the logo. |
data | string base64 encoded document file. |
mimeType | string The mimetype of the data. |
Responses
Request samples
- Payload
{- "attribute": "Logo 1",
- "name": "ProviderLogo",
- "data": "YQ==",
- "mimeType": "image/jpeg"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "attribute": "Logo 1",
- "name": "ProviderLogo",
- "data": "YQ==",
- "mimeType": "image/jpeg"
}
}
Logo at providerlevel
Activity name : GetProviderLogoByLogoId
Get 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.
path Parameters
logoId required | string <uuid> The unique identifier of a logo |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "attribute": "Logo 1",
- "name": "ProviderLogo",
- "data": "YQ==",
- "mimeType": "image/jpeg"
}
}
Edit a provider logo
Activity name : PutProviderLogoByLogoId
Edit 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.
path Parameters
logoId required | string <uuid> The unique identifier of a logo |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
attribute | string <= 10 characters the attribute of the logo. |
name | string <= 50 characters The name of the logo. |
data | string base64 encoded document file. |
mimeType | string The mimetype of the data. |
Responses
Request samples
- Payload
{- "attribute": "Logo 1",
- "name": "ProviderLogo",
- "data": "YQ==",
- "mimeType": "image/jpeg"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "attribute": "Logo 1",
- "name": "ProviderLogo",
- "data": "YQ==",
- "mimeType": "image/jpeg"
}
}
Delete a logo at providerlevel
Activity name : DeleteProviderLogoByLogoId
path Parameters
logoId required | string <uuid> The unique identifier of a logo |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Logo without properties at providerlevel
Activity name : GetProviderLogoOnlyByLogoId
Get 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.
path Parameters
logoId required | string <uuid> The unique identifier of a logo |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 401
- 403
{- "message": "Authorization has been denied for this request."
}
List of employers
Activity name : GetEmployersByUserId
Get a list of all employers accessible to the current user
Please note the following general remark regarding the Loket API. If an id is required as a path parameter, in almost all cases the UUID of the specific resource should be used. In the employer resource this corresponds to the the 'id' field, as is typical. (so do NOT use employerNumber as your path parameter for any following requests)
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerNumber": 20720,
- "companyName": "Voorbeeld B.V.",
- "chamberOfCommerceNumber": "18124676",
- "sbi": {
- "key": 12,
- "value": "Agriculture, Forestry and Fishing",
- "sbiCode": "0116"
}, - "legalForm": {
- "key": 1,
- "value": "B.V."
}, - "branch": {
- "key": 2,
- "value": "Landbouw en jacht"
}, - "providerSettings": {
- "administrationNumber": "SR2",
- "groupCode": 40,
- "parentEmployerForConsolidatedOverviews": 9933,
- "sendEmailWhenSalarySlipIsAvailable": true
}, - "contact": {
- "name": "Henk de Vries",
- "phoneNumber": "013-12345678",
- "function": "Manager"
}, - "contactInformation": {
- "faxNumber": "(088) 31 11149",
- "phoneNumber": "(088) 31 11150",
- "website": "www.voorbeeldbv.nl"
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}, - "province": {
- "key": 1,
- "value": "Noord-Holland"
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}, - "poBox": 5000
}
}
]
}
List of employers with fewer fields for performance reasons
Activity name : GetEmployersMinimizedByUser
Get a list of all employers accessible to the current user. With this endpoint we introduced the "Minimized" resource which contains fewer fields then /providers/employers
. This version should increase performance when requesting employments for large employers.
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "companyName": "Voorbeeld B.V.",
- "address": {
- "street": "Voordijk",
- "houseNumber": 12,
- "postalCode": "1234AA",
- "city": "Leiden"
}, - "providerSettings": {
- "administrationNumber": "SR2",
- "groupCode": 40
}, - "contactInformation": {
- "phoneNumber": "(088) 31 11150"
}, - "contact": {
- "name": "Henk de Vries",
- "phoneNumber": "013-12345678"
}, - "branch": {
- "key": 2,
- "value": "Landbouw en jacht"
}
}
]
}
Create an employer
Activity name : PostEmployerByProviderId
Create an employee for the provider (administratiekantoor) identified by the given providerId. Please take note of the following; a newly created Employer is not immediately accessible for the user. As this would require adding the Employer to a specific Loket team (which is a separate activity). Even after adding the Employer to a team, it may take a few minutes before the Employer is accessible for the user because of caching.
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.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Employer to be created.
companyName | string (companyName) <= 70 characters Name of the company |
chamberOfCommerceNumber | string or null (chamberOfCommerceNumber) <= 35 characters Chamber of commerce number. In Dutch "Kamer van koophandel" number |
object or null <metadata> (sbi) The 'Standard Industrial Classifications (Dutch SBI 2008, NACE and ISIC)' as defined bij the Dutch chamber of commerce | |
object or null <metadata> (legalForm) | |
object or null <metadata> (branch) | |
object (providerSettings) | |
object or null (schemas-contact) | |
object or null (components-schemas-contactInformation) | |
object (address) | |
object or null (deviatingPostalAddress) |
Responses
Request samples
- Payload
{- "companyName": "Voorbeeld B.V.",
- "chamberOfCommerceNumber": "18124676",
- "sbi": {
- "key": 12
}, - "legalForm": {
- "key": 1
}, - "branch": {
- "key": 2
}, - "providerSettings": {
- "administrationNumber": "SR2",
- "groupCode": 40,
- "parentEmployerForConsolidatedOverviews": 9933,
- "sendEmailWhenSalarySlipIsAvailable": true
}, - "contact": {
- "name": "Henk de Vries",
- "phoneNumber": "013-12345678",
- "function": "Manager"
}, - "contactInformation": {
- "faxNumber": "(088) 31 11149",
- "phoneNumber": "(088) 31 11150",
- "website": "www.voorbeeldbv.nl"
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1
}, - "postalCode": "1234AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1
}, - "province": {
- "key": 1
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1
}, - "poBox": 5000
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerNumber": 20720,
- "companyName": "Voorbeeld B.V.",
- "chamberOfCommerceNumber": "18124676",
- "sbi": {
- "key": 12,
- "value": "Agriculture, Forestry and Fishing",
- "sbiCode": "0116"
}, - "legalForm": {
- "key": 1,
- "value": "B.V."
}, - "branch": {
- "key": 2,
- "value": "Landbouw en jacht"
}, - "providerSettings": {
- "administrationNumber": "SR2",
- "groupCode": 40,
- "parentEmployerForConsolidatedOverviews": 9933,
- "sendEmailWhenSalarySlipIsAvailable": true
}, - "contact": {
- "name": "Henk de Vries",
- "phoneNumber": "013-12345678",
- "function": "Manager"
}, - "contactInformation": {
- "faxNumber": "(088) 31 11149",
- "phoneNumber": "(088) 31 11150",
- "website": "www.voorbeeldbv.nl"
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}, - "province": {
- "key": 1,
- "value": "Noord-Holland"
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}, - "poBox": 5000
}
}
}
Details of an employer
Activity name : GetEmployerByEmployerId
Get the details of a single employers
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerNumber": 20720,
- "companyName": "Voorbeeld B.V.",
- "chamberOfCommerceNumber": "18124676",
- "sbi": {
- "key": 12,
- "value": "Agriculture, Forestry and Fishing",
- "sbiCode": "0116"
}, - "legalForm": {
- "key": 1,
- "value": "B.V."
}, - "branch": {
- "key": 2,
- "value": "Landbouw en jacht"
}, - "providerSettings": {
- "administrationNumber": "SR2",
- "groupCode": 40,
- "parentEmployerForConsolidatedOverviews": 9933,
- "sendEmailWhenSalarySlipIsAvailable": true
}, - "contact": {
- "name": "Henk de Vries",
- "phoneNumber": "013-12345678",
- "function": "Manager"
}, - "contactInformation": {
- "faxNumber": "(088) 31 11149",
- "phoneNumber": "(088) 31 11150",
- "website": "www.voorbeeldbv.nl"
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}, - "province": {
- "key": 1,
- "value": "Noord-Holland"
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}, - "poBox": 5000
}
}
}
Edit the details of an employer
Activity name: PutEmployerByEmployerId
Edit the details of an employer
Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Employer
companyName | string (companyName) <= 70 characters Name of the company |
chamberOfCommerceNumber | string or null (chamberOfCommerceNumber) <= 35 characters Chamber of commerce number. In Dutch "Kamer van koophandel" number |
object or null <metadata> (sbi) The 'Standard Industrial Classifications (Dutch SBI 2008, NACE and ISIC)' as defined bij the Dutch chamber of commerce | |
object or null <metadata> (legalForm) | |
object or null <metadata> (branch) | |
object (providerSettings) | |
object or null (schemas-contact) | |
object or null (components-schemas-contactInformation) | |
object (address) | |
object or null (deviatingPostalAddress) |
Responses
Request samples
- Payload
{- "companyName": "Voorbeeld B.V.",
- "chamberOfCommerceNumber": "18124676",
- "sbi": {
- "key": 12
}, - "legalForm": {
- "key": 1
}, - "branch": {
- "key": 2
}, - "providerSettings": {
- "administrationNumber": "SR2",
- "groupCode": 40,
- "parentEmployerForConsolidatedOverviews": 9933,
- "sendEmailWhenSalarySlipIsAvailable": true
}, - "contact": {
- "name": "Henk de Vries",
- "phoneNumber": "013-12345678",
- "function": "Manager"
}, - "contactInformation": {
- "faxNumber": "(088) 31 11149",
- "phoneNumber": "(088) 31 11150",
- "website": "www.voorbeeldbv.nl"
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1
}, - "postalCode": "1234AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1
}, - "province": {
- "key": 1
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1
}, - "poBox": 5000
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerNumber": 20720,
- "companyName": "Voorbeeld B.V.",
- "chamberOfCommerceNumber": "18124676",
- "sbi": {
- "key": 12,
- "value": "Agriculture, Forestry and Fishing",
- "sbiCode": "0116"
}, - "legalForm": {
- "key": 1,
- "value": "B.V."
}, - "branch": {
- "key": 2,
- "value": "Landbouw en jacht"
}, - "providerSettings": {
- "administrationNumber": "SR2",
- "groupCode": 40,
- "parentEmployerForConsolidatedOverviews": 9933,
- "sendEmailWhenSalarySlipIsAvailable": true
}, - "contact": {
- "name": "Henk de Vries",
- "phoneNumber": "013-12345678",
- "function": "Manager"
}, - "contactInformation": {
- "faxNumber": "(088) 31 11149",
- "phoneNumber": "(088) 31 11150",
- "website": "www.voorbeeldbv.nl"
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}, - "province": {
- "key": 1,
- "value": "Noord-Holland"
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}, - "poBox": 5000
}
}
}
List of child employers accessible to the current user
Activity name : GetChildEmployersByEmployerId
Get a list of all employers accessible to the current user which are a child of the provided employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
includeParent | boolean Example: includeParent=true Determines whether the information of the parent employer should be included in the response. If not provided, this parameter defaults to |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerNumber": 20720,
- "companyName": "Voorbeeld B.V.",
- "providerSettings": {
- "parentEmployerForConsolidatedOverviews": 9933
}
}
]
}
Logo of an employer
Activity name : GetEmployerLogoByEmployerId
This activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.
Caching: This resource changes very infrequently and can be cached for a longer period.
Get the logo of the employer. In case no logo is know the service will return a 404.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 401
- 403
{- "message": "Authorization has been denied for this request."
}
Delete the employer logo
Activity name: DeleteEmployerLogoByEmployerId
Delete the logo of an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Upload a logo for the employer
Activity name : PostEmployerLogoByEmployerId
Upload a logo for the employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Logo to be uploaded for the employer.
data | string base64 encoded document file. |
mimeType | string The mimetype of the data. |
Responses
Request samples
- Payload
{- "data": "YQ==",
- "mimeType": "image/jpeg"
}
Response samples
- 201
- 400
- 401
- 403
{- "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
]
}
Logo of an employer
Activity name : GetEmployerLogoByEmployerId
This activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.
Caching: This resource changes very infrequently and can be cached for a longer period.
Get the logo of the employer. In case no logo is know the service will return a 404.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
version required | string <uuid> 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. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 401
- 403
{- "message": "Authorization has been denied for this request."
}
Provider logo
Activity name : GetProviderLogoByEmployerId
This activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.
Get the (deviating) provider logo of the employers. In case no logo is know the service will return a 404.
Caching: This resource changes very infrequently and can be cached for a longer time.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 401
- 403
{- "message": "Authorization has been denied for this request."
}
Provider logo
Activity name : GetProviderLogoByEmployerId
This activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.
Get the (deviating) provider logo of the employers. In case no logo is know the service will return a 404.
Caching: This resource changes very infrequently and can be cached for a longer time.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
version required | string <uuid> 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. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 401
- 403
{- "message": "Authorization has been denied for this request."
}
NL: Administratie. Retrieve information about all administrations, both payroll administrations and non-payroll administrations.
List of administrations for an employer
Activity name : GetAdministrationsByEmployerId
Get a list of all administrations (both payroll and non-payroll) for an employer. This endpoint only returns properties that are shared between payroll and non-payroll administrations. For more detailed properties, use the respective endpoints for payroll and non-payroll administrations.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "clientNumber": 1234,
- "wageTaxNumber": "111111110L00",
- "description": "Bakker",
- "startDate": "2016-01-01",
- "endDate": "2020-12-31",
- "isPayrollAdministration": true,
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
]
}
List of administrations
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.
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "clientNumber": 1234,
- "wageTaxNumber": "111111110L00",
- "description": "Bakker",
- "startDate": "2016-01-01",
- "endDate": "2020-12-31",
- "isPayrollAdministration": true,
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
]
}
List of employments for an employer
Activity name : GetEmploymentsByEmployerId
Get a list of employments for an employer
This endpoint only returns the employments that meet the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employee": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen",
- "prefixPartner": "van de",
- "lastNamePartner": "Wiel",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "dateOfBirth": "1995-05-21",
}, - "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "historicalStartDate": "2012-05-01",
- "commissionUntilDate": "2019-01-01",
- "endDate": "2018-10-23",
- "endOfEmploymentReason": {
- "key": 1,
- "value": "VUT"
}, - "endOfEmploymentReasonTaxAuthorities": {
- "key": 1,
- "value": "Beëindiging arbeidsovereenkomst met wederzijds goedvinden op initiatief van de werkgever."
}, - "endOfEmploymentDueToIllness": false,
- "firstDayNotification": false,
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker"
}, - "nonPayrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "HR only employees",
- "description": "Bakker"
}, - "administration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker",
- "administrationType": "payrollAdministration"
}, - "typeOfEmployee": {
- "key": 1,
- "value": "Werknemer"
}, - "employmentCategoryType": {
- "key": 1,
- "value": "Ouderschapsverlof"
}, - "linkedEmployment": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employmentDurationType": {
- "key": 1,
- "value": "Contract of indefinite duration"
}, - "startDateContractOfIndefiniteDuration": "2018-05-08",
- "employmentContractType": {
- "key": 1,
- "value": "Arbeidsovereenkomst (excl BBL)"
}, - "vacationCoupons": {
- "key": 1,
- "value": "n.v.t."
}, - "sendToExternalParty": {
- "key": 1,
- "value": "n.v.t."
}, - "deviatingCLAExternalParty": 2,
- "deviatingCLATaxReturn": 2,
- "incomeRelationshipNumber": 12,
- "employeeProfileId": {
- "key": 1,
- "value": "Profiel full-timers"
}, - "professionCode": 4,
- "exemptionWorkRelatedExpenseScheme": false,
- "exemptionPremiumWaiverMarginalLabour": false,
- "typeOfParticipation": {
- "key": 0,
- "value": "n.vt."
}, - "valueOfParticipation": {
- "key": 0,
- "value": "n.v.t."
}, - "wachtgeldOldRegulation": false,
- "participation55plusRegulationUWV": false,
- "essMutationSet": {
- "key": 1,
- "value": "Standaard"
}, - "exemptionInsuranceObligation": {
- "key": 0,
- "value": "Geen uitzondering."
}, - "specialIncomeRatio": {
- "key": 0,
- "value": "n.v.t."
}, - "temporaryTaxExemption": {
- "key": 2,
- "value": "Nee."
}, - "periodPayGradeAdjustment": 2,
- "signalPayGradeAdjustment": false,
- "commissionUntilDate1": "2018-05-31",
- "commissionUntilDate2": "2018-05-31",
- "commissionUntilDate3": "2018-05-31",
- "commissionUntilDate4": "2018-05-31",
- "commissionUntilDate5": "2018-05-31",
- "commissionUntilDate6": "2018-05-31",
- "isDirectorAndMajorShareholder": false,
- "isPreviousOwner": false,
- "isFamilyOfOwner": false,
- "isOnCallEmployment": true,
- "hasOnCallAppearanceObligation": true,
- "isGemoedsbezwaardNationalInsurance": true,
- "isGemoedsbezwaardEmployeeInsurance": true,
- "isAnonymousEmployee": true,
- "cancellationPeriodEmployee": 1,
- "cancellationPeriodEmployer": 1,
- "cancellationPeriodTimeUnit": {
- "key": 4,
- "value": "Maand(en)"
}, - "cancellationNoticeDate": "2018-05-31",
- "startCancellationNoticePeriod": "2018-06-01",
- "payrollId": 2,
- "namePayslip": "Steve Jobs",
- "calculateWorkingHours": true,
- "writtenEmploymentContract": true
}
]
}
List of employments with fewer fields for performance reasons
Activity name : GetEmploymentsMinimizedByEmployerId
Get a list of employments for an employer. With this version we introduced the "Minimized" resource which contains fewer fields. This version should increase performance when requesting employments for large employer.
This endpoint only returns the employments that meet the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employee": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "firstName": "Susan",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "dateOfBirth": "1995-05-21",
}, - "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "commissionUntilDate": "2019-01-01",
- "endDate": "2018-10-23",
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker"
}, - "nonPayrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "HR only employees",
- "description": "Bakker"
}, - "employmentDurationType": {
- "key": 1,
- "value": "Contract of indefinite duration"
}, - "incomeRelationshipNumber": 12,
- "payrollId": 2
}
]
}
List of employments with additional entities
Activity name : GetEmploymentsComprehensiveByEmployerId
Availability: This is endpoint is available for the Loket.nl application only. It is not available for external parties
Get a list of employments for an employer. With this version we introduced the "Comprehensive" resource which contains additional entities.
This endpoint only returns the employments that meet the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
removeEmptyLines | boolean Example: removeEmptyLines=true When true and combined with a X-ReportInput header, the output only contains employments for which selected underlying data, such as wage, is available. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employee": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "personalDetails": {
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "lastNamePartner": "Wiel",
- "prefixPartner": "van de",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "dateOfDeath": "2019-08-24",
- "aowDate": "2062-08-21",
- "howToFormatLastName": {
- "key": 2,
- "value": "last name + last name partner"
}, - "title": {
- "key": 2,
- "value": "e.g. Msc, PHD or Baron"
}, - "nationality": {
- "key": 2,
- "value": "Dutch"
}, - "gender": {
- "key": 2,
- "value": "female"
}, - "civilStatus": {
- "key": 2,
- "value": "Maried"
}
}, - "contactInformation": {
- "phoneNumber": "+31 13-1234567",
- "mobilePhoneNumber": "+31 6-1231456",
- "faxNumber": "+31 13-1234561",
- "businessPhoneNumber": "+31 13-1234567",
- "businessMobilePhoneNumber": "+31 6-1231456",
- "businessEmailAddress": "[email protected]"
}, - "identityDocument": {
- "typeOfDocument": {
- "key": 2,
- "value": "Passport"
}, - "documentIdentification": "CRE45553433"
}, - "travel": {
- "travelDistanceToWork": 32,
- "travelDistanceToWorkInKm": 41.05
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "exclusionFromAbsenceStatus": false,
- "statusEmployeeSelfService": {
- "key": 2,
- "value": "Blocked"
}, - "revokeEmployeeSelfServiceAccessOn": "2018-10-23"
}, - "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "historicalStartDate": "2012-05-01",
- "commissionUntilDate": "2019-01-01",
- "endDate": "2018-10-23",
- "endOfEmploymentReason": {
- "key": 1,
- "value": "VUT"
}, - "endOfEmploymentReasonTaxAuthorities": {
- "key": 1,
- "value": "Beëindiging arbeidsovereenkomst met wederzijds goedvinden op initiatief van de werkgever."
}, - "endOfEmploymentDueToIllness": false,
- "firstDayNotification": false,
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker"
}, - "nonPayrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "HR only employees",
- "description": "Bakker"
}, - "administration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker",
- "administrationType": "payrollAdministration"
}, - "typeOfEmployee": {
- "key": 1,
- "value": "Werknemer"
}, - "employmentCategoryType": {
- "key": 1,
- "value": "Ouderschapsverlof"
}, - "linkedEmployment": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employmentDurationType": {
- "key": 1,
- "value": "Contract of indefinite duration"
}, - "startDateContractOfIndefiniteDuration": "2018-05-08",
- "employmentContractType": {
- "key": 1,
- "value": "Arbeidsovereenkomst (excl BBL)"
}, - "vacationCoupons": {
- "key": 1,
- "value": "n.v.t."
}, - "sendToExternalParty": {
- "key": 1,
- "value": "n.v.t."
}, - "deviatingCLAExternalParty": 2,
- "deviatingCLATaxReturn": 2,
- "incomeRelationshipNumber": 12,
- "employeeProfileId": {
- "key": 1,
- "value": "Profiel full-timers"
}, - "professionCode": 4,
- "exemptionWorkRelatedExpenseScheme": false,
- "exemptionPremiumWaiverMarginalLabour": false,
- "typeOfParticipation": {
- "key": 0,
- "value": "n.vt."
}, - "valueOfParticipation": {
- "key": 0,
- "value": "n.v.t."
}, - "wachtgeldOldRegulation": false,
- "participation55plusRegulationUWV": false,
- "essMutationSet": {
- "key": 1,
- "value": "Standaard"
}, - "exemptionInsuranceObligation": {
- "key": 0,
- "value": "Geen uitzondering."
}, - "specialIncomeRatio": {
- "key": 0,
- "value": "n.v.t."
}, - "temporaryTaxExemption": {
- "key": 2,
- "value": "Nee."
}, - "periodPayGradeAdjustment": 2,
- "signalPayGradeAdjustment": false,
- "commissionUntilDate1": "2018-05-31",
- "commissionUntilDate2": "2018-05-31",
- "commissionUntilDate3": "2018-05-31",
- "commissionUntilDate4": "2018-05-31",
- "commissionUntilDate5": "2018-05-31",
- "commissionUntilDate6": "2018-05-31",
- "isDirectorAndMajorShareholder": false,
- "isPreviousOwner": false,
- "isFamilyOfOwner": false,
- "isOnCallEmployment": true,
- "hasOnCallAppearanceObligation": true,
- "isGemoedsbezwaardNationalInsurance": true,
- "isGemoedsbezwaardEmployeeInsurance": true,
- "isAnonymousEmployee": true,
- "cancellationPeriodEmployee": 1,
- "cancellationPeriodEmployer": 1,
- "cancellationPeriodTimeUnit": {
- "key": 4,
- "value": "Maand(en)"
}, - "cancellationNoticeDate": "2018-05-31",
- "startCancellationNoticePeriod": "2018-06-01",
- "payrollId": 2,
- "namePayslip": "Steve Jobs",
- "calculateWorkingHours": true,
- "writtenEmploymentContract": true,
- "workinghours": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "shift": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "deviatingHoursPerWeek": 32,
- "averageHoursPerWeek": 32,
- "deviatingSvDaysPerPeriod": 20,
- "averageParttimeFactor": 37.5,
- "regularWorkPattern": true,
- "shiftRateSickLeave": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "flexibleHoursContract": {
- "key": 2,
- "value": "Minimum uren contract"
}, - "workPattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}, - "calculateUsingWorkPattern": {
- "leaveHours": true,
- "hoursBrokenPeriod": false,
- "hoursRegularPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "contractCode": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 1022,
- "description": "SLA-PT-met toeslagen ATW (88)"
}, - "aggregatedHoursPerWeek": 24
}, - "organizationalEntity": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Directeur",
- "group": "internal"
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "standardFunction": {
- "key": 1,
- "value": "Administrateur",
- "code": "A21",
- "category": 1
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}, - "placeOfEmployment": "Amsterdam office",
- "internalTelephoneExtensionNumber": "678"
}, - "wage": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "1995-05-21",
- "endDate": "2019-08-24",
- "payrollPeriodType": {
- "key": 1,
- "value": "Maand"
}, - "grossWage": 2300,
- "grossWageType": {
- "key": 2,
- "value": "hourly"
}, - "isGrossWageFullTime": true,
- "netWage": 2400,
- "netWageType": {
- "key": 1,
- "value": "hourly"
}, - "employerCosts": 3500,
- "employerCostsType": {
- "key": 1,
- "value": "hourly"
}, - "payScale": {
- "key": 1,
- "value": "Glastuinbouw maand, Loongebouw A"
}, - "payGrade": {
- "key": 1,
- "value": "Schaal B1, 15 jaar"
}, - "applyPayGrade": true
}, - "socialSecurityBenefits": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "supplementation": {
- "type": {
- "key": 3,
- "value": "Suppleren (bruto)"
}, - "percentage": 35
}, - "benefit": {
- "type": {
- "key": 1,
- "value": "ZW eigen risico"
}, - "percentage": 35
}
}
], - "socialSecurityConfiguration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "isInsuredForSicknessBenefitsAct": true,
- "isInsuredForUnemploymentInsuranceAct": true,
- "isInsuredForOccupationalDisabilityInsuranceAct": true
}, - "deviatingAwfContribution": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "typeOfDeviatingAwfContribution": {
- "key": 2,
- "value": "Hoog"
}
}, - "citizenServiceNumber": {
- "citizenServiceNumber": "042168588"
}, - "statusEmployeeSelfService": {
- "hasTwoFactorAuthentication": false,
- "status": "HasAccessToClient"
}, - "employmentCustomFields": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "customField": {
- "id": "025ce09b-bff2-4b05-bcf0-711a89da7c08",
- "description": "Shoe size"
}, - "value": "41"
}
], - "employeeCustomFields": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "customField": {
- "id": "025ce09b-bff2-4b05-bcf0-711a89da7c08",
- "description": "Shoe size"
}, - "value": "41"
}
], - "paymentInformationSepa": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollComponent": {
- "key": 260,
- "value": "NETTOLOON"
}, - "iban": "NL52ABNA0424968264",
- "bic": "AUDFDE21",
- "visibleOnPayslip": true,
- "nameBeneficiary": "Ben Hur",
- "cityBeneficiary": "Rome",
- "description1": "xx",
- "description2": "x"
}
], - "fiscalProperties": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "annualSalary": 60000,
- "deviatingTaxTableCode": {
- "key": 1,
- "value": "999 Overige gevallen waarin geen tabel is toegepast"
}, - "deviatingPayrollTaxTableColour": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "applyDayTables": false,
- "deviatingPayrollTaxPercentage": 25,
- "applyDeviatingPayrollTaxPercentageOn": {
- "key": 2,
- "value": "Afwijkend voor tabel- en tariefloon"
}, - "applyPayrollTaxDeduction": true,
- "applyStudentDeduction": false,
- "residentOf": {
- "key": 2,
- "value": "Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden"
}, - "applySalarysplit": {
- "key": 2,
- "value": "LB obv wereldinkomen (%NL/WI)"
}, - "percentageForeignIncome": 50,
- "deviatingCalculationRulePayrollTax": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "thirtyPercentFacility": {
- "key": 1,
- "value": "Netto"
}, - "deviatingPercentageThirtyPercentFacility": 20.2345,
- "doesWageIncludeAow": false,
- "doesWageIncludeWajong": false,
- "hasEmployeeLoan": false,
- "usesTransportByWithholdingAgent": false,
- "deviatingSmallJobsArrangement": false,
- "contributionReductionEducation": {
- "key": 2,
- "value": "4. Opleiding hbo"
}, - "specialIndication": {
- "one": 1,
- "two": 1,
- "three": 1,
- "four": 1
}, - "applySingleElderlyTaxDeduction": false
}, - "healthcareInsuranceActConfiguration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "healthcareInsuranceActType": {
- "key": 2,
- "value": "(C/K) Wel verzekeringsplichtig, normaal tarief"
}, - "additionalContributionEmployer": 320,
- "nominalPremium": 320,
- "additionalPremium": 120
}, - "benefitsInKind": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "benefitInKindType": {
- "id": "36530F13-59EB-4C15-B5F2-4F92B070A208",
- "description": "Mobiele telefoon"
}, - "brand": "Apple",
- "type": "Iphone 11",
- "value": 1100,
- "supplier": "Mediamarkt",
- "particularities": "geen bijzonderheden"
}
], - "companyCars": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "brand": "Volvo",
- "model": "V60",
- "licensePlateNumber": "GP586D",
- "fuelCardNumber": "B100.323.903",
- "leaseOrBuy": {
- "key": 1,
- "value": "Koop"
}, - "supplier": "Leasemaatschappij Tilburg",
- "lease": {
- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "contractNumber": "2021.323.903"
}, - "catalogValue": 20000,
- "kilometersPrivateUse": 10000,
- "comments": "This car is very nice"
}
], - "fiscalCompanyCars": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "licensePlateNumber": "GP586D",
- "dateOfFirstAdmission": "2018-01-01",
- "valueForTaxPurposes": 20000,
- "additionalTaxLiabilityGroup": {
- "key": 1,
- "value": "Standaard tarief (25% tot 2017)"
}, - "reasonForNoAdditionalTaxLiability": {
- "key": 1,
- "value": "(2) Werknemer heeft beschikking belastingdienst"
}, - "deviatingAdditionalTaxLiability": 20000,
- "taxableBenefitForPrivateUse": 2000
}
], - "journalAllocation": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "journalProfileConfiguration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2017-01-01",
- "periodEndDate": "2017-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2017-01-01",
- "periodEndDate": "2017-01-31"
}, - "journalProfile": {
- "key": 2,
- "value": "General ledger supermarkets"
}
}, - "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "allocationBasedOnActualHours": {
- "costCenter": {
- "key": 2,
- "code": "SAL073",
- "description": "Sales Den Bosch"
}, - "costUnit": {
- "key": 2,
- "code": "01",
- "description": "Cars"
}
}, - "allocationBasedOnFixedWeights": [
- {
- "costCenter": {
- "key": 2,
- "code": "SAL073",
- "description": "Sales Den Bosch"
}, - "costUnit": {
- "key": 2,
- "code": "01",
- "description": "Cars"
}, - "weight": 1
}
]
}, - "basesForCalculation": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "deviations": {
- "percentage": 8,
- "reservationPercentage": 12.0007,
- "financialReservationPercentage": 10.000007
}, - "ageBasedMinimum": {
- "key": 2,
- "value": "Toepassen hoogste leeftijd"
}, - "ageBasedMaximum": {
- "key": 2,
- "value": "Toepassen hoogste leeftijd"
}, - "base": {
- "key": 545,
- "value": "VAKANTIE TOESLAG, periodieke opbouw"
}
}
], - "otherPayrollVariables": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "productivityPercentage": 100,
- "payrollProperties": {
- "deviatingPremiumGroup": {
- "key": 2,
- "value": "(1) Agrarisch bedrijf kort"
}, - "wageCostBenefit": {
- "key": 2,
- "value": "LKV herplaatsen arbeidsgehandicapte werknemer"
}, - "wajongWithWageDispensation": false,
- "phaseClassification": {
- "key": 2,
- "value": "(38) Fase A zonder uitzendbeding met uitsluiting van ldv"
}, - "incidentalIncomeDeduction": {
- "key": 2,
- "value": "Bevalling of zwangerschap"
}, - "terminateIncomenumberFlexibleEmployment": {
- "key": 2,
- "value": "(1) Einde werk/contract, geen werk aangeboden"
}, - "applyMinimumWageVocationalLearningPathway": true,
- "occupationalDisabilityPremiumDiscount": {
- "key": 2,
- "value": "(7) Werknemer van 62, 63 of 64 jaar voor wie code 6 niet van toepassing is"
}, - "occupationalDisabilityDeductionAfter2009": 1,
- "occupationalDisabilityDeductionTo2009": 1,
- "collectiveLaborAgreementCodeHiringEmployer": {
- "key": 151,
- "value": "TUINBOUWVEILINGEN",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23"
}, - "applyYearlyHoursNorm": false
}, - "pensionProperties": {
- "annualCalculationBaseAbp": 1.5,
- "leaveAbp": {
- "leaveType": {
- "key": 2,
- "value": "Politiek verlof"
}, - "valueOfParticipationDuringLeave": 1
}, - "deviatingDisabilityInsuranceActPercentageForCordares": {
- "key": 2,
- "value": "15- 25 %"
}, - "applyDispensationRiskFund": false,
- "compulsoryEducationDays": 2,
- "occupationalPensionFund": 2,
- "specificationOfIncomeRelationshipApg": {
- "key": 1,
- "value": "Geen bijzonderheden",
- "code": "WNE"
}
}, - "insuranceProperties": {
- "applicableForNoRiskPolicy": false
}
}, - "paymentinformationNonSepa": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollComponent": {
- "key": 260,
- "value": "NETTOLOON"
}, - "bankAccountNumber": "0403830171874018",
- "beneficiary": {
- "name": "Ben Hur",
- "city": "Rome",
- "address": "Via Roma 3",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "bank": {
- "bankIdentifierCode": "AUDFDE21",
- "name": "Ben Hur",
- "city": "Rome",
- "address": "Via Roma 3",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}
}
], - "basesForEmploymentFundCalculation": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "origin": {
- "key": 1,
- "value": "Normale wijziging"
}, - "base": 25000
}
], - "pensionBenefits": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "payout": 2569
}, - "deviatingHourlyWages": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "payrollComponent": {
- "key": 70,
- "description": "LOON/SALARIS"
}, - "value": 50.87
}
]
}
]
}
List of employments for an employee
Activity name : GetEmploymentsByEmployeeId
Get the list of employments for an employee
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employee": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen",
- "prefixPartner": "van de",
- "lastNamePartner": "Wiel",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "dateOfBirth": "1995-05-21",
}, - "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "historicalStartDate": "2012-05-01",
- "commissionUntilDate": "2019-01-01",
- "endDate": "2018-10-23",
- "endOfEmploymentReason": {
- "key": 1,
- "value": "VUT"
}, - "endOfEmploymentReasonTaxAuthorities": {
- "key": 1,
- "value": "Beëindiging arbeidsovereenkomst met wederzijds goedvinden op initiatief van de werkgever."
}, - "endOfEmploymentDueToIllness": false,
- "firstDayNotification": false,
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker"
}, - "nonPayrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "HR only employees",
- "description": "Bakker"
}, - "administration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker",
- "administrationType": "payrollAdministration"
}, - "typeOfEmployee": {
- "key": 1,
- "value": "Werknemer"
}, - "employmentCategoryType": {
- "key": 1,
- "value": "Ouderschapsverlof"
}, - "linkedEmployment": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employmentDurationType": {
- "key": 1,
- "value": "Contract of indefinite duration"
}, - "startDateContractOfIndefiniteDuration": "2018-05-08",
- "employmentContractType": {
- "key": 1,
- "value": "Arbeidsovereenkomst (excl BBL)"
}, - "vacationCoupons": {
- "key": 1,
- "value": "n.v.t."
}, - "sendToExternalParty": {
- "key": 1,
- "value": "n.v.t."
}, - "deviatingCLAExternalParty": 2,
- "deviatingCLATaxReturn": 2,
- "incomeRelationshipNumber": 12,
- "employeeProfileId": {
- "key": 1,
- "value": "Profiel full-timers"
}, - "professionCode": 4,
- "exemptionWorkRelatedExpenseScheme": false,
- "exemptionPremiumWaiverMarginalLabour": false,
- "typeOfParticipation": {
- "key": 0,
- "value": "n.vt."
}, - "valueOfParticipation": {
- "key": 0,
- "value": "n.v.t."
}, - "wachtgeldOldRegulation": false,
- "participation55plusRegulationUWV": false,
- "essMutationSet": {
- "key": 1,
- "value": "Standaard"
}, - "exemptionInsuranceObligation": {
- "key": 0,
- "value": "Geen uitzondering."
}, - "specialIncomeRatio": {
- "key": 0,
- "value": "n.v.t."
}, - "temporaryTaxExemption": {
- "key": 2,
- "value": "Nee."
}, - "periodPayGradeAdjustment": 2,
- "signalPayGradeAdjustment": false,
- "commissionUntilDate1": "2018-05-31",
- "commissionUntilDate2": "2018-05-31",
- "commissionUntilDate3": "2018-05-31",
- "commissionUntilDate4": "2018-05-31",
- "commissionUntilDate5": "2018-05-31",
- "commissionUntilDate6": "2018-05-31",
- "isDirectorAndMajorShareholder": false,
- "isPreviousOwner": false,
- "isFamilyOfOwner": false,
- "isOnCallEmployment": true,
- "hasOnCallAppearanceObligation": true,
- "isGemoedsbezwaardNationalInsurance": true,
- "isGemoedsbezwaardEmployeeInsurance": true,
- "isAnonymousEmployee": true,
- "cancellationPeriodEmployee": 1,
- "cancellationPeriodEmployer": 1,
- "cancellationPeriodTimeUnit": {
- "key": 4,
- "value": "Maand(en)"
}, - "cancellationNoticeDate": "2018-05-31",
- "startCancellationNoticePeriod": "2018-06-01",
- "payrollId": 2,
- "namePayslip": "Steve Jobs",
- "calculateWorkingHours": true,
- "writtenEmploymentContract": true
}
]
}
Details of an employment
Activity name : GetEmploymentByEmploymentId
Get the details for an employment
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "employee": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen",
- "prefixPartner": "van de",
- "lastNamePartner": "Wiel",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "dateOfBirth": "1995-05-21",
}, - "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "historicalStartDate": "2012-05-01",
- "commissionUntilDate": "2019-01-01",
- "endDate": "2018-10-23",
- "endOfEmploymentReason": {
- "key": 1,
- "value": "VUT"
}, - "endOfEmploymentReasonTaxAuthorities": {
- "key": 1,
- "value": "Beëindiging arbeidsovereenkomst met wederzijds goedvinden op initiatief van de werkgever."
}, - "endOfEmploymentDueToIllness": false,
- "firstDayNotification": false,
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker"
}, - "nonPayrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "HR only employees",
- "description": "Bakker"
}, - "administration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker",
- "administrationType": "payrollAdministration"
}, - "typeOfEmployee": {
- "key": 1,
- "value": "Werknemer"
}, - "employmentCategoryType": {
- "key": 1,
- "value": "Ouderschapsverlof"
}, - "linkedEmployment": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employmentDurationType": {
- "key": 1,
- "value": "Contract of indefinite duration"
}, - "startDateContractOfIndefiniteDuration": "2018-05-08",
- "employmentContractType": {
- "key": 1,
- "value": "Arbeidsovereenkomst (excl BBL)"
}, - "vacationCoupons": {
- "key": 1,
- "value": "n.v.t."
}, - "sendToExternalParty": {
- "key": 1,
- "value": "n.v.t."
}, - "deviatingCLAExternalParty": 2,
- "deviatingCLATaxReturn": 2,
- "incomeRelationshipNumber": 12,
- "employeeProfileId": {
- "key": 1,
- "value": "Profiel full-timers"
}, - "professionCode": 4,
- "exemptionWorkRelatedExpenseScheme": false,
- "exemptionPremiumWaiverMarginalLabour": false,
- "typeOfParticipation": {
- "key": 0,
- "value": "n.vt."
}, - "valueOfParticipation": {
- "key": 0,
- "value": "n.v.t."
}, - "wachtgeldOldRegulation": false,
- "participation55plusRegulationUWV": false,
- "essMutationSet": {
- "key": 1,
- "value": "Standaard"
}, - "exemptionInsuranceObligation": {
- "key": 0,
- "value": "Geen uitzondering."
}, - "specialIncomeRatio": {
- "key": 0,
- "value": "n.v.t."
}, - "temporaryTaxExemption": {
- "key": 2,
- "value": "Nee."
}, - "periodPayGradeAdjustment": 2,
- "signalPayGradeAdjustment": false,
- "commissionUntilDate1": "2018-05-31",
- "commissionUntilDate2": "2018-05-31",
- "commissionUntilDate3": "2018-05-31",
- "commissionUntilDate4": "2018-05-31",
- "commissionUntilDate5": "2018-05-31",
- "commissionUntilDate6": "2018-05-31",
- "isDirectorAndMajorShareholder": false,
- "isPreviousOwner": false,
- "isFamilyOfOwner": false,
- "isOnCallEmployment": true,
- "hasOnCallAppearanceObligation": true,
- "isGemoedsbezwaardNationalInsurance": true,
- "isGemoedsbezwaardEmployeeInsurance": true,
- "isAnonymousEmployee": true,
- "cancellationPeriodEmployee": 1,
- "cancellationPeriodEmployer": 1,
- "cancellationPeriodTimeUnit": {
- "key": 4,
- "value": "Maand(en)"
}, - "cancellationNoticeDate": "2018-05-31",
- "startCancellationNoticePeriod": "2018-06-01",
- "payrollId": 2,
- "namePayslip": "Steve Jobs",
- "calculateWorkingHours": true,
- "writtenEmploymentContract": true
}
}
Edit the details of an employment
Activity name : PutEmploymentByEmploymentId
Edit the details of an employment
Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the URL
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2019-12-16required
Employment to edit
historicalStartDate | string or null <date> (historicalStartDate) 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 |
commissionUntilDate | string or null <date> (commissionUntilDate) The date on which the employment will end. NL: AanstellingTot |
object <metadata> (typeOfEmployee) A selection of pre defined employee-types for the employment. NL: SoortWerknemer | |
object <metadata> (employmentDurationTypeVerion2019-12-16) A selection of pre defined durations for the employment. NL: SoortDienstverband | |
startDateContractOfIndefiniteDuration | string or null <date> (startDateContractOfIndefiniteDuration) When did the value of |
object or null <metadata> (employmentContractType) The type of employment applicable for the employment. NL: BasisDienstverband | |
object or null <metadata> (vacationCoupons) Indication for vacation coupons (vakantiebonnen). This is only applies to a limited set of CLA`s. NL: Vakantiebonnen | |
object or null <metadata> (sendToExternalParty) 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 | |
deviatingCLAExternalParty | integer or null <int32> (deviatingCLAExternalParty) CLA (CAO) code in case of a deviating CLA for external parties . NL: CaoKlantgroepAfwijkend |
deviatingCLATaxReturn | integer or null <int32> (deviatingCLATaxReturn) [ 1 .. 9999 ] CLA (CAO) code in case of a deviating CLA for tax returns. NL: CAOUWV |
incomeRelationshipNumber | integer <int32> (incomeRelationshipNumber) [ 0 .. 9999 ] 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 |
object or null <metadata> (employeeProfileId) References to an employeeprofile that is specified in the payroll administration level. NL: WerknemerProfielID
| |
professionCode | integer or null <int32> (professionCode) [ 1 .. 999 ] 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 |
exemptionWorkRelatedExpenseScheme | boolean (exemptionWorkRelatedExpenseScheme) Indicates whether an exemption (i.e. non-participation) on the work-related expense scheme (werkkostenregeling) applies for this employment. NL: WerkkostenRegelingUitsluiting |
exemptionPremiumWaiverMarginalLabour | boolean (exemptionPremiumWaiverMarginalLabour) Indicates whether an exemption (i.e. waiver) on the premium marginal labour (vrijstelling marginale arbeid) applies for this employment. NL: PremieVrijstellingMarginaleArbeid |
object or null <metadata> (typeOfParticipation) 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 | |
object or null <metadata> (valueOfParticipation) 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 | |
wachtgeldOldRegulation | boolean (wachtgeldOldRegulation) Indicates whether the (old) wachtgeld regulation is applicable for the employment. NL: WachtgeldOudeRegeling |
participation55plusRegulationUWV | boolean (participation55plusRegulationUWV) Indicates whether the 55 plus regulation (55 plus regeling) is applicable for the employment. NL: Deelname55Plus |
object <metadata> (essMutationSet) 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
| |
object <metadata> (exemptionInsuranceObligation) 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 | |
object or null <metadata> (specialIncomeRatio) Indicates the special income ratio. NL: SpecialeInkomstenVerhouding | |
emailLeaveRequest | string or null (schemas-emailLeaveRequest) <= 255 characters Recipient e-mail adress for notification in case of leave requests. NL: EmailVerlofaanvraag |
object <metadata> (temporaryTaxExemption) Indicates whether there a temporary tax exemption is to be applied for the employment. NL: TijdelijkeHeffingskorting | |
periodPayGradeAdjustment | integer or null <int32> (periodPayGradeAdjustment) [ 1 .. 52 ] 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 |
signalPayGradeAdjustment | boolean (signalPayGradeAdjustment) Indicates whether signaling regarding salary scale adjustments are enabled for the employment. NL: SalarisschaalSignaleren |
commissionUntilDate1 | string or null <date> (commissionUntilDate1) Until date for commision #1. NL: AanstellingTot1 |
commissionUntilDate2 | string or null <date> (commissionUntilDate2) Until date for commision #2. NL: AanstellingTot2 |
commissionUntilDate3 | string or null <date> (commissionUntilDate3) Until date for commision #3. NL: AanstellingTot3 |
commissionUntilDate4 | string or null <date> (commissionUntilDate4) Until date for commision #4. NL: AanstellingTot4 |
commissionUntilDate5 | string or null <date> (commissionUntilDate5) Until date for commision #5. NL: AanstellingTot5 |
commissionUntilDate6 | string or null <date> (commissionUntilDate6) Until date for commision #6. NL: AanstellingTot6 |
isDirectorAndMajorShareholder | boolean or null (isDirectorAndMajorShareholder) Indicates whether the employment can be classified as a director and major shareholder (Dutch: directeur-grootaandeelhouder or DGA). This field can be |
isPreviousOwner | boolean or null (isPreviousOwner) Indicates whether the employment can be classified as a previous owner. This field can be |
isFamilyOfOwner | boolean or null (isFamilyOfOwner) Indicates whether the employment can be classified as a previous owner. This field can be |
isOnCallEmployment | boolean (isOnCallEmploymentVerion2019-12-16) Indicates whether the employment is an on-call employment. This field can be |
hasOnCallAppearanceObligation | boolean or null (hasOnCallAppearanceObligation) In the case of an on-call employment this field indicates whether the employment has an appearance obligation. This field can be |
isGemoedsbezwaardNationalInsurance | boolean (isGemoedsbezwaardNationalInsurance) Gemoedsbezwaard Volksverzekering. NL: IsGemoedsbezwaardVolksverzekering |
isGemoedsbezwaardEmployeeInsurance | boolean (isGemoedsbezwaardEmployeeInsurance) Gemoedsbezwaard Werknemerverzekering. NL: IsGemoedsbezwaardWerknemerverzekering |
isAnonymousEmployee | boolean (isAnonymousEmployee) An employee that wants to remain anonymous related to social security instances. NL: IsAnoniemeWerknemer |
cancellationPeriodEmployee | integer or null <int32> (cancellationPeriodEmployee) [ 1 .. 1000 ] 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 |
cancellationPeriodEmployer | integer or null <int32> (cancellationPeriodEmployer) [ 1 .. 1000 ] 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 |
object or null <metadata> (cancellationPeriodTimeUnit) The unit of time used for the noticePeriodeEmployee and noticePeriodEmployer properties. NL: PeriodeOpzegTermijn | |
cancellationNoticeDate | string or null <date> (cancellationNoticeDate) The date on which the notice was given by either the employee or the employer. NL: DatumOpzegging |
startCancellationNoticePeriod | string or null <date> (startCancellationNoticePeriod) 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 |
namePayslip | string or null (namePayslip) <= 34 characters Name that is visible on payslips for the employment. NL: NaamLoonstrook |
calculateWorkingHours | boolean (calculateWorkingHours) Automatically calculate working hours for the employment if the option automatically calculate hours is selected for a given period. NL: Completeren/Berekenen uren |
writtenEmploymentContract | boolean (writtenEmploymentContract) Did the employment and employer make a written contract? NL: Schriftelijke overeenkomst |
Responses
Request samples
- Payload
{- "historicalStartDate": "2012-05-01",
- "commissionUntilDate": "2019-01-01",
- "typeOfEmployee": {
- "key": 1
}, - "employmentDurationType": {
- "key": 1
}, - "startDateContractOfIndefiniteDuration": "2018-05-08",
- "employmentContractType": {
- "key": 1
}, - "vacationCoupons": {
- "key": 1
}, - "sendToExternalParty": {
- "key": 1
}, - "deviatingCLAExternalParty": 2,
- "deviatingCLATaxReturn": 2,
- "incomeRelationshipNumber": 12,
- "employeeProfileId": {
- "key": 1
}, - "professionCode": 4,
- "exemptionWorkRelatedExpenseScheme": false,
- "exemptionPremiumWaiverMarginalLabour": false,
- "typeOfParticipation": {
- "key": 0
}, - "valueOfParticipation": {
- "key": 0
}, - "wachtgeldOldRegulation": false,
- "participation55plusRegulationUWV": false,
- "essMutationSet": {
- "key": 1
}, - "exemptionInsuranceObligation": {
- "key": 0
}, - "specialIncomeRatio": {
- "key": 0
}, - "temporaryTaxExemption": {
- "key": 2
}, - "periodPayGradeAdjustment": 2,
- "signalPayGradeAdjustment": false,
- "commissionUntilDate1": "2018-05-31",
- "commissionUntilDate2": "2018-05-31",
- "commissionUntilDate3": "2018-05-31",
- "commissionUntilDate4": "2018-05-31",
- "commissionUntilDate5": "2018-05-31",
- "commissionUntilDate6": "2018-05-31",
- "isDirectorAndMajorShareholder": false,
- "isPreviousOwner": false,
- "isFamilyOfOwner": false,
- "isOnCallEmployment": true,
- "hasOnCallAppearanceObligation": true,
- "isGemoedsbezwaardNationalInsurance": true,
- "isGemoedsbezwaardEmployeeInsurance": true,
- "isAnonymousEmployee": true,
- "cancellationPeriodEmployee": 1,
- "cancellationPeriodEmployer": 1,
- "cancellationPeriodTimeUnit": {
- "key": 4
}, - "cancellationNoticeDate": "2018-05-31",
- "startCancellationNoticePeriod": "2018-06-01",
- "namePayslip": "Steve Jobs",
- "calculateWorkingHours": true,
- "writtenEmploymentContract": true
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "employee": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen",
- "prefixPartner": "van de",
- "lastNamePartner": "Wiel",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "dateOfBirth": "1995-05-21",
}, - "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "historicalStartDate": "2012-05-01",
- "commissionUntilDate": "2019-01-01",
- "endDate": "2018-10-23",
- "endOfEmploymentReason": {
- "key": 1,
- "value": "VUT"
}, - "endOfEmploymentReasonTaxAuthorities": {
- "key": 1,
- "value": "Beëindiging arbeidsovereenkomst met wederzijds goedvinden op initiatief van de werkgever."
}, - "endOfEmploymentDueToIllness": false,
- "firstDayNotification": false,
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker"
}, - "nonPayrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "HR only employees",
- "description": "Bakker"
}, - "administration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker",
- "administrationType": "payrollAdministration"
}, - "typeOfEmployee": {
- "key": 1,
- "value": "Werknemer"
}, - "employmentCategoryType": {
- "key": 1,
- "value": "Ouderschapsverlof"
}, - "linkedEmployment": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employmentDurationType": {
- "key": 1,
- "value": "Contract of indefinite duration"
}, - "startDateContractOfIndefiniteDuration": "2018-05-08",
- "employmentContractType": {
- "key": 1,
- "value": "Arbeidsovereenkomst (excl BBL)"
}, - "vacationCoupons": {
- "key": 1,
- "value": "n.v.t."
}, - "sendToExternalParty": {
- "key": 1,
- "value": "n.v.t."
}, - "deviatingCLAExternalParty": 2,
- "deviatingCLATaxReturn": 2,
- "incomeRelationshipNumber": 12,
- "employeeProfileId": {
- "key": 1,
- "value": "Profiel full-timers"
}, - "professionCode": 4,
- "exemptionWorkRelatedExpenseScheme": false,
- "exemptionPremiumWaiverMarginalLabour": false,
- "typeOfParticipation": {
- "key": 0,
- "value": "n.vt."
}, - "valueOfParticipation": {
- "key": 0,
- "value": "n.v.t."
}, - "wachtgeldOldRegulation": false,
- "participation55plusRegulationUWV": false,
- "essMutationSet": {
- "key": 1,
- "value": "Standaard"
}, - "exemptionInsuranceObligation": {
- "key": 0,
- "value": "Geen uitzondering."
}, - "specialIncomeRatio": {
- "key": 0,
- "value": "n.v.t."
}, - "temporaryTaxExemption": {
- "key": 2,
- "value": "Nee."
}, - "periodPayGradeAdjustment": 2,
- "signalPayGradeAdjustment": false,
- "commissionUntilDate1": "2018-05-31",
- "commissionUntilDate2": "2018-05-31",
- "commissionUntilDate3": "2018-05-31",
- "commissionUntilDate4": "2018-05-31",
- "commissionUntilDate5": "2018-05-31",
- "commissionUntilDate6": "2018-05-31",
- "isDirectorAndMajorShareholder": false,
- "isPreviousOwner": false,
- "isFamilyOfOwner": false,
- "isOnCallEmployment": true,
- "hasOnCallAppearanceObligation": true,
- "isGemoedsbezwaardNationalInsurance": true,
- "isGemoedsbezwaardEmployeeInsurance": true,
- "isAnonymousEmployee": true,
- "cancellationPeriodEmployee": 1,
- "cancellationPeriodEmployer": 1,
- "cancellationPeriodTimeUnit": {
- "key": 4,
- "value": "Maand(en)"
}, - "cancellationNoticeDate": "2018-05-31",
- "startCancellationNoticePeriod": "2018-06-01",
- "payrollId": 2,
- "namePayslip": "Steve Jobs",
- "calculateWorkingHours": true,
- "writtenEmploymentContract": true
}
}
Edit the type of an employment
Activity name : PatchTypeOfEmploymentCategoryTypeFieldsByEmploymentId
Edit a small subset of fields of an employment.
Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the URL
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2019-12-16required
Employment to edit
object <metadata> A selection of special pre defined employment-types for the employment. NL: Type dienstverband | |
linkedEmployment | string or null <uuid> ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9... The unique identifier of an object (GUID/UUID) |
Responses
Request samples
- Payload
{- "employmentCategoryType": {
- "key": 1
}, - "linkedEmployment": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "employmentCategoryType": {
- "key": 1,
- "value": "Ouderschapsverlof"
}, - "linkedEmployment": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Delete an employment
Activity name : DeleteEmploymentByEmploymentId
Delete an employment. If the person linked to the employment no longer has any other employments, the person will also be deleted.
Deleting an employment is only possible under specific conditions. Information on these conditions can be obtained with: GetDeleteEmploymentInformationByEmploymentId
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Delete employment information
Activity name : GetDeleteEmploymentInformationByEmploymentId
Get information about the validations that the employment must meet in order to be allowed to delete.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "isEmployed": false,
- "isIncludedInPayroll": false,
- "hasMeldingen": false,
- "HasHealthInsuranceContract": false,
- "hasMdvNotifications": false,
- "hasDocument": false,
- "hasESSAndSingleEmployment": false,
- "hasCleverAndSingleEmployment": false,
- "hasMultipleEmployments": false,
- "hasPayrollRunStatusOpen": false,
- "isIncludedInPayrollTaxreturn": false,
- "isIncludedInPensionDeclaration": false,
- "isIncludedInUpaPensionDeclaration": false,
- "isIncludedInApgPensionDeclaration": false
}
}
Terminate an employment.
Activity name : PatchTerminateByEmploymentId
Terminate 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.
If 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
The metadata for endOfEmploymentReason and endOfEmploymentReasonTaxAuthorities are included in the 'regular' metadata-endpoint of the Employment resource.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: required
The request body contains an object containing fields related to termination of an employment.
endDate | string <date> The date on which the employment ends (=last day of the employment). |
object <metadata> The reason for the end of the employment. Note: as of 2020-01-01 Please set this field to 8 (Other) unless one of the following integrations is used for this employment
| |
endOfEmploymentDueToIllness | boolean Indicates whether the reason for the termination of an employment is due to long-term illness. Mandatory if endDate is filled, else leave empty. |
createMdvEntry | boolean 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 Next to that, a message is ONLY generated when the employment is actually terminated by performing this action (=the employment did not already have an endDate before calling this endpoint). |
object <metadata> The reason for the end of the employment as specified by the Dutch Tax authorties. Note: This field replaces |
Responses
Request samples
- Payload
{- "endDate": "2018-10-23",
- "endOfEmploymentReason": {
- "key": 1
}, - "endOfEmploymentDueToIllness": false,
- "createMdvEntry": false,
- "endOfEmploymentReasonTaxAuthorities": {
- "key": 1
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Undo termination for an employment.
Activity name : PatchReinstateByEmploymentId
reinstate for an employment.
Effectively, termination is reversed by using this endpoint and therefore the employment will be considered active again.
Maak een uitdienst melding ongedaan.
Effectief gezien, 'datum uit dienst' gegevens worden teruggedraaid waardoor het dienstverband weer als actief zal worden beschouwd in Loket
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01
This endpoint does not require a request body. However, the Accept
header does need to be set to ensure the correct resource version is used.
Responses
Request samples
- Payload
{ }
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Correct the start (employment) date for an employment.
Activity name : PatchCorrectStartDateByEmploymentId
Edit the starting date (i.e. the official first day of a contract) of an employment. Please note that changing the starting data for an employment affects multiple entities in Loket (e.g. wage-records etc).
- With a correction of the starting date, you are responsible for the associated notifications.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
The request body contains an object containing fields related to termination of an employment.
startDate | string <date> The date on which this employment starts (=first day of the employment). |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of employees for an employer
Activity name : GetEmployeesByEmployerId
Get a list of all employees for the given employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output The default option is
|
X-ReportInput | string Allows the user set what values are returnd in the "export" (csv or excel). |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "personalDetails": {
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "lastNamePartner": "Wiel",
- "prefixPartner": "van de",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "dateOfDeath": "2019-08-24",
- "aowDate": "2062-08-21",
- "howToFormatLastName": {
- "key": 2,
- "value": "last name + last name partner"
}, - "title": {
- "key": 2,
- "value": "e.g. Msc, PHD or Baron"
}, - "nationality": {
- "key": 2,
- "value": "Dutch"
}, - "gender": {
- "key": 2,
- "value": "female"
}, - "civilStatus": {
- "key": 2,
- "value": "Maried"
}
}, - "contactInformation": {
- "phoneNumber": "+31 13-1234567",
- "mobilePhoneNumber": "+31 6-1231456",
- "faxNumber": "+31 13-1234561",
- "businessPhoneNumber": "+31 13-1234567",
- "businessMobilePhoneNumber": "+31 6-1231456",
- "businessEmailAddress": "[email protected]"
}, - "identityDocument": {
- "typeOfDocument": {
- "key": 2,
- "value": "Passport"
}, - "documentIdentification": "CRE45553433"
}, - "travel": {
- "travelDistanceToWork": 32,
- "travelDistanceToWorkInKm": 41.05
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "exclusionFromAbsenceStatus": false,
- "statusEmployeeSelfService": {
- "key": 2,
- "value": "Blocked"
}, - "revokeEmployeeSelfServiceAccessOn": "2018-10-23"
}
]
}
Details of an employee
Activity name : GetEmployeeByEmployeeId
Get the details of a single employee
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "personalDetails": {
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "lastNamePartner": "Wiel",
- "prefixPartner": "van de",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "dateOfDeath": "2019-08-24",
- "aowDate": "2062-08-21",
- "howToFormatLastName": {
- "key": 2,
- "value": "last name + last name partner"
}, - "title": {
- "key": 2,
- "value": "e.g. Msc, PHD or Baron"
}, - "nationality": {
- "key": 2,
- "value": "Dutch"
}, - "gender": {
- "key": 2,
- "value": "female"
}, - "civilStatus": {
- "key": 2,
- "value": "Maried"
}
}, - "contactInformation": {
- "phoneNumber": "+31 13-1234567",
- "mobilePhoneNumber": "+31 6-1231456",
- "faxNumber": "+31 13-1234561",
- "businessPhoneNumber": "+31 13-1234567",
- "businessMobilePhoneNumber": "+31 6-1231456",
- "businessEmailAddress": "[email protected]"
}, - "identityDocument": {
- "typeOfDocument": {
- "key": 2,
- "value": "Passport"
}, - "documentIdentification": "CRE45553433"
}, - "travel": {
- "travelDistanceToWork": 32,
- "travelDistanceToWorkInKm": 41.05
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "exclusionFromAbsenceStatus": false,
- "statusEmployeeSelfService": {
- "key": 2,
- "value": "Blocked"
}, - "revokeEmployeeSelfServiceAccessOn": "2018-10-23"
}
}
Edit the details of an employee
Activity name : PutEmployeeByEmployeeId
Edit the employee details
Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the URL
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: required
Employee to edit.
employeeNumber | integer <int32> (employeeNumber) >= 1 The employee number to uniquely identify an employee within an employer |
object (personalDetails) | |
object (contactInformation2021-03-29) | |
object or null (identityDocument) | |
object (travel) | |
object or null (schemas-address) | |
object or null (schemas-deviatingPostalAddress) | |
exclusionFromAbsenceStatus | boolean (exclusionFromAbsenceStatus) Indicates whether the employee is excluded for any information of absence |
Responses
Request samples
- Payload
{- "employeeNumber": 156,
- "personalDetails": {
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "lastNamePartner": "Wiel",
- "prefixPartner": "van de",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "dateOfDeath": "2019-08-24",
- "howToFormatLastName": {
- "key": 2
}, - "title": {
- "key": 2
}, - "nationality": {
- "key": 2
}, - "gender": {
- "key": 2
}, - "civilStatus": {
- "key": 2
}
}, - "contactInformation": {
- "phoneNumber": "+31 13-1234567",
- "mobilePhoneNumber": "+31 6-1231456",
- "faxNumber": "+31 13-1234561",
- "businessPhoneNumber": "+31 13-1234567",
- "businessMobilePhoneNumber": "+31 6-1231456",
- "businessEmailAddress": "[email protected]"
}, - "identityDocument": {
- "typeOfDocument": {
- "key": 2
}, - "documentIdentification": "CRE45553433"
}, - "travel": {
- "travelDistanceToWork": 32
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "isoCode": "NL"
}
}, - "exclusionFromAbsenceStatus": false
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "personalDetails": {
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "lastNamePartner": "Wiel",
- "prefixPartner": "van de",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "dateOfDeath": "2019-08-24",
- "aowDate": "2062-08-21",
- "howToFormatLastName": {
- "key": 2,
- "value": "last name + last name partner"
}, - "title": {
- "key": 2,
- "value": "e.g. Msc, PHD or Baron"
}, - "nationality": {
- "key": 2,
- "value": "Dutch"
}, - "gender": {
- "key": 2,
- "value": "female"
}, - "civilStatus": {
- "key": 2,
- "value": "Maried"
}
}, - "contactInformation": {
- "phoneNumber": "+31 13-1234567",
- "mobilePhoneNumber": "+31 6-1231456",
- "faxNumber": "+31 13-1234561",
- "businessPhoneNumber": "+31 13-1234567",
- "businessMobilePhoneNumber": "+31 6-1231456",
- "businessEmailAddress": "[email protected]"
}, - "identityDocument": {
- "typeOfDocument": {
- "key": 2,
- "value": "Passport"
}, - "documentIdentification": "CRE45553433"
}, - "travel": {
- "travelDistanceToWork": 32,
- "travelDistanceToWorkInKm": 41.05
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "exclusionFromAbsenceStatus": false,
- "statusEmployeeSelfService": {
- "key": 2,
- "value": "Blocked"
}, - "revokeEmployeeSelfServiceAccessOn": "2018-10-23"
}
}
Change the email address for an employee
Activity name : PatchEmailByEmployeeId
Defaults : No defaults
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-12-31required
Email address
emailAddress | string or null <= 255 characters ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\... The e-mail address of the employee. |
Responses
Request samples
- Payload
{- "emailAddress": "[email protected]"
}
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Citizen service number of an employee
Activity name : GetCitizenServiceNumberByEmployeeId
Get the citizen service number of an employee. BSN is separately authorized in Loket and is therefore designed to have its own activities.
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "citizenServiceNumber": "042168588"
}
}
Update the citizen service number of an employee
Activity name : PutCitizenServiceNumberByEmployeeId
Update the citizen service number of an employee. BSN is separately authorized in Loket and is therefore designed to have its own activities.
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
citizen service number to edit.
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).
Responses
Request samples
- Payload
"042168588"
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": "042168588"
}
Photo of an employee
Activity name : GetEmployeePhotoByEmployeeId
Photo of the employee to use as an avatar/profile picture
Caching: This resource changes very infrequently and can be cached for a longer time.
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 401
- 403
{- "message": "Authorization has been denied for this request."
}
Post employee photo
Activity name : PostEmployeePhotoByEmployeeId
Photo of the employee to use as an avatar/profile picture
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Logo to be uploaded for the employer.
data | string base64 encoded document file. |
mimeType | string The mimetype of the data. |
Responses
Request samples
- Payload
{- "data": "YQ==",
- "mimeType": "image/jpeg"
}
Response samples
- 401
- 403
{- "message": "Authorization has been denied for this request."
}
Delete employee photo
Activity name : DeleteEmployeePhotoByEmployeeId
Photo of the employee to use as an avatar/profile picture
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Photo of an employee
Activity name : GetEmployeePhotoByEmployeeIdAndVersion
Photo of the employee to use as an avatar/profile picture
Caching: This resource changes very infrequently and can be cached for a longer time.
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
version required | string <uuid> 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. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 401
- 403
{- "message": "Authorization has been denied for this request."
}
Create a new employee in Loket
Activity name : PostEmployeeByEmployerId
This endpoint 'creates' an employee in Loket with its corresponding entities. This means creating a number of records including Employee, Employment, WorkingHours, Wage etc.
Before 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.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Employee to be created
object (employee) | |
object or null (employment) | |
object or null (workingHours) | |
object or null (wage) | |
object or null (organizationalEntity) | |
object or null (socialSecurity) | |
object or null (fiscal) | |
object or null (otherPayrollVariables) | |
object (schemas-citizenServiceNumber) |
Responses
Request samples
- Payload
{- "employeeData": {
- "employeeNumber": 156,
- "personalDetails": {
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "lastNamePartner": "Wiel",
- "prefixPartner": "van de",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "howToFormatLastName": {
- "key": 2
}, - "title": {
- "key": 2
}, - "gender": {
- "key": 2
}, - "nationality": {
- "key": 2
}, - "civilStatus": {
- "key": 2
}
}, - "contactInformation": {
- "phoneNumber": "+31 13-1234567",
- "mobilePhoneNumber": "+31 6-1231456",
- "faxNumber": "+31 13-1234561",
- "emailAddress": "[email protected]"
}, - "identityDocument": {
- "typeOfDocument": {
- "key": 2
}, - "documentIdentification": "CRE45553433"
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1
}
}, - "iban": "NL52ABNA0424968264"
}, - "employmentData": {
- "startDate": "2019-01-01",
- "historicalStartDate": "2012-05-01",
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "nonPayrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "commissionUntilDate": "2019-01-01",
- "incomeRelationshipNumber": 12,
- "employeeProfileId": {
- "key": 1
}, - "employmentDurationType": {
- "key": 1
}, - "startDateContractOfIndefiniteDuration": "2018-05-08",
- "employmentContractType": {
- "key": 1
}, - "typeOfEmployee": {
- "key": 1
}, - "cancellationPeriodEmployee": 1,
- "cancellationPeriodEmployer": 1,
- "cancellationPeriodTimeUnit": {
- "key": 4
}, - "cancellationNoticeDate": "2019-05-31",
- "startCancellationNoticePeriod": "2019-06-01",
- "isDirectorAndMajorShareholder": false,
- "isOnCallEmployment": true,
- "hasOnCallAppearanceObligation": true,
- "vacationCoupons": {
- "key": 1
}, - "specialIncomeRatio": {
- "key": 0
}, - "isAnonymousEmployee": true,
- "isPreviousOwner": false,
- "isFamilyOfOwner": false,
- "isGemoedsbezwaardNationalInsurance": true,
- "isGemoedsbezwaardEmployeeInsurance": true,
- "namePayslip": "Steve Jobs",
- "calculateWorkingHours": true,
- "essMutationSet": {
- "key": 1
}, - "exemptionInsuranceObligation": {
- "key": 0
}, - "sendMdvNotification": true,
- "periodPayGradeAdjustment": 2,
- "signalPayGradeAdjustment": false,
- "typeOfParticipation": {
- "key": 0
}, - "valueOfParticipation": {
- "key": 0
}, - "professionCode": 4,
- "deviatingCLATaxReturn": 2,
- "participation55plusRegulationUWV": false,
- "writtenEmploymentContract": true
}, - "workingHoursData": {
- "shift": {
- "shiftNumber": 1
}, - "deviatingHoursPerWeek": 32,
- "deviatingSvDaysPerPeriod": 32,
- "averageParttimeFactor": 37.5,
- "regularWorkPattern": true,
- "flexibleHoursContract": {
- "key": 0
}, - "contractCode": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "calculateUsingWorkPattern": {
- "leaveHours": true,
- "hoursBrokenPeriod": false,
- "hoursPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "workPattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "wageData": {
- "grossWage": 23,
- "grossWageType": {
- "key": 2
}, - "netWage": 1,
- "netWageType": { },
- "payScale": { },
- "payGrade": { },
- "applyPayGrade": true
}, - "organizationalEntityData": {
- "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "standardFunction": {
- "key": 1
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "placeOfEmployment": "Amsterdam office",
- "internalTelephoneExtensionNumber": "0133031600"
}, - "socialSecurityData": {
- "isInsuredForSicknessBenefitsAct": false,
- "isInsuredForUnemploymentInsuranceAct": false,
- "isInsuredForOccupationalDisabilityInsuranceAct": false,
- "healthCareInsuranceActType": {
- "key": 2
}
}, - "fiscalData": {
- "annualSalary": 60000,
- "deviatingPayrollTaxTableColour": {
- "key": 2
}, - "applyDayTables": false,
- "applyDeviatingPayrollTaxPercentageOn": {
- "key": 2
}, - "applyPayrollTaxDeduction": false,
- "applyStudentDeduction": false,
- "deviatingCalculationRulePayrollTax": {
- "key": 2
}, - "residentOf": {
- "key": 2
}
}, - "otherPayrollVariablesData": {
- "deviatingPremiumGroup": {
- "key": 2
}
}, - "citizenServiceNumber": {
- "citizenServiceNumber": "042168588"
}
}
Response samples
- 201
- 400
- 401
- 403
{- "employeeId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
Set the date on which to revoke ESS access
Activity name : PatchRevokeEmployeeSelfServiceAccessByEmployeeId
This endpoint allows the user to set the 'revokeEmployeeSelfServiceAccessOn'. This date indicates on what day the access to WerknemerLoket (Employee Self Service) will be revoked (this is done by scheduled tasks that run during the night). This is particularly useful for situations where for example the employer wants to restrict access at a specific date in the future, for example 1st of May in the next year.
The value may be set to NULL and thus clearing the date on which access would be revoked. Please note that this endpoint will not automatically 'unblock' an Employee, as that would require a specific action.
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
The request body contains an object containing fields related to termination of an employment.
revokeEmployeeSelfServiceAccessOn | string or null <date> The date on which the Employees access to ESS (werknemer.loket) will be automatically revoked. |
Responses
Request samples
- Payload
{- "revokeEmployeeSelfServiceAccessOn": "2018-10-23"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
NL: Concept Werknemer. Manage concept employees. In integrations with different applications it is sometimes necessary to use concept employee to create new employments within loket.nl. This is due to the fact that most systems don’t have all the fields required to create a new employment in loket.nl. Because for employee the validations are disabled. Allowing for the creation of a concept employee with only a subset of the fields that are required when creating a employment. At a later point the concept employee can be "promoted" to employee/employment using the Loket.nl interface. Please note that when a concept employee is promoted to an actual employee, the GUID of the employee will be identical to the concept employee from which it was created.
List of concept employee for an employer
Activity name : GetConceptEmployeesByEmployerId
Get a list of all concept employee for the given employer. Concept employee can be used as a template/prefill when creating a new employee/employment.
This function may also be used in case one does not have all the required fields to create a new employee/employment. The validations are disabled for a concept employee allowing one to create a concept employee filling only a subset of available fields, then later "promoting" the Concept employee in loket.nl to employee/employment.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "uniqueName": "Sollicitant 013",
- "creationDate": "2018-05-08",
- "employeeData": {
- "employeeNumber": 156,
- "personalDetails": {
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "lastNamePartner": "Wiel",
- "prefixPartner": "van de",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "howToFormatLastName": {
- "key": 2,
- "value": "last name + last name partner"
}, - "title": {
- "key": 2,
- "value": "e.g. Msc, PHD or Baron"
}, - "gender": {
- "key": 2,
- "value": "female"
}, - "nationality": {
- "key": 2,
- "value": "Dutch"
}, - "civilStatus": {
- "key": 2,
- "value": "Married"
}
}, - "contactInformation": {
- "phoneNumber": "+31 13-1234567",
- "mobilePhoneNumber": "+31 6-1231456",
- "faxNumber": "+31 13-1234561",
- "emailAddress": "[email protected]"
}, - "identityDocument": {
- "typeOfDocument": {
- "key": 2,
- "value": "Passport"
}, - "documentIdentification": "CRE45553433"
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "iban": "NL52ABNA0424968264"
}, - "employmentData": {
- "startDate": "2019-01-01",
- "historicalStartDate": "2012-05-01",
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker"
}, - "nonPayrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "description": "Bakker"
}, - "commissionUntilDate": "2019-01-01",
- "incomeRelationshipNumber": 12,
- "employeeProfileId": {
- "key": 1,
- "value": "Profiel full-timers"
}, - "employmentDurationType": {
- "key": 1,
- "value": "Contract of indefinite duration"
}, - "startDateContractOfIndefiniteDuration": "2018-05-08",
- "employmentContractType": {
- "key": 1,
- "value": "Labor agreement"
}, - "typeOfEmployee": {
- "key": 1,
- "value": "Werknemer"
}, - "cancellationPeriodEmployee": 1,
- "cancellationPeriodEmployer": 1,
- "cancellationPeriodTimeUnit": {
- "key": 4,
- "value": "Maand(en)"
}, - "cancellationNoticeDate": "2019-05-31",
- "startCancellationNoticePeriod": "2019-06-01",
- "isDirectorAndMajorShareholder": false,
- "isOnCallEmployment": true,
- "hasOnCallAppearanceObligation": true,
- "vacationCoupons": {
- "key": 1,
- "value": "n.v.t."
}, - "specialIncomeRatio": {
- "key": 0,
- "value": "n.v.t."
}, - "isAnonymousEmployee": true,
- "isPreviousOwner": false,
- "isFamilyOfOwner": false,
- "isGemoedsbezwaardNationalInsurance": true,
- "isGemoedsbezwaardEmployeeInsurance": true,
- "namePayslip": "Steve Jobs",
- "calculateWorkingHours": true,
- "essMutationSet": {
- "key": 1,
- "value": "Standaard"
}, - "exemptionInsuranceObligation": {
- "key": 0,
- "value": "Geen uitzondering."
}, - "firstDayNotification": false,
- "sendMdvNotification": true,
- "periodPayGradeAdjustment": 2,
- "signalPayGradeAdjustment": false,
- "typeOfParticipation": {
- "key": 0,
- "value": "n.v.t."
}, - "valueOfParticipation": {
- "key": 0,
- "value": "n.v.t."
}, - "professionCode": 4,
- "deviatingCLATaxReturn": 2,
- "participation55plusRegulationUWV": false,
- "writtenEmploymentContract": true
}, - "workingHoursData": {
- "shift": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "deviatingHoursPerWeek": 32,
- "deviatingSvDaysPerPeriod": 32,
- "averageParttimeFactor": 37.5,
- "regularWorkPattern": true,
- "flexibleHoursContract": {
- "key": 0,
- "value": "n.v.t."
}, - "contractCode": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 1022,
- "description": "SLA-PT-met toeslagen ATW (88)"
}, - "calculateUsingWorkPattern": {
- "leaveHours": true,
- "hoursBrokenPeriod": false,
- "hoursPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "workPattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "wageData": {
- "grossWage": 23,
- "grossWageType": {
- "key": 2,
- "value": "hourly"
}, - "netWage": 1,
- "netWageType": {
- "key": 1,
- "value": "hourly"
}, - "payScale": {
- "key": 1,
- "value": "Glastuinbouw maand, Loongebouw A"
}, - "payGrade": {
- "key": 1,
- "value": "Schaal B1, 15 jaar"
}, - "applyPayGrade": true
}, - "organizationalEntityData": {
- "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Directeur",
- "group": "internal"
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "standardFunction": {
- "key": 1,
- "value": "Administrateur",
- "code": "A21",
- "category": 1
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}, - "placeOfEmployment": "Amsterdam office",
- "internalTelephoneExtensionNumber": "0133031600"
}, - "socialSecurityData": {
- "isInsuredForSicknessBenefitsAct": false,
- "isInsuredForUnemploymentInsuranceAct": false,
- "isInsuredForOccupationalDisabilityInsuranceAct": false,
- "healthCareInsuranceActType": {
- "key": 2,
- "value": "(C/K) Wel verzekeringsplichtig, normaal tarief"
}
}, - "fiscalData": {
- "annualSalary": 60000,
- "deviatingPayrollTaxTableColour": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "applyDayTables": false,
- "deviatingPayrollTaxPercentage": 27.45,
- "applyDeviatingPayrollTaxPercentageOn": {
- "key": 2,
- "value": "Afwijkend voor tabel- en tariefloon"
}, - "applyPayrollTaxDeduction": false,
- "applyStudentDeduction": false,
- "deviatingCalculationRulePayrollTax": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "residentOf": {
- "key": 2,
- "value": "Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden"
}
}, - "otherPayrollVariablesData": {
- "deviatingPremiumGroup": {
- "key": 2,
- "value": "(12) Metaal- en technische bedrijfstakken"
}
}, - "selfService": {
- "status": "HasAccessToClient",
- "clientName": "Clever"
}
}
]
}
Create a concept employee for an employer
Activity name : PostConceptEmployeeByEmployerId
Create a concept employee for an employer
* Possible options (metadata) for generic fields of the type \metadata" can be acquired (GET) by adding /metadata
to the URL.
* Possible options dependent on a specific payrollAdministration can be acquired via ../providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}
.
* Possible options for payGrade can be acquired via ../providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}
.
A payGrade
has time based values dictating the wage for a given period. These values can be acquired by performing another metadata request to GET ../providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}/paygrade/{payGradeKey}
. This endpoint has the optional parameter "date" that may be used to specifying a measure date.
Defaults : Default values for a new object can be acquired by adding /defaults
to the POST URL.
Default values that are dependent on the selected payroll administration can be acquired by adding /providers/employers/conceptemployees/defaults/payrolladministration/{payrollAdministrationId}
to the POST URL.
NonPayrollAdministrations For nonPayrollAdministrations the equivalent MetaData-endpoints are also available as described above. However NO specific defaults endpoint is available for the nonPayrollAdministration.
"
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
concept employee to create to the employer.
uniqueName | string [ 1 .. 255 ] characters 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. |
object (employee) | |
object or null (employment) | |
object or null (workingHours) | |
object or null (wage) | |
object or null (organizationalEntity) | |
object or null (socialSecurity) | |
object or null (fiscal) | |
object or null (otherPayrollVariables) |
Responses
Request samples
- Payload
{- "uniqueName": "Sollicitant 013",
- "employeeData": {
- "employeeNumber": 156,
- "personalDetails": {
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "lastNamePartner": "Wiel",
- "prefixPartner": "van de",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "howToFormatLastName": {
- "key": 2
}, - "title": {
- "key": 2
}, - "gender": {
- "key": 2
}, - "nationality": {
- "key": 2
}, - "civilStatus": {
- "key": 2
}
}, - "contactInformation": {
- "phoneNumber": "+31 13-1234567",
- "mobilePhoneNumber": "+31 6-1231456",
- "faxNumber": "+31 13-1234561",
- "emailAddress": "[email protected]"
}, - "identityDocument": {
- "typeOfDocument": {
- "key": 2
}, - "documentIdentification": "CRE45553433"
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1
}
}, - "iban": "NL52ABNA0424968264"
}, - "employmentData": {
- "startDate": "2019-01-01",
- "historicalStartDate": "2012-05-01",
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "nonPayrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "commissionUntilDate": "2019-01-01",
- "incomeRelationshipNumber": 12,
- "employeeProfileId": {
- "key": 1
}, - "employmentDurationType": {
- "key": 1
}, - "startDateContractOfIndefiniteDuration": "2018-05-08",
- "employmentContractType": {
- "key": 1
}, - "typeOfEmployee": {
- "key": 1
}, - "cancellationPeriodEmployee": 1,
- "cancellationPeriodEmployer": 1,
- "cancellationPeriodTimeUnit": {
- "key": 4
}, - "cancellationNoticeDate": "2019-05-31",
- "startCancellationNoticePeriod": "2019-06-01",
- "isDirectorAndMajorShareholder": false,
- "isOnCallEmployment": true,
- "hasOnCallAppearanceObligation": true,
- "vacationCoupons": {
- "key": 1
}, - "specialIncomeRatio": {
- "key": 0
}, - "isAnonymousEmployee": true,
- "isPreviousOwner": false,
- "isFamilyOfOwner": false,
- "isGemoedsbezwaardNationalInsurance": true,
- "isGemoedsbezwaardEmployeeInsurance": true,
- "namePayslip": "Steve Jobs",
- "calculateWorkingHours": true,
- "essMutationSet": {
- "key": 1
}, - "exemptionInsuranceObligation": {
- "key": 0
}, - "sendMdvNotification": true,
- "periodPayGradeAdjustment": 2,
- "signalPayGradeAdjustment": false,
- "typeOfParticipation": {
- "key": 0
}, - "valueOfParticipation": {
- "key": 0
}, - "professionCode": 4,
- "deviatingCLATaxReturn": 2,
- "participation55plusRegulationUWV": false,
- "writtenEmploymentContract": true
}, - "workingHoursData": {
- "shift": {
- "shiftNumber": 1
}, - "deviatingHoursPerWeek": 32,
- "deviatingSvDaysPerPeriod": 32,
- "averageParttimeFactor": 37.5,
- "regularWorkPattern": true,
- "flexibleHoursContract": {
- "key": 0
}, - "contractCode": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "calculateUsingWorkPattern": {
- "leaveHours": true,
- "hoursBrokenPeriod": false,
- "hoursPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "workPattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "wageData": {
- "grossWage": 23,
- "grossWageType": {
- "key": 2
}, - "netWage": 1,
- "netWageType": { },
- "payScale": { },
- "payGrade": { },
- "applyPayGrade": true
}, - "organizationalEntityData": {
- "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "standardFunction": {
- "key": 1
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "placeOfEmployment": "Amsterdam office",
- "internalTelephoneExtensionNumber": "0133031600"
}, - "socialSecurityData": {
- "isInsuredForSicknessBenefitsAct": false,
- "isInsuredForUnemploymentInsuranceAct": false,
- "isInsuredForOccupationalDisabilityInsuranceAct": false,
- "healthCareInsuranceActType": {
- "key": 2
}
}, - "fiscalData": {
- "annualSalary": 60000,
- "deviatingPayrollTaxTableColour": {
- "key": 2
}, - "applyDayTables": false,
- "applyDeviatingPayrollTaxPercentageOn": {
- "key": 2
}, - "applyPayrollTaxDeduction": false,
- "applyStudentDeduction": false,
- "deviatingCalculationRulePayrollTax": {
- "key": 2
}, - "residentOf": {
- "key": 2
}
}, - "otherPayrollVariablesData": {
- "deviatingPremiumGroup": {
- "key": 2
}
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "uniqueName": "Sollicitant 013",
- "creationDate": "2018-05-08",
- "employeeData": {
- "employeeNumber": 156,
- "personalDetails": {
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "lastNamePartner": "Wiel",
- "prefixPartner": "van de",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "howToFormatLastName": {
- "key": 2,
- "value": "last name + last name partner"
}, - "title": {
- "key": 2,
- "value": "e.g. Msc, PHD or Baron"
}, - "gender": {
- "key": 2,
- "value": "female"
}, - "nationality": {
- "key": 2,
- "value": "Dutch"
}, - "civilStatus": {
- "key": 2,
- "value": "Married"
}
}, - "contactInformation": {
- "phoneNumber": "+31 13-1234567",
- "mobilePhoneNumber": "+31 6-1231456",
- "faxNumber": "+31 13-1234561",
- "emailAddress": "[email protected]"
}, - "identityDocument": {
- "typeOfDocument": {
- "key": 2,
- "value": "Passport"
}, - "documentIdentification": "CRE45553433"
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "iban": "NL52ABNA0424968264"
}, - "employmentData": {
- "startDate": "2019-01-01",
- "historicalStartDate": "2012-05-01",
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker"
}, - "nonPayrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "description": "Bakker"
}, - "commissionUntilDate": "2019-01-01",
- "incomeRelationshipNumber": 12,
- "employeeProfileId": {
- "key": 1,
- "value": "Profiel full-timers"
}, - "employmentDurationType": {
- "key": 1,
- "value": "Contract of indefinite duration"
}, - "startDateContractOfIndefiniteDuration": "2018-05-08",
- "employmentContractType": {
- "key": 1,
- "value": "Labor agreement"
}, - "typeOfEmployee": {
- "key": 1,
- "value": "Werknemer"
}, - "cancellationPeriodEmployee": 1,
- "cancellationPeriodEmployer": 1,
- "cancellationPeriodTimeUnit": {
- "key": 4,
- "value": "Maand(en)"
}, - "cancellationNoticeDate": "2019-05-31",
- "startCancellationNoticePeriod": "2019-06-01",
- "isDirectorAndMajorShareholder": false,
- "isOnCallEmployment": true,
- "hasOnCallAppearanceObligation": true,
- "vacationCoupons": {
- "key": 1,
- "value": "n.v.t."
}, - "specialIncomeRatio": {
- "key": 0,
- "value": "n.v.t."
}, - "isAnonymousEmployee": true,
- "isPreviousOwner": false,
- "isFamilyOfOwner": false,
- "isGemoedsbezwaardNationalInsurance": true,
- "isGemoedsbezwaardEmployeeInsurance": true,
- "namePayslip": "Steve Jobs",
- "calculateWorkingHours": true,
- "essMutationSet": {
- "key": 1,
- "value": "Standaard"
}, - "exemptionInsuranceObligation": {
- "key": 0,
- "value": "Geen uitzondering."
}, - "firstDayNotification": false,
- "sendMdvNotification": true,
- "periodPayGradeAdjustment": 2,
- "signalPayGradeAdjustment": false,
- "typeOfParticipation": {
- "key": 0,
- "value": "n.v.t."
}, - "valueOfParticipation": {
- "key": 0,
- "value": "n.v.t."
}, - "professionCode": 4,
- "deviatingCLATaxReturn": 2,
- "participation55plusRegulationUWV": false,
- "writtenEmploymentContract": true
}, - "workingHoursData": {
- "shift": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "deviatingHoursPerWeek": 32,
- "deviatingSvDaysPerPeriod": 32,
- "averageParttimeFactor": 37.5,
- "regularWorkPattern": true,
- "flexibleHoursContract": {
- "key": 0,
- "value": "n.v.t."
}, - "contractCode": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 1022,
- "description": "SLA-PT-met toeslagen ATW (88)"
}, - "calculateUsingWorkPattern": {
- "leaveHours": true,
- "hoursBrokenPeriod": false,
- "hoursPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "workPattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "wageData": {
- "grossWage": 23,
- "grossWageType": {
- "key": 2,
- "value": "hourly"
}, - "netWage": 1,
- "netWageType": {
- "key": 1,
- "value": "hourly"
}, - "payScale": {
- "key": 1,
- "value": "Glastuinbouw maand, Loongebouw A"
}, - "payGrade": {
- "key": 1,
- "value": "Schaal B1, 15 jaar"
}, - "applyPayGrade": true
}, - "organizationalEntityData": {
- "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Directeur",
- "group": "internal"
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "standardFunction": {
- "key": 1,
- "value": "Administrateur",
- "code": "A21",
- "category": 1
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}, - "placeOfEmployment": "Amsterdam office",
- "internalTelephoneExtensionNumber": "0133031600"
}, - "socialSecurityData": {
- "isInsuredForSicknessBenefitsAct": false,
- "isInsuredForUnemploymentInsuranceAct": false,
- "isInsuredForOccupationalDisabilityInsuranceAct": false,
- "healthCareInsuranceActType": {
- "key": 2,
- "value": "(C/K) Wel verzekeringsplichtig, normaal tarief"
}
}, - "fiscalData": {
- "annualSalary": 60000,
- "deviatingPayrollTaxTableColour": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "applyDayTables": false,
- "deviatingPayrollTaxPercentage": 27.45,
- "applyDeviatingPayrollTaxPercentageOn": {
- "key": 2,
- "value": "Afwijkend voor tabel- en tariefloon"
}, - "applyPayrollTaxDeduction": false,
- "applyStudentDeduction": false,
- "deviatingCalculationRulePayrollTax": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "residentOf": {
- "key": 2,
- "value": "Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden"
}
}, - "otherPayrollVariablesData": {
- "deviatingPremiumGroup": {
- "key": 2,
- "value": "(12) Metaal- en technische bedrijfstakken"
}
}, - "selfService": {
- "status": "HasAccessToClient",
- "clientName": "Clever"
}
}
}
Details of a concept employee with fewer fields.
Activity name : GetConceptEmployeeMinimizedByConceptEmployeeId
Get the details of a concept employee with fewer fields
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "personalDetails": {
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "lastNamePartner": "Wiel",
- "prefixPartner": "van de",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "howToFormatLastName": {
- "key": 2,
- "value": "last name + last name partner"
}, - "title": {
- "key": 2,
- "value": "e.g. Msc, PHD or Baron"
}, - "gender": {
- "key": 2,
- "value": "female"
}, - "nationality": {
- "key": 2,
- "value": "Dutch"
}, - "civilStatus": {
- "key": 2,
- "value": "Married"
}
}, - "contactInformation": {
- "phoneNumber": "+31 13-1234567",
- "mobilePhoneNumber": "+31 6-1231456",
- "faxNumber": "+31 13-1234561",
- "emailAddress": "[email protected]"
}, - "identityDocument": {
- "typeOfDocument": {
- "key": 2,
- "value": "Passport"
}, - "documentIdentification": "CRE45553433"
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "iban": "NL52ABNA0424968264",
- "applyPayrollTaxDeduction": true
}
}
Edit the details of a concept employee with fewer fields.
Activity name : PutConceptEmployeeMinimizedByConceptEmployeeId
Edit the details of a concept employee with fewer fields.
- Possible options (metadata) for generic fields of the type "metadata" can be acquired (GET) by adding
/metadata
to the URL.
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Concept employee to edit.
object The personal details of the employee. e.g. Name, civil status en gender | |
object or null Contact information for the employee | |
object or null The identification document of the employee | |
object or null The address of the employee | |
iban | string or null <= 35 characters International Bank Account Number. Only IBAN without spaces are accepted. |
applyPayrollTaxDeduction | boolean Indicates whether payroll tax deduction is appliclable (loonheffingskorting) |
Responses
Request samples
- Payload
{- "personalDetails": {
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "lastNamePartner": "Wiel",
- "prefixPartner": "van de",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "howToFormatLastName": {
- "key": 2
}, - "title": {
- "key": 2
}, - "gender": {
- "key": 2
}, - "nationality": {
- "key": 2
}, - "civilStatus": {
- "key": 2
}
}, - "contactInformation": {
- "phoneNumber": "+31 13-1234567",
- "mobilePhoneNumber": "+31 6-1231456",
- "faxNumber": "+31 13-1234561",
- "emailAddress": "[email protected]"
}, - "identityDocument": {
- "typeOfDocument": {
- "key": 2
}, - "documentIdentification": "CRE45553433"
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1
}
}, - "iban": "NL52ABNA0424968264",
- "applyPayrollTaxDeduction": true
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "personalDetails": {
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "lastNamePartner": "Wiel",
- "prefixPartner": "van de",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "howToFormatLastName": {
- "key": 2,
- "value": "last name + last name partner"
}, - "title": {
- "key": 2,
- "value": "e.g. Msc, PHD or Baron"
}, - "gender": {
- "key": 2,
- "value": "female"
}, - "nationality": {
- "key": 2,
- "value": "Dutch"
}, - "civilStatus": {
- "key": 2,
- "value": "Married"
}
}, - "contactInformation": {
- "phoneNumber": "+31 13-1234567",
- "mobilePhoneNumber": "+31 6-1231456",
- "faxNumber": "+31 13-1234561",
- "emailAddress": "[email protected]"
}, - "identityDocument": {
- "typeOfDocument": {
- "key": 2,
- "value": "Passport"
}, - "documentIdentification": "CRE45553433"
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "iban": "NL52ABNA0424968264",
- "applyPayrollTaxDeduction": true
}
}
Details of a concept employee
Activity name : GetConceptEmployeeByConceptEmployeeId
Get the details of a concept employee
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "uniqueName": "Sollicitant 013",
- "creationDate": "2018-05-08",
- "employeeData": {
- "employeeNumber": 156,
- "personalDetails": {
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "lastNamePartner": "Wiel",
- "prefixPartner": "van de",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "howToFormatLastName": {
- "key": 2,
- "value": "last name + last name partner"
}, - "title": {
- "key": 2,
- "value": "e.g. Msc, PHD or Baron"
}, - "gender": {
- "key": 2,
- "value": "female"
}, - "nationality": {
- "key": 2,
- "value": "Dutch"
}, - "civilStatus": {
- "key": 2,
- "value": "Married"
}
}, - "contactInformation": {
- "phoneNumber": "+31 13-1234567",
- "mobilePhoneNumber": "+31 6-1231456",
- "faxNumber": "+31 13-1234561",
- "emailAddress": "[email protected]"
}, - "identityDocument": {
- "typeOfDocument": {
- "key": 2,
- "value": "Passport"
}, - "documentIdentification": "CRE45553433"
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "iban": "NL52ABNA0424968264"
}, - "employmentData": {
- "startDate": "2019-01-01",
- "historicalStartDate": "2012-05-01",
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker"
}, - "nonPayrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "description": "Bakker"
}, - "commissionUntilDate": "2019-01-01",
- "incomeRelationshipNumber": 12,
- "employeeProfileId": {
- "key": 1,
- "value": "Profiel full-timers"
}, - "employmentDurationType": {
- "key": 1,
- "value": "Contract of indefinite duration"
}, - "startDateContractOfIndefiniteDuration": "2018-05-08",
- "employmentContractType": {
- "key": 1,
- "value": "Labor agreement"
}, - "typeOfEmployee": {
- "key": 1,
- "value": "Werknemer"
}, - "cancellationPeriodEmployee": 1,
- "cancellationPeriodEmployer": 1,
- "cancellationPeriodTimeUnit": {
- "key": 4,
- "value": "Maand(en)"
}, - "cancellationNoticeDate": "2019-05-31",
- "startCancellationNoticePeriod": "2019-06-01",
- "isDirectorAndMajorShareholder": false,
- "isOnCallEmployment": true,
- "hasOnCallAppearanceObligation": true,
- "vacationCoupons": {
- "key": 1,
- "value": "n.v.t."
}, - "specialIncomeRatio": {
- "key": 0,
- "value": "n.v.t."
}, - "isAnonymousEmployee": true,
- "isPreviousOwner": false,
- "isFamilyOfOwner": false,
- "isGemoedsbezwaardNationalInsurance": true,
- "isGemoedsbezwaardEmployeeInsurance": true,
- "namePayslip": "Steve Jobs",
- "calculateWorkingHours": true,
- "essMutationSet": {
- "key": 1,
- "value": "Standaard"
}, - "exemptionInsuranceObligation": {
- "key": 0,
- "value": "Geen uitzondering."
}, - "firstDayNotification": false,
- "sendMdvNotification": true,
- "periodPayGradeAdjustment": 2,
- "signalPayGradeAdjustment": false,
- "typeOfParticipation": {
- "key": 0,
- "value": "n.v.t."
}, - "valueOfParticipation": {
- "key": 0,
- "value": "n.v.t."
}, - "professionCode": 4,
- "deviatingCLATaxReturn": 2,
- "participation55plusRegulationUWV": false,
- "writtenEmploymentContract": true
}, - "workingHoursData": {
- "shift": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "deviatingHoursPerWeek": 32,
- "deviatingSvDaysPerPeriod": 32,
- "averageParttimeFactor": 37.5,
- "regularWorkPattern": true,
- "flexibleHoursContract": {
- "key": 0,
- "value": "n.v.t."
}, - "contractCode": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 1022,
- "description": "SLA-PT-met toeslagen ATW (88)"
}, - "calculateUsingWorkPattern": {
- "leaveHours": true,
- "hoursBrokenPeriod": false,
- "hoursPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "workPattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "wageData": {
- "grossWage": 23,
- "grossWageType": {
- "key": 2,
- "value": "hourly"
}, - "netWage": 1,
- "netWageType": {
- "key": 1,
- "value": "hourly"
}, - "payScale": {
- "key": 1,
- "value": "Glastuinbouw maand, Loongebouw A"
}, - "payGrade": {
- "key": 1,
- "value": "Schaal B1, 15 jaar"
}, - "applyPayGrade": true
}, - "organizationalEntityData": {
- "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Directeur",
- "group": "internal"
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "standardFunction": {
- "key": 1,
- "value": "Administrateur",
- "code": "A21",
- "category": 1
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}, - "placeOfEmployment": "Amsterdam office",
- "internalTelephoneExtensionNumber": "0133031600"
}, - "socialSecurityData": {
- "isInsuredForSicknessBenefitsAct": false,
- "isInsuredForUnemploymentInsuranceAct": false,
- "isInsuredForOccupationalDisabilityInsuranceAct": false,
- "healthCareInsuranceActType": {
- "key": 2,
- "value": "(C/K) Wel verzekeringsplichtig, normaal tarief"
}
}, - "fiscalData": {
- "annualSalary": 60000,
- "deviatingPayrollTaxTableColour": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "applyDayTables": false,
- "deviatingPayrollTaxPercentage": 27.45,
- "applyDeviatingPayrollTaxPercentageOn": {
- "key": 2,
- "value": "Afwijkend voor tabel- en tariefloon"
}, - "applyPayrollTaxDeduction": false,
- "applyStudentDeduction": false,
- "deviatingCalculationRulePayrollTax": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "residentOf": {
- "key": 2,
- "value": "Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden"
}
}, - "otherPayrollVariablesData": {
- "deviatingPremiumGroup": {
- "key": 2,
- "value": "(12) Metaal- en technische bedrijfstakken"
}
}, - "selfService": {
- "status": "HasAccessToClient",
- "clientName": "Clever"
}
}
}
Edit the details of a concept employee
Activity name : PutConceptEmployeeByConceptEmployeeId
Edit the details of a concept employee
- Possible options (metadata) for generic fields of the type "metadata" can be acquired (GET) by adding
/metadata
to the URL. - Possible options dependent on a specific payrollAdministration can be acquired via
../providers/employers/conceptemployees/metadata/payrollAdministration/{payrollAdministrationId}
. - Possible options for payGrade can be acquired via
../providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}
.
A payGrade
has time based values dictating the wage for a given period. These values can be acquired by performing another metadata request ../providers/employers/conceptemployees/metadata/payscale/{payScaleKey}/paygrade/{payGradeKey}
.
NonPayrollAdministrations For nonPayrollAdministrations the equivalent MetaData-endpoints are also available as described above. However NO specific defaults endpoint is available for the nonPayrollAdministration.
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Concept employee to edit.
uniqueName | string [ 1 .. 255 ] characters 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. |
object (employee) | |
object or null (employment) | |
object or null (workingHours) | |
object or null (wage) | |
object or null (organizationalEntity) | |
object or null (socialSecurity) | |
object or null (fiscal) | |
object or null (otherPayrollVariables) |
Responses
Request samples
- Payload
{- "uniqueName": "Sollicitant 013",
- "employeeData": {
- "employeeNumber": 156,
- "personalDetails": {
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "lastNamePartner": "Wiel",
- "prefixPartner": "van de",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "howToFormatLastName": {
- "key": 2
}, - "title": {
- "key": 2
}, - "gender": {
- "key": 2
}, - "nationality": {
- "key": 2
}, - "civilStatus": {
- "key": 2
}
}, - "contactInformation": {
- "phoneNumber": "+31 13-1234567",
- "mobilePhoneNumber": "+31 6-1231456",
- "faxNumber": "+31 13-1234561",
- "emailAddress": "[email protected]"
}, - "identityDocument": {
- "typeOfDocument": {
- "key": 2
}, - "documentIdentification": "CRE45553433"
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1
}
}, - "iban": "NL52ABNA0424968264"
}, - "employmentData": {
- "startDate": "2019-01-01",
- "historicalStartDate": "2012-05-01",
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "nonPayrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "commissionUntilDate": "2019-01-01",
- "incomeRelationshipNumber": 12,
- "employeeProfileId": {
- "key": 1
}, - "employmentDurationType": {
- "key": 1
}, - "startDateContractOfIndefiniteDuration": "2018-05-08",
- "employmentContractType": {
- "key": 1
}, - "typeOfEmployee": {
- "key": 1
}, - "cancellationPeriodEmployee": 1,
- "cancellationPeriodEmployer": 1,
- "cancellationPeriodTimeUnit": {
- "key": 4
}, - "cancellationNoticeDate": "2019-05-31",
- "startCancellationNoticePeriod": "2019-06-01",
- "isDirectorAndMajorShareholder": false,
- "isOnCallEmployment": true,
- "hasOnCallAppearanceObligation": true,
- "vacationCoupons": {
- "key": 1
}, - "specialIncomeRatio": {
- "key": 0
}, - "isAnonymousEmployee": true,
- "isPreviousOwner": false,
- "isFamilyOfOwner": false,
- "isGemoedsbezwaardNationalInsurance": true,
- "isGemoedsbezwaardEmployeeInsurance": true,
- "namePayslip": "Steve Jobs",
- "calculateWorkingHours": true,
- "essMutationSet": {
- "key": 1
}, - "exemptionInsuranceObligation": {
- "key": 0
}, - "sendMdvNotification": true,
- "periodPayGradeAdjustment": 2,
- "signalPayGradeAdjustment": false,
- "typeOfParticipation": {
- "key": 0
}, - "valueOfParticipation": {
- "key": 0
}, - "professionCode": 4,
- "deviatingCLATaxReturn": 2,
- "participation55plusRegulationUWV": false,
- "writtenEmploymentContract": true
}, - "workingHoursData": {
- "shift": {
- "shiftNumber": 1
}, - "deviatingHoursPerWeek": 32,
- "deviatingSvDaysPerPeriod": 32,
- "averageParttimeFactor": 37.5,
- "regularWorkPattern": true,
- "flexibleHoursContract": {
- "key": 0
}, - "contractCode": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "calculateUsingWorkPattern": {
- "leaveHours": true,
- "hoursBrokenPeriod": false,
- "hoursPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "workPattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "wageData": {
- "grossWage": 23,
- "grossWageType": {
- "key": 2
}, - "netWage": 1,
- "netWageType": { },
- "payScale": { },
- "payGrade": { },
- "applyPayGrade": true
}, - "organizationalEntityData": {
- "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "standardFunction": {
- "key": 1
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "placeOfEmployment": "Amsterdam office",
- "internalTelephoneExtensionNumber": "0133031600"
}, - "socialSecurityData": {
- "isInsuredForSicknessBenefitsAct": false,
- "isInsuredForUnemploymentInsuranceAct": false,
- "isInsuredForOccupationalDisabilityInsuranceAct": false,
- "healthCareInsuranceActType": {
- "key": 2
}
}, - "fiscalData": {
- "annualSalary": 60000,
- "deviatingPayrollTaxTableColour": {
- "key": 2
}, - "applyDayTables": false,
- "applyDeviatingPayrollTaxPercentageOn": {
- "key": 2
}, - "applyPayrollTaxDeduction": false,
- "applyStudentDeduction": false,
- "deviatingCalculationRulePayrollTax": {
- "key": 2
}, - "residentOf": {
- "key": 2
}
}, - "otherPayrollVariablesData": {
- "deviatingPremiumGroup": {
- "key": 2
}
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "uniqueName": "Sollicitant 013",
- "creationDate": "2018-05-08",
- "employeeData": {
- "employeeNumber": 156,
- "personalDetails": {
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "lastNamePartner": "Wiel",
- "prefixPartner": "van de",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "howToFormatLastName": {
- "key": 2,
- "value": "last name + last name partner"
}, - "title": {
- "key": 2,
- "value": "e.g. Msc, PHD or Baron"
}, - "gender": {
- "key": 2,
- "value": "female"
}, - "nationality": {
- "key": 2,
- "value": "Dutch"
}, - "civilStatus": {
- "key": 2,
- "value": "Married"
}
}, - "contactInformation": {
- "phoneNumber": "+31 13-1234567",
- "mobilePhoneNumber": "+31 6-1231456",
- "faxNumber": "+31 13-1234561",
- "emailAddress": "[email protected]"
}, - "identityDocument": {
- "typeOfDocument": {
- "key": 2,
- "value": "Passport"
}, - "documentIdentification": "CRE45553433"
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "iban": "NL52ABNA0424968264"
}, - "employmentData": {
- "startDate": "2019-01-01",
- "historicalStartDate": "2012-05-01",
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker"
}, - "nonPayrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "description": "Bakker"
}, - "commissionUntilDate": "2019-01-01",
- "incomeRelationshipNumber": 12,
- "employeeProfileId": {
- "key": 1,
- "value": "Profiel full-timers"
}, - "employmentDurationType": {
- "key": 1,
- "value": "Contract of indefinite duration"
}, - "startDateContractOfIndefiniteDuration": "2018-05-08",
- "employmentContractType": {
- "key": 1,
- "value": "Labor agreement"
}, - "typeOfEmployee": {
- "key": 1,
- "value": "Werknemer"
}, - "cancellationPeriodEmployee": 1,
- "cancellationPeriodEmployer": 1,
- "cancellationPeriodTimeUnit": {
- "key": 4,
- "value": "Maand(en)"
}, - "cancellationNoticeDate": "2019-05-31",
- "startCancellationNoticePeriod": "2019-06-01",
- "isDirectorAndMajorShareholder": false,
- "isOnCallEmployment": true,
- "hasOnCallAppearanceObligation": true,
- "vacationCoupons": {
- "key": 1,
- "value": "n.v.t."
}, - "specialIncomeRatio": {
- "key": 0,
- "value": "n.v.t."
}, - "isAnonymousEmployee": true,
- "isPreviousOwner": false,
- "isFamilyOfOwner": false,
- "isGemoedsbezwaardNationalInsurance": true,
- "isGemoedsbezwaardEmployeeInsurance": true,
- "namePayslip": "Steve Jobs",
- "calculateWorkingHours": true,
- "essMutationSet": {
- "key": 1,
- "value": "Standaard"
}, - "exemptionInsuranceObligation": {
- "key": 0,
- "value": "Geen uitzondering."
}, - "firstDayNotification": false,
- "sendMdvNotification": true,
- "periodPayGradeAdjustment": 2,
- "signalPayGradeAdjustment": false,
- "typeOfParticipation": {
- "key": 0,
- "value": "n.v.t."
}, - "valueOfParticipation": {
- "key": 0,
- "value": "n.v.t."
}, - "professionCode": 4,
- "deviatingCLATaxReturn": 2,
- "participation55plusRegulationUWV": false,
- "writtenEmploymentContract": true
}, - "workingHoursData": {
- "shift": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "deviatingHoursPerWeek": 32,
- "deviatingSvDaysPerPeriod": 32,
- "averageParttimeFactor": 37.5,
- "regularWorkPattern": true,
- "flexibleHoursContract": {
- "key": 0,
- "value": "n.v.t."
}, - "contractCode": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 1022,
- "description": "SLA-PT-met toeslagen ATW (88)"
}, - "calculateUsingWorkPattern": {
- "leaveHours": true,
- "hoursBrokenPeriod": false,
- "hoursPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "workPattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "wageData": {
- "grossWage": 23,
- "grossWageType": {
- "key": 2,
- "value": "hourly"
}, - "netWage": 1,
- "netWageType": {
- "key": 1,
- "value": "hourly"
}, - "payScale": {
- "key": 1,
- "value": "Glastuinbouw maand, Loongebouw A"
}, - "payGrade": {
- "key": 1,
- "value": "Schaal B1, 15 jaar"
}, - "applyPayGrade": true
}, - "organizationalEntityData": {
- "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Directeur",
- "group": "internal"
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "standardFunction": {
- "key": 1,
- "value": "Administrateur",
- "code": "A21",
- "category": 1
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}, - "placeOfEmployment": "Amsterdam office",
- "internalTelephoneExtensionNumber": "0133031600"
}, - "socialSecurityData": {
- "isInsuredForSicknessBenefitsAct": false,
- "isInsuredForUnemploymentInsuranceAct": false,
- "isInsuredForOccupationalDisabilityInsuranceAct": false,
- "healthCareInsuranceActType": {
- "key": 2,
- "value": "(C/K) Wel verzekeringsplichtig, normaal tarief"
}
}, - "fiscalData": {
- "annualSalary": 60000,
- "deviatingPayrollTaxTableColour": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "applyDayTables": false,
- "deviatingPayrollTaxPercentage": 27.45,
- "applyDeviatingPayrollTaxPercentageOn": {
- "key": 2,
- "value": "Afwijkend voor tabel- en tariefloon"
}, - "applyPayrollTaxDeduction": false,
- "applyStudentDeduction": false,
- "deviatingCalculationRulePayrollTax": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "residentOf": {
- "key": 2,
- "value": "Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden"
}
}, - "otherPayrollVariablesData": {
- "deviatingPremiumGroup": {
- "key": 2,
- "value": "(12) Metaal- en technische bedrijfstakken"
}
}, - "selfService": {
- "status": "HasAccessToClient",
- "clientName": "Clever"
}
}
}
Delete a concept employee
Activity name : DeleteConceptEmployeeByConceptEmployeeId
Delete a concept employee
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
query Parameters
deleteDocuments | boolean If true, all underlying documents will be deleted. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Citizen service number of a concept employee
Activity name : GetCitizenServiceNumberByConceptEmployeeId
Get the citizen service number (BSN) of a concept employee. BSN is separately authorized in Loket and is therefore designed to have its own activities.
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": "042168588"
}
Update the citizen service number of a concept employee
Activity name : PutCitizenServiceNumberByConceptEmployeeId
Update the citizen service number (BSN) of a concept employee BSN is separately authorized in Loket and is therefore designed to have its own activities.
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
citizen service number to edit.
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).
Responses
Request samples
- Payload
"042168588"
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": "042168588"
}
Convert a concept employee to an employee
Activity name : PatchConvertToEmployeeByConceptEmployeeId
This endpoint "converts" the conceptEmployee to an actual employee in Loket. This means creating a number of records including Employee, Employment, WorkingHours, Wage etc. If the promotion is successful the concept employee record will be deleted.
The GUID of the conceptEmployee will be copied over to the GUID of the newly created Employee.
Before performing these steps, quite a number of validations are performed to ensure that the provided information can be used to create a functionally valid employee.
If the employeeNumber is empty then this will be set automatically for the employee. (i.e. highest available number +1)
Additional functionality :
- It is possible to call an alternative functionality closely related to this functionality. This additional functionality will perform the validation ONLY, and it will NOT convert the conceptEmployee to an actual employee even when all validation rules are successful. Other than not performing the actual step of converting the employee the endpoint will behave identically to the actual endpoint.
- This functionality can be applied by setting the optional X-ValidateOnly header to true
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
X-ValidateOnly | boolean If set to true only the validations will be performed no changes will be committed. |
Responses
Response samples
- 200
- 400
- 401
- 403
{ }
NL: Ziekmelding. Absences due to either sickness/illness or absence due to, for example, maternity or organ donation (in Dutch 'vangnet').
Please note: when adding or updating an Absence or AbsenceProgress there will be no additional 'Melding' created in Loket.nl . This legacy mechanism in the older Loket GUI will NOT be included in the newer version of Loket.nl
List of absences for an employee
Activity name : GetAbsencesByEmployeeId
Get a list of all absences for the given employee
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "causeOfAbsence": {
- "key": 1,
- "value": "maternity leave"
}, - "hoursWorkedOnFirstDayOfAbsence": 3,
- "actionToBeTakenByOccupationalHealthAndSafetyService": {
- "key": 1,
- "value": "Spoedcontrole aan huis"
}, - "expectedDuration": {
- "key": 1,
- "value": "Minder dan 1 week"
}, - "isDisruptedEmploymentRelationship": true,
- "isThirdPartyLiability": false,
- "accidentType": {
- "key": 1,
- "value": "work related accident"
}, - "isWorkRelatedIllness": false,
- "expectedDateOfChildbirth": "2018-01-21",
- "expectedEndDateOfMaternityLeave": "2018-04-21",
- "hasMobilityIssue": false,
- "isRecoveredWithinTwoWeeks": false,
- "comments": "Lorem ipsum dolor sit amet, id nibh adhuc omnium vix, ne nec eius inani aliquip.",
- "isHospitalised": false,
- "contactInformation": {
- "startDate": "2018-01-21",
- "endDate": "2019-08-24",
- "locationType": {
- "key": 1,
- "value": "Hospital"
}, - "name": "RadboudUMC Nijmegen",
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}, - "phoneNumber": "+31 13-1234567"
}, - "caseManager": {
- "name": "Ben Hur",
- "function": "Ben Hur",
- "organization": "Ben Hur",
- "phoneNumber": "+31 13-1234567"
}, - "reintegration": {
- "reintegrationGoal": {
- "key": 1,
- "value": "Werkhervatting in de eigen functie"
}, - "dateOfFinalizingPlanOfAction": "2019-08-24"
}, - "progress": {
- "startDate": "2018-01-21",
- "endOfAbsence": {
- "date": "2019-08-24",
- "reason": {
- "key": 1,
- "value": "Fully recoverd"
}
}, - "currentIncapacityPercentage": 100
}
}
]
}
Create an Absence for an employee
Activity name : PostAbsenceByEmployeeId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the POST URL.
Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.
Add an Absence (=verzuimmelding) for an employee.
Please note that if this endpoint is called successfully both an absence (=verzuimmelding) AND one underlying absence progress (=verzuimverloop) will be created.
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2020-03-16required
Add an Absence for an employee.
object <metadata> (causeOfAbsence) The cause of the absence. This endpoint is intended for the registration of two types of absence:
Other absences such as Vacation days, unpayed leave and Personal leave are registerd using the leave endpoint | |
hoursWorkedOnFirstDayOfAbsence | integer or null (hoursWorkedOnFirstDayOfAbsence) [ 1 .. 8 ] The number of hours worked on the first day of the absence. |
object <metadata> (actionToBeTakenByOccupationalHealthAndSafetyService) The desired action to be taken regarding the absence by the occupational health and safety service (arbodienst). | |
object or null <metadata> (expectedDuration) The expected duration of the absence. If the expected duration is unknown, this field will be NULL. | |
isDisruptedEmploymentRelationship | boolean (isDisruptedEmploymentRelationship) Indicates whether the employement relationship between employee and employer is disrupted. |
isThirdPartyLiability | boolean or null (isThirdPartyLiability) This field is related to |
object or null <metadata> (accidentType) The type of accident that led to the absence. This field will be NULL if the absence is not related to an accident. | |
isWorkRelatedIllness | boolean (isWorkRelatedIllness) Beroepsziekte |
expectedDateOfChildbirth | string or null <date> (expectedDateOfChildbirth) Bevallingsdatum |
expectedEndDateOfMaternityLeave | string or null <date> (expectedEndDateOfMaternityLeave) verwachte datum einde zwangerschapsverlof |
hasMobilityIssue | boolean or null (hasMobilityIssue) This field indicates whether the Employee has an issue limiting its mobility. |
isRecoveredWithinTwoWeeks | boolean (isRecoveredWithinTwoWeeks) This field indicates whether the Employee is (expected) recoverd within two weeks, relating to a full recovery. |
comments | string or null (comments) <= 4000 characters Free text field to register any relevant information. |
isHospitalised | boolean or null (isHospitalised) Betreft het een ziekenhuisopnamen |
object or null (contactInformation) | |
object or null (caseManager) | |
object or null (reintegration) | |
object |
Responses
Request samples
- Payload
{- "causeOfAbsence": {
- "key": 1
}, - "hoursWorkedOnFirstDayOfAbsence": 3,
- "actionToBeTakenByOccupationalHealthAndSafetyService": {
- "key": 1
}, - "expectedDuration": {
- "key": 1
}, - "isDisruptedEmploymentRelationship": true,
- "isThirdPartyLiability": false,
- "accidentType": {
- "key": 1
}, - "isWorkRelatedIllness": false,
- "expectedDateOfChildbirth": "2018-01-21",
- "expectedEndDateOfMaternityLeave": "2018-04-21",
- "hasMobilityIssue": false,
- "isRecoveredWithinTwoWeeks": false,
- "comments": "Lorem ipsum dolor sit amet, id nibh adhuc omnium vix, ne nec eius inani aliquip.",
- "isHospitalised": false,
- "contactInformation": {
- "startDate": "2018-01-21",
- "endDate": "2019-08-24",
- "locationType": {
- "key": 1
}, - "name": "RadboudUMC Nijmegen",
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1
}, - "postalCode": "1234 AA",
- "country": {
- "key": 1
}, - "phoneNumber": "+31 13-1234567"
}, - "caseManager": {
- "name": "Ben Hur",
- "function": "Ben Hur",
- "organization": "Ben Hur",
- "phoneNumber": "+31 13-1234567"
}, - "reintegration": {
- "reintegrationGoal": {
- "key": 1
}, - "dateOfFinalizingPlanOfAction": "2019-08-24"
}, - "progress": {
- "startDate": "2018-01-21",
- "currentIncapacityPercentage": 100
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "causeOfAbsence": {
- "key": 1,
- "value": "maternity leave"
}, - "hoursWorkedOnFirstDayOfAbsence": 3,
- "actionToBeTakenByOccupationalHealthAndSafetyService": {
- "key": 1,
- "value": "Spoedcontrole aan huis"
}, - "expectedDuration": {
- "key": 1,
- "value": "Minder dan 1 week"
}, - "isDisruptedEmploymentRelationship": true,
- "isThirdPartyLiability": false,
- "accidentType": {
- "key": 1,
- "value": "work related accident"
}, - "isWorkRelatedIllness": false,
- "expectedDateOfChildbirth": "2018-01-21",
- "expectedEndDateOfMaternityLeave": "2018-04-21",
- "hasMobilityIssue": false,
- "isRecoveredWithinTwoWeeks": false,
- "comments": "Lorem ipsum dolor sit amet, id nibh adhuc omnium vix, ne nec eius inani aliquip.",
- "isHospitalised": false,
- "contactInformation": {
- "startDate": "2018-01-21",
- "endDate": "2019-08-24",
- "locationType": {
- "key": 1,
- "value": "Hospital"
}, - "name": "RadboudUMC Nijmegen",
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}, - "phoneNumber": "+31 13-1234567"
}, - "caseManager": {
- "name": "Ben Hur",
- "function": "Ben Hur",
- "organization": "Ben Hur",
- "phoneNumber": "+31 13-1234567"
}, - "reintegration": {
- "reintegrationGoal": {
- "key": 1,
- "value": "Werkhervatting in de eigen functie"
}, - "dateOfFinalizingPlanOfAction": "2019-08-24"
}, - "progress": {
- "startDate": "2018-01-21",
- "endOfAbsence": {
- "date": "2019-08-24",
- "reason": {
- "key": 1,
- "value": "Fully recoverd"
}
}, - "currentIncapacityPercentage": 100
}
}
}
Download the absence overview for an employee
Activity name : GetAbsenceOverviewByEmployeeId
Download the absence overview (verzuim) for a given time frame
Metadata : No metadata
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
query Parameters
startDate required | stringdate Example: startDate=2020-08-01 The start date |
endDate required | stringdate Example: endDate=2020-08-31 The end date |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Details of an Absence
Activity name : GetAbsenceByAbsenceId
Get the details of an Absence
path Parameters
absenceId required | string <uuid> The unique identifier of an absence |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "causeOfAbsence": {
- "key": 1,
- "value": "maternity leave"
}, - "hoursWorkedOnFirstDayOfAbsence": 3,
- "actionToBeTakenByOccupationalHealthAndSafetyService": {
- "key": 1,
- "value": "Spoedcontrole aan huis"
}, - "expectedDuration": {
- "key": 1,
- "value": "Minder dan 1 week"
}, - "isDisruptedEmploymentRelationship": true,
- "isThirdPartyLiability": false,
- "accidentType": {
- "key": 1,
- "value": "work related accident"
}, - "isWorkRelatedIllness": false,
- "expectedDateOfChildbirth": "2018-01-21",
- "expectedEndDateOfMaternityLeave": "2018-04-21",
- "hasMobilityIssue": false,
- "isRecoveredWithinTwoWeeks": false,
- "comments": "Lorem ipsum dolor sit amet, id nibh adhuc omnium vix, ne nec eius inani aliquip.",
- "isHospitalised": false,
- "contactInformation": {
- "startDate": "2018-01-21",
- "endDate": "2019-08-24",
- "locationType": {
- "key": 1,
- "value": "Hospital"
}, - "name": "RadboudUMC Nijmegen",
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}, - "phoneNumber": "+31 13-1234567"
}, - "caseManager": {
- "name": "Ben Hur",
- "function": "Ben Hur",
- "organization": "Ben Hur",
- "phoneNumber": "+31 13-1234567"
}, - "reintegration": {
- "reintegrationGoal": {
- "key": 1,
- "value": "Werkhervatting in de eigen functie"
}, - "dateOfFinalizingPlanOfAction": "2019-08-24"
}, - "progress": {
- "startDate": "2018-01-21",
- "endOfAbsence": {
- "date": "2019-08-24",
- "reason": {
- "key": 1,
- "value": "Fully recoverd"
}
}, - "currentIncapacityPercentage": 100
}
}
}
Edit the details of a Absence
Activity name : PutAbsenceByAbsenceId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
Edit the details of am Absence
path Parameters
absenceId required | string <uuid> The unique identifier of an absence |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2020-03-16required
Absence to edit.
object <metadata> (causeOfAbsence) The cause of the absence. This endpoint is intended for the registration of two types of absence:
Other absences such as Vacation days, unpayed leave and Personal leave are registerd using the leave endpoint | |
hoursWorkedOnFirstDayOfAbsence | integer or null (hoursWorkedOnFirstDayOfAbsence) [ 1 .. 8 ] The number of hours worked on the first day of the absence. |
object <metadata> (actionToBeTakenByOccupationalHealthAndSafetyService) The desired action to be taken regarding the absence by the occupational health and safety service (arbodienst). | |
object or null <metadata> (expectedDuration) The expected duration of the absence. If the expected duration is unknown, this field will be NULL. | |
isDisruptedEmploymentRelationship | boolean (isDisruptedEmploymentRelationship) Indicates whether the employement relationship between employee and employer is disrupted. |
isThirdPartyLiability | boolean or null (isThirdPartyLiability) This field is related to |
object or null <metadata> (accidentType) The type of accident that led to the absence. This field will be NULL if the absence is not related to an accident. | |
isWorkRelatedIllness | boolean (isWorkRelatedIllness) Beroepsziekte |
expectedDateOfChildbirth | string or null <date> (expectedDateOfChildbirth) Bevallingsdatum |
expectedEndDateOfMaternityLeave | string or null <date> (expectedEndDateOfMaternityLeave) verwachte datum einde zwangerschapsverlof |
hasMobilityIssue | boolean or null (hasMobilityIssue) This field indicates whether the Employee has an issue limiting its mobility. |
isRecoveredWithinTwoWeeks | boolean (isRecoveredWithinTwoWeeks) This field indicates whether the Employee is (expected) recoverd within two weeks, relating to a full recovery. |
comments | string or null (comments) <= 4000 characters Free text field to register any relevant information. |
isHospitalised | boolean or null (isHospitalised) Betreft het een ziekenhuisopnamen |
object or null (contactInformation) | |
object or null (caseManager) | |
object or null (reintegration) |
Responses
Request samples
- Payload
{- "causeOfAbsence": {
- "key": 1
}, - "hoursWorkedOnFirstDayOfAbsence": 3,
- "actionToBeTakenByOccupationalHealthAndSafetyService": {
- "key": 1
}, - "expectedDuration": {
- "key": 1
}, - "isDisruptedEmploymentRelationship": true,
- "isThirdPartyLiability": false,
- "accidentType": {
- "key": 1
}, - "isWorkRelatedIllness": false,
- "expectedDateOfChildbirth": "2018-01-21",
- "expectedEndDateOfMaternityLeave": "2018-04-21",
- "hasMobilityIssue": false,
- "isRecoveredWithinTwoWeeks": false,
- "comments": "Lorem ipsum dolor sit amet, id nibh adhuc omnium vix, ne nec eius inani aliquip.",
- "isHospitalised": false,
- "contactInformation": {
- "startDate": "2018-01-21",
- "endDate": "2019-08-24",
- "locationType": {
- "key": 1
}, - "name": "RadboudUMC Nijmegen",
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1
}, - "postalCode": "1234 AA",
- "country": {
- "key": 1
}, - "phoneNumber": "+31 13-1234567"
}, - "caseManager": {
- "name": "Ben Hur",
- "function": "Ben Hur",
- "organization": "Ben Hur",
- "phoneNumber": "+31 13-1234567"
}, - "reintegration": {
- "reintegrationGoal": {
- "key": 1
}, - "dateOfFinalizingPlanOfAction": "2019-08-24"
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "causeOfAbsence": {
- "key": 1,
- "value": "maternity leave"
}, - "hoursWorkedOnFirstDayOfAbsence": 3,
- "actionToBeTakenByOccupationalHealthAndSafetyService": {
- "key": 1,
- "value": "Spoedcontrole aan huis"
}, - "expectedDuration": {
- "key": 1,
- "value": "Minder dan 1 week"
}, - "isDisruptedEmploymentRelationship": true,
- "isThirdPartyLiability": false,
- "accidentType": {
- "key": 1,
- "value": "work related accident"
}, - "isWorkRelatedIllness": false,
- "expectedDateOfChildbirth": "2018-01-21",
- "expectedEndDateOfMaternityLeave": "2018-04-21",
- "hasMobilityIssue": false,
- "isRecoveredWithinTwoWeeks": false,
- "comments": "Lorem ipsum dolor sit amet, id nibh adhuc omnium vix, ne nec eius inani aliquip.",
- "isHospitalised": false,
- "contactInformation": {
- "startDate": "2018-01-21",
- "endDate": "2019-08-24",
- "locationType": {
- "key": 1,
- "value": "Hospital"
}, - "name": "RadboudUMC Nijmegen",
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}, - "phoneNumber": "+31 13-1234567"
}, - "caseManager": {
- "name": "Ben Hur",
- "function": "Ben Hur",
- "organization": "Ben Hur",
- "phoneNumber": "+31 13-1234567"
}, - "reintegration": {
- "reintegrationGoal": {
- "key": 1,
- "value": "Werkhervatting in de eigen functie"
}, - "dateOfFinalizingPlanOfAction": "2019-08-24"
}, - "progress": {
- "startDate": "2018-01-21",
- "endOfAbsence": {
- "date": "2019-08-24",
- "reason": {
- "key": 1,
- "value": "Fully recoverd"
}
}, - "currentIncapacityPercentage": 100
}
}
}
Delete a specific absence record
Activity name : DeleteAbsenceByAbsenceId
Delete an existing absence (for an employee). If successful, this function also deletes the underlying absence progress records
path Parameters
absenceId required | string <uuid> The unique identifier of an absence |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Close an absence
Activity name : PatchCloseAbsenceByAbsenceId
A successful call to this endpoint will close the absence and the underlying absence progress (with an empty endDate).
path Parameters
absenceId required | string <uuid> The unique identifier of an absence |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2020-03-16required
The request body contains an object containing fields related to closing of an absence.
object <metadata> date and reason for the closing/end of the absence |
Responses
Request samples
- Payload
{- "endOfAbsence": {
- "date": "2019-08-24",
- "reason": {
- "key": 1
}
}
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Reopen an absence
Activity name : PatchReopenAbsenceByAbsenceId
When performing a successful call to this endpoint, then the absence and the underlying absence progress will we reopend.
Both endOfAbsenceDate
and endOfAbsenceReason
will be set to null
path Parameters
absenceId required | string <uuid> The unique identifier of an absence |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2020-03-16required
Responses
Request samples
- Payload
{ }
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
basic absence statistics
Activity name : GetAbsenceStatisticsDataByEmployerId
Get a basic overview of absence statistics for all employees of the given employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
startYearMonth required | string Example: startYearMonth=202401 The start year and month of the absence overview |
endYearMonth required | string Example: endYearMonth=202412 The end year and month of the absence overview |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "clientNumber": 1234,
- "employeeNumber": 14,
- "incomeRelationshipNumber": 1,
- "formattedName": "Bos B",
- "year": 2024,
- "month": 2024,
- "department": "Procurement",
- "function": "Manager",
- "percentageWeightedAbsenteeism": 2400,
- "percentageWeightedAbsenteeismShort": 2400,
- "percentageWeightedAbsenteeismMedium": 2400,
- "percentageWeightedAbsenteeismLong": 2400
}
]
}
NL: Ziekteverloop. Absences due to either sickness/illness or absence due to, for example, maternity or organ donation (in Dutch 'vangnet'). One Absence contains one or more AbsenceProgress, indicating the degree of occupational disability over time of the absence.
Please note: when adding or updating an Absence or AbsenceProgress there will be no additional 'Melding' created in Loket.nl . This legacy mechanism in the older Loket GUI will NOT be included in the newer version of Loket.nl
List of absence progress for an absence
Activity name : GetAbsenceProgressByAbsenceId
Get a list of absence progress (verzuimverloop) for a specific absence (verzuimmelding).
path Parameters
absenceId required | string <uuid> The unique identifier of an absence |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-21",
- "endDate": "2019-08-24",
- "incapacityPercentage": 100,
- "typeOfWorkResumption": {
- "key": 2,
- "value": "Eigen werk met aanpassing"
}, - "comments": "Lorem ipsum dolor sit amet, id nibh adhuc omnium vix, ne nec eius inani aliquip."
}
]
}
Create an Absence Progress for an Absence
Activity name : PostAbsenceProgressByAbsenceId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the POST URL.
Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.
Add an Absence Progress (=Ziekteverloop) for an employee. As is common with closed chain entities, the endDate of the previous record will be filled depending on the startDate of the new one.
Practically this means that a full recovery notification has been performed.
path Parameters
absenceId required | string <uuid> The unique identifier of an absence |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2020-03-16required
Add an Absence Progress for an Absence.
startDate | string <date> start dat of the incapacityPercentage |
incapacityPercentage | integer [ 1 .. 100 ] percentage of not being able to work |
object or null <metadata> The type of work the work the employee is fulfilling when partly returning to work. | |
comments | string or null <= 4000 characters Free text field to register any relevant information. |
Responses
Request samples
- Payload
{- "startDate": "2018-01-21",
- "incapacityPercentage": 100,
- "typeOfWorkResumption": {
- "key": 2
}, - "comments": "Lorem ipsum dolor sit amet, id nibh adhuc omnium vix, ne nec eius inani aliquip."
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-21",
- "endDate": "2019-08-24",
- "incapacityPercentage": 100,
- "typeOfWorkResumption": {
- "key": 2,
- "value": "Eigen werk met aanpassing"
}, - "comments": "Lorem ipsum dolor sit amet, id nibh adhuc omnium vix, ne nec eius inani aliquip."
}
}
Details of an Absence Progress
Activity name : GetAbsenceProgressByAbsenceProgressId
Get the details of an Absence Progress
path Parameters
absenceProgressId required | string <uuid> The unique identifier of an absence progress |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-21",
- "endDate": "2019-08-24",
- "incapacityPercentage": 100,
- "typeOfWorkResumption": {
- "key": 2,
- "value": "Eigen werk met aanpassing"
}, - "comments": "Lorem ipsum dolor sit amet, id nibh adhuc omnium vix, ne nec eius inani aliquip."
}
}
Edit the details of an absence progress
Activity name : PutAbsenceProgressByAbsenceProgressId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
Edit the details of an absence progress
path Parameters
absenceProgressId required | string <uuid> The unique identifier of an absence progress |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2020-03-16required
Absence progress to edit.
startDate | string <date> start dat of the incapacityPercentage |
incapacityPercentage | integer [ 1 .. 100 ] percentage of not being able to work |
object or null <metadata> The type of work the work the employee is fulfilling when partly returning to work. | |
comments | string or null <= 4000 characters Free text field to register any relevant information. |
Responses
Request samples
- Payload
{- "startDate": "2018-01-21",
- "incapacityPercentage": 100,
- "typeOfWorkResumption": {
- "key": 2
}, - "comments": "Lorem ipsum dolor sit amet, id nibh adhuc omnium vix, ne nec eius inani aliquip."
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-21",
- "endDate": "2019-08-24",
- "incapacityPercentage": 100,
- "typeOfWorkResumption": {
- "key": 2,
- "value": "Eigen werk met aanpassing"
}, - "comments": "Lorem ipsum dolor sit amet, id nibh adhuc omnium vix, ne nec eius inani aliquip."
}
}
Delete a specific Absence Progress record
Activity name : DeleteAbsenceProgressByAbsenceProgressId
Delete an existing Absence Progress (for an employee). There always has to remain one record of absence progress for an absence. This last record is removed when the absence is deleted.
path Parameters
absenceProgressId required | string <uuid> The unique identifier of an absence progress |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Contact history for an absence
Activity name : GetAbsenceContactHistoryByAbsenceId
Get the contacts history for a specific absence (verzuimmelding).
path Parameters
absenceId required | string <uuid> The unique identifier of an absence |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "contactDate": "2018-01-01",
- "contactMethod": {
- "key": 1,
- "value": "e-mail"
}, - "summary": "string"
}
]
}
Create a contact history for an Absence
Activity name : PostAbsenceContactHistoryByAbsenceId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the POST URL.
Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.
path Parameters
absenceId required | string <uuid> The unique identifier of an absence |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a record to the contact history for an absence.
contactDate | string <date> The date on which the contact was initiated. |
object <metadata> The method of contacting the person | |
summary | string or null [ 1 .. 4000 ] characters Summary of the contact. |
Responses
Request samples
- Payload
{- "contactDate": "2018-01-01",
- "contactMethod": {
- "key": 1
}, - "summary": "string"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "contactDate": "2018-01-01",
- "contactMethod": {
- "key": 1,
- "value": "e-mail"
}, - "summary": "string"
}
}
Details of a contact history
Activity name : GetAbsenceContactHistoryByAbsenceContactHistoryId
Get the details of a contact
path Parameters
absencecontactHistoryId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "contactDate": "2018-01-01",
- "contactMethod": {
- "key": 1,
- "value": "e-mail"
}, - "summary": "string"
}
}
Edit the details of a contact history
Activity name : PutAbsenceContactHistoryByAbsenceContactHistoryId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
Edit the details of a contact history
path Parameters
absencecontactHistoryId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2020-03-16required
Absence progress to edit.
contactDate | string <date> The date on which the contact was initiated. |
object <metadata> The method of contacting the person | |
summary | string or null [ 1 .. 4000 ] characters Summary of the contact. |
Responses
Request samples
- Payload
{- "contactDate": "2018-01-01",
- "contactMethod": {
- "key": 1
}, - "summary": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "contactDate": "2018-01-01",
- "contactMethod": {
- "key": 1,
- "value": "e-mail"
}, - "summary": "string"
}
}
Delete a specific record
Activity name : DeleteAbsenceContactHistoryByAbsenceContactHistoryId
Delete an existing record from the contact history
path Parameters
absencecontactHistoryId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
NL: WerknemerZVW. The configuration of the Healthcare Insurance Act indications determines the calculation of the premiums in the payroll calculation processes for this employment
List of Healthcare Insurance Act records for an employment
Activity name: GetHealthcareInsuranceActConfigurationsByEmploymentId
Get the list of Healthcare Insurance Act configuration records for an employment
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "healthcareInsuranceActType": {
- "key": 2,
- "value": "(C/K) Wel verzekeringsplichtig, normaal tarief"
}, - "additionalContributionEmployer": 320,
- "nominalPremium": 320,
- "additionalPremium": 120
}
]
}
Create a Healthcare Insurance Act record for an employment
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.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Healthcare Insurance Act record to add to the employment.
startDate | string <date> The start date of the entity. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. |
object <metadata> Indicates what type of Health Care Insurance Act (Zvw) is applicable for this employment | |
additionalContributionEmployer | number or null <double> [ 0.01 .. 9999.99 ] ^(\d{1,4})(\.\d{1,2})?$ If applicable, please enter any additional contribution (extra bijdrage werkgever) for the employer in relation to the Healthcare Insurance Act (Zorgverzekeringswet). |
nominalPremium | number or null <double> [ 0.01 .. 9999.99 ] ^(\d{1,4})(\.\d{1,2})?$ A nominal premium (nominale premie) for the Healthcare Insurance Act may be registered here, if applicable. |
additionalPremium | number or null <double> [ 0.01 .. 9999.99 ] ^(\d{1,4})(\.\d{1,2})?$ Additional premium (aanvullende premie) on top of the nomial premium may be registered here, if applicable. |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "healthcareInsuranceActType": {
- "key": 2
}, - "additionalContributionEmployer": 320,
- "nominalPremium": 320,
- "additionalPremium": 120
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "healthcareInsuranceActType": {
- "key": 2,
- "value": "(C/K) Wel verzekeringsplichtig, normaal tarief"
}, - "additionalContributionEmployer": 320,
- "nominalPremium": 320,
- "additionalPremium": 120
}
}
Details of a Healthcare Insurance Act record
Activity name: GetHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId
Get the details of a Healthcare Insurance Act configuration record
path Parameters
healthcareInsuranceActConfigurationId required | string <uuid> The unique identifier of the Healthcare Insurance Act record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "healthcareInsuranceActType": {
- "key": 2,
- "value": "(C/K) Wel verzekeringsplichtig, normaal tarief"
}, - "additionalContributionEmployer": 320,
- "nominalPremium": 320,
- "additionalPremium": 120
}
}
Edit the details of a Healthcare Insurance Act record
Activity name: PutHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId
Edit the details for a Healthcare Insurance Act record
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
path Parameters
healthcareInsuranceActConfigurationId required | string <uuid> The unique identifier of the Healthcare Insurance Act record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Healthcare Insurance Act record to edit.
startDate | string <date> The start date of the entity. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. |
object <metadata> Indicates what type of Health Care Insurance Act (Zvw) is applicable for this employment | |
additionalContributionEmployer | number or null <double> [ 0.01 .. 9999.99 ] ^(\d{1,4})(\.\d{1,2})?$ If applicable, please enter any additional contribution (extra bijdrage werkgever) for the employer in relation to the Healthcare Insurance Act (Zorgverzekeringswet). |
nominalPremium | number or null <double> [ 0.01 .. 9999.99 ] ^(\d{1,4})(\.\d{1,2})?$ A nominal premium (nominale premie) for the Healthcare Insurance Act may be registered here, if applicable. |
additionalPremium | number or null <double> [ 0.01 .. 9999.99 ] ^(\d{1,4})(\.\d{1,2})?$ Additional premium (aanvullende premie) on top of the nomial premium may be registered here, if applicable. |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "healthcareInsuranceActType": {
- "key": 2
}, - "additionalContributionEmployer": 320,
- "nominalPremium": 320,
- "additionalPremium": 120
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "healthcareInsuranceActType": {
- "key": 2,
- "value": "(C/K) Wel verzekeringsplichtig, normaal tarief"
}, - "additionalContributionEmployer": 320,
- "nominalPremium": 320,
- "additionalPremium": 120
}
}
Delete a specific Healthcare Insurance Act record
Activity name: DeleteHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId
Delete a Healthcare Insurance Act record for the employment
path Parameters
healthcareInsuranceActConfigurationId required | string <uuid> The unique identifier of the Healthcare Insurance Act record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of occupational disabilities for an employee
Activity name : GetOccupationalDisabilitiesByEmployeeId
Get the list of occupational disabilities for an employee. This endpoint returns occupational disability information regarding the Occupational Disability Insurance Act (WAO) and Work Capacity Act (WIA).
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2017-05-21",
- "endDate": "2018-01-21",
- "classification": {
- "key": 2,
- "value": "15 - 24"
}, - "isOccupationallyDisabled": false,
- "isExWAO": true
}
]
}
List of applicationsets for an employer
Activity name: GetEmployerApplicationsetsByEmployerId
Get the list of Applicationsets for an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "applicationSetType": "Products",
- "name": "Exportset Dienstverband",
- "data": "json object",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
]
}
Create an applicationset for an employer
Activity name: PostApplicationSetByEmployerId
Create an applicationset for an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Applicationset to add to the employer.
applicationSetType | string Enum: "Products" "ExportDataTemplate" "Rights" The type of the set |
name | string <= 50 Name of the exportset |
data | string Contains an array of objects in json structure. |
Responses
Request samples
- Payload
{- "applicationSetType": "Products",
- "name": "Exportset Dienstverband",
- "data": "json object"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "applicationSetType": "Products",
- "name": "Exportset Dienstverband",
- "data": "json object",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
}
Edit the details of an applicationset
Activity name: PutEmployerApplicationSetByApplicationSetId
Edit the details for an applicationset.
path Parameters
applicationSetId required | string <uuid> The unique identifier of the Applicationset |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Applicationset to edit.
name | string <= 50 Name of the exportset |
data | string Contains an array of objects in json structure. |
Responses
Request samples
- Payload
{- "name": "Exportset Dienstverband",
- "data": "json object"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "applicationSetType": "Products",
- "name": "Exportset Dienstverband",
- "data": "json object",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
}
Delete a specific applicationset
Activity name: DeleteEmployerApplicationSetByApplicationSetId
Delete an applicationset for the employer
path Parameters
applicationSetId required | string <uuid> The unique identifier of the Applicationset |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of applicationsets for a provider
Activity name: GetApplicationsetsByProviderId
Get the list of Applicationsets for a provider.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "applicationSetType": "Products",
- "name": "Exportset Dienstverband",
- "data": "json object",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
]
}
Create an applicationset for a provider
Activity name: PostApplicationSetByProviderId
Create an applicationset for a provider.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Applicationset to add to the provider.
applicationSetType | string Enum: "Products" "ExportDataTemplate" "Rights" The type of the set |
name | string <= 50 Name of the exportset |
data | string Contains an array of objects in json structure. |
Responses
Request samples
- Payload
{- "applicationSetType": "Products",
- "name": "Exportset Dienstverband",
- "data": "json object"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "applicationSetType": "Products",
- "name": "Exportset Dienstverband",
- "data": "json object",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
}
Edit the details of an applicationset
Activity name: PutProviderApplicationSetByApplicationSetId
Edit the details for an applicationset.
path Parameters
applicationSetId required | string <uuid> The unique identifier of the Applicationset |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Applicationset to edit.
name | string <= 50 Name of the exportset |
data | string Contains an array of objects in json structure. |
Responses
Request samples
- Payload
{- "name": "Exportset Dienstverband",
- "data": "json object"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "applicationSetType": "Products",
- "name": "Exportset Dienstverband",
- "data": "json object",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
}
Delete a specific applicationset
Activity name: DeleteProviderApplicationSetByApplicationSetId
Delete an applicationset for the provider
path Parameters
applicationSetId required | string <uuid> The unique identifier of the Applicationset |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of applicationsets for a user
Activity name: GetApplicationsetsByUserId
Get the list of Applicationsets for a user.
path Parameters
userId required | string <uuid> The unique identifier of an user |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "applicationSetType": "Products",
- "name": "Exportset Dienstverband",
- "data": "json object",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
]
}
Create an applicationset for a user
Activity name: PostApplicationSetByUserId
Create an applicationset for a user.
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Applicationset to add to the user.
applicationSetType | string Enum: "Products" "ExportDataTemplate" "Rights" The type of the set |
name | string <= 50 Name of the exportset |
data | string Contains an array of objects in json structure. |
Responses
Request samples
- Payload
{- "applicationSetType": "Products",
- "name": "Exportset Dienstverband",
- "data": "json object"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "applicationSetType": "Products",
- "name": "Exportset Dienstverband",
- "data": "json object",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
}
Edit the details of an applicationset for a user
Activity name: PutUserApplicationSetByApplicationSetId
Edit the details for an applicationset.
path Parameters
applicationSetId required | string <uuid> The unique identifier of the Applicationset |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Applicationset to edit.
name | string <= 50 Name of the exportset |
data | string Contains an array of objects in json structure. |
Responses
Request samples
- Payload
{- "name": "Exportset Dienstverband",
- "data": "json object"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "applicationSetType": "Products",
- "name": "Exportset Dienstverband",
- "data": "json object",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
}
Delete a specific applicationset for a user
Activity name: DeleteUserApplicationSetByApplicationSetId
Delete an applicationset for the user
path Parameters
applicationSetId required | string <uuid> The unique identifier of the Applicationset |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of applicationsets provided by the Loket application
Activity name: GetLoketApplicationsetsByBearerToken
Get the list of Applicationsets for an employer.
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "applicationSetType": "Products",
- "name": "Exportset Dienstverband",
- "data": "json object",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
]
}
Initiate assessment
Activity name : PostInitiateAssessmentByConceptEmployeeId
Metadata: No metadata available. No defaults available.
Initiate the proces to perform an assessment for a concept employee.
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Contactinformation of the assessment.
withIq | boolean The type of the assessment |
Responses
Request samples
- Payload
{- "withIq": true
}
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
List of assessments
Activity name : GetAssessmentsByEmployerId
Retrieve a list of assessments.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "requestedBy": {
- "firstName": "Ben",
- "lastName": "Hur",
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "participant": {
- "firstName": "Ben",
- "lastName": "Hur",
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeOrConceptEmployee": "employee"
}, - "status": "sent",
- "invitedDate": "2022-02-22",
}
]
}
Download the audit trail for the payroll period data
Activity name : GetPayrollPeriodDataAuditTrailByPayrollAdministrationId
Returns the changes that were made in the payroll period data from the given start up to and including the given end date.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
startDate required | stringdate Example: startDate=2020-08-01 The start date |
endDate required | stringdate Example: endDate=2020-08-31 The end date |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Get the employer data audit trail
Activity name : GetEmployerDataAuditTrailByEmployerId
Get the mutations for the all the tables linked to the employer containing employer-related data.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
startDate required | stringdate Example: startDate=2020-08-01 The start date |
endDate required | stringdate Example: endDate=2020-08-31 The end date |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "field": {
- "key": 1,
- "value": "Achternaam"
}, - "oldValue": "Hermanss",
- "newValue": "Hermans",
- "timeStamp": "2018-05-08T15:16:49+02:00",
- "entity": {
- "key": 1,
- "value": "employee"
}, - "performedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "mutationType": {
- "key": 1,
- "value": "toevoegen"
}, - "mutationOrigin": {
- "key": 1,
- "value": "Import"
}, - "employer": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerNumber": 20720,
- "companyName": "Voorbeeld B.V."
}, - "identification": {
- "description": "Datum ingang 03-03-2005"
}
}
]
}
Get the employee data audit trail
Activity name : GetEmployeeDataAuditTrailByEmployerId
Get the mutations for the all the tables linked to the employee (this includes employment and underlying entities).
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
startDate required | stringdate Example: startDate=2020-08-01 The start date |
endDate required | stringdate Example: endDate=2020-08-31 The end date |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "field": {
- "key": 1,
- "value": "Achternaam"
}, - "oldValue": "Hermanss",
- "newValue": "Hermans",
- "timeStamp": "2018-05-08T15:16:49+02:00",
- "entity": {
- "key": 1,
- "value": "employee"
}, - "performedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "mutationType": {
- "key": 1,
- "value": "toevoegen"
}, - "mutationOrigin": {
- "key": 1,
- "value": "Import"
}, - "employer": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerNumber": 20720,
- "companyName": "Voorbeeld B.V."
}, - "employee": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "name": "Bergen"
}, - "employment": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01"
}, - "identification": {
- "description": "Datum ingang 03-03-2005"
}
}
]
}
Get payroll period data audit trail
Activity name : GetPayrollPeriodDataAuditTrailByPayrollAdministrationId
Get the audit trail for the payroll period data.
This 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.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
startDate | stringdate Example: startDate=2020-08-01 The start date |
endDate | stringdate Example: endDate=2020-08-31 The end date |
payrollPeriodId | integer <int32> Example: payrollPeriodId=202308 The unique identifier of the payroll period |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "field": {
- "key": 1,
- "value": "Achternaam"
}, - "payrollComponentCategory": {
- "key": 1,
- "value": "Uren"
}, - "oldValue": "Hermanss",
- "newValue": "Hermans",
- "timeStamp": "2018-05-08T15:16:49+02:00",
- "performedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "mutationType": {
- "key": 1,
- "value": "toevoegen"
}, - "mutationOrigin": {
- "key": 1,
- "value": "Import"
}, - "employer": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerNumber": 20720,
- "companyName": "Voorbeeld B.V."
}, - "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234
}, - "employee": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "name": "Bergen"
}, - "employment": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01"
}, - "identification": {
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "shift": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "payslipType": {
- "key": 2,
- "value": "Bijzonder tarief strook"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}, - "costCenter": {
- "key": 2,
- "code": "SAL073",
- "description": "Sales Den Bosch"
}, - "costUnit": {
- "key": 2,
- "code": "01",
- "description": "Cars"
}, - "description": "Datum ingang 03-03-2005"
}
}
]
}
Download the audit trail for the employment payroll data
Activity name : GetEmploymentPayrollDataAuditTrailByPayrollAdministrationId
Returns the changes that were made in the payroll data for the employments.
This includes resources such as (allmost all payroll related resources except payroll period data
which has its own audit trail download):
- Wage
- Working hours
- Bennefits and deductions
- Employment
- Fiscal properties
- Organizational entity
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
startDate required | stringdate Example: startDate=2020-08-01 The start date |
endDate required | stringdate Example: endDate=2020-08-31 The end date |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of authorization sets
Activity name : GetAuthorizationSetsByProviderId
List the available authorization sets.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "HRM Rechten",
- "authorizations": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Beheren dienstverbanden",
- "availableForEmployerUser": true,
- "isEnabled": true
}
]
}
]
}
Create an AuthorizationSet for an provider
Activity name : PostAuthorizationSetByProviderId
Create an authorization set.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
authorizationSet to add.
description | string <= 50 characters |
Array of objects (authorizations) |
Responses
Request samples
- Payload
{- "description": "HRM Rechten",
- "authorizations": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "isEnabled": true
}
]
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "HRM Rechten",
- "authorizations": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Beheren dienstverbanden",
- "availableForEmployerUser": true,
- "isEnabled": true
}
]
}
}
Details of a authorization set
Activity name : GetAuthorizationSetByAuthorizationSetId
Details of an authorization set.
path Parameters
authorizationSetId required | string <uuid> The unique identifier of an authorization set |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "HRM Rechten",
- "authorizations": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Beheren dienstverbanden",
- "availableForEmployerUser": true,
- "isEnabled": true
}
]
}
}
Edit the details of an authorizationset
Activity name : PutAuthorizationSetByAuthorizationSetId
Edit the details of an authorizationset.
path Parameters
authorizationSetId required | string <uuid> The unique identifier of an authorization set |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Autorizationset to edit.
description | string <= 50 characters |
Array of objects (authorizations) |
Responses
Request samples
- Payload
{- "description": "HRM Rechten",
- "authorizations": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "isEnabled": true
}
]
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "HRM Rechten",
- "authorizations": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Beheren dienstverbanden",
- "availableForEmployerUser": true,
- "isEnabled": true
}
]
}
}
Delete a specific AuthorizationSet
Activity name: DeleteAuthorizationSetByAuthorizationSetId
Delete an AuthorizationSet.
path Parameters
authorizationSetId required | string <uuid> The unique identifier of an authorization set |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
NL: Autorisaties (toegestane activities). Acquire the autorizations the user has for the given provider or employer
List of authorized activities with regard to the employer
Activity name : GetAuthorizationsByEmployerId
Get the array of activities the user is authenticated for with regard to the specified employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "GetJournalRunsByPayrollAdministrationId"
}
]
}
List of authorized activities with regard to the provider
Activity name : GetAuthorizationsByProviderId
Get the array of activities the user is authenticated for with regard to the specified provider. This endpoint is only accessible for providerusers.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "GetJournalRunsByPayrollAdministrationId"
}
]
}
NL: FondsGrondslag. The base used in the calculation of the employment fund contribution
List of bases for employment fund calculations.
Activity name : GetBasesForEmploymentFundCalculationByEmploymentId
Get a list of the bases (money) that are used in employment fund calculations.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "origin": {
- "key": 1,
- "value": "Normale wijziging"
}, - "base": 25000,
- "payrollComponent": {
- "key": 545,
- "description": "JAAR GRSL3"
}
}
]
}
Add a base for employment fund calculation
Activity name : PostBaseForEmploymentFundCalculationByEmploymentId
Metadata : Possible options for fields of the type "metadata" can be acquired (GET) by adding /metadata
to the POST URL.
Defaults : Default values for a new object can be acquired by adding `/defaults" to the POST URL.
Add a base for employment fund calculation.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
startDate | string <date> The date on which this base for calculation starts. A (linked chain)[./#section/Data/Date-chains] per base for calculation is maintained within this resource. So multiple bases can be active at the same time for different payrollcomponents |
endDate | string or null <date> The end date of the entity. The date is up to and including. |
base | number <double> [ 0.01 .. 999999.99 ] ^(\d{1,6})(\.\d{1,2})?$ The base (amount of money) to be used in the fund calculation |
object <metadata> (payrollComponentReadOnlyFalse) 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
|
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "base": 25000,
- "payrollComponent": {
- "key": 545
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "origin": {
- "key": 1,
- "value": "Normale wijziging"
}, - "base": 25000,
- "payrollComponent": {
- "key": 545,
- "description": "JAAR GRSL3"
}
}
}
Details of an base for employment fund calculations
Activity name : GetBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId
Get the details of a base for employment fund calculations.
path Parameters
baseforemploymentfundcalculationId required | string <uuid> The unique identifier of a base for employment fund calculation |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "origin": {
- "key": 1,
- "value": "Normale wijziging"
}, - "base": 25000,
- "payrollComponent": {
- "key": 545,
- "description": "JAAR GRSL3"
}
}
}
Change the properties of a base for employment fund calculation
Activity name : PutBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId
Metadata : Possible options for fields of the type "metadata" can be acquired (GET) by adding /metadata
to the PUT URL.
Edit the properties of a base for employment calculation
path Parameters
baseforemploymentfundcalculationId required | string <uuid> The unique identifier of a base for employment fund calculation |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
to edit
startDate | string <date> The date on which this base for calculation starts. A (linked chain)[./#section/Data/Date-chains] per base for calculation is maintained within this resource. So multiple bases can be active at the same time for different payrollcomponents |
endDate | string or null <date> The end date of the entity. The date is up to and including. |
base | number <double> [ 0.01 .. 999999.99 ] ^(\d{1,6})(\.\d{1,2})?$ The base (amount of money) to be used in the fund calculation |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "base": 25000
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "origin": {
- "key": 1,
- "value": "Normale wijziging"
}, - "base": 25000,
- "payrollComponent": {
- "key": 545,
- "description": "JAAR GRSL3"
}
}
}
Delete a specific record
Activity name : DeleteBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId
Delete an existing base for employment fund calculation
path Parameters
baseforemploymentfundcalculationId required | string <uuid> The unique identifier of a base for employment fund calculation |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
NL: Grondslag. The base used in certain calculation. Like the base amount to calculate leave allowance over
List of bases for calculations.
Activity name : GetBasesForCalculationByEmploymentId
Get a list of the bases (money) that are used as the base for certain calculations.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "deviations": {
- "percentage": 8,
- "reservationPercentage": 12.0007,
- "financialReservationPercentage": 10.000007
}, - "ageBasedMinimum": {
- "key": 2,
- "value": "Toepassen hoogste leeftijd"
}, - "ageBasedMaximum": {
- "key": 2,
- "value": "Toepassen hoogste leeftijd"
}, - "base": {
- "key": 545,
- "value": "VAKANTIE TOESLAG, periodieke opbouw"
}
}
]
}
Add a base for calculation
Activity name : PostBaseForCalculationByEmploymentId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the POST URL.
Defaults : Default values for a new object can be acquired by adding /defaults
to the POST URL.
Add a base for calculation record.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a base for calculation record.
startDate | string <date> The date on which this base starts. A (linked chain)[./#section/Data/Date-chains] per base is maintained within this resource. So multiple bases can be active at the same time but one specific base can never be active multiple times at the same time. |
endDate | string or null <date> The end date of the entity. The date is up to and including. |
object or null Only set a value for the underlying fields if you want to deviate from the values as defined by the selected Deviating is done on either all the fields or none. | |
object <metadata> This fields indicates how the age based minimum is applied | |
object <metadata> This fields indicates how the age based maximum is applied | |
object <metadata>
|
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "deviations": {
- "percentage": 8,
- "reservationPercentage": 12.0007,
- "financialReservationPercentage": 10.000007
}, - "ageBasedMinimum": {
- "key": 2
}, - "ageBasedMaximum": {
- "key": 2
}, - "base": {
- "key": 545
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "deviations": {
- "percentage": 8,
- "reservationPercentage": 12.0007,
- "financialReservationPercentage": 10.000007
}, - "ageBasedMinimum": {
- "key": 2,
- "value": "Toepassen hoogste leeftijd"
}, - "ageBasedMaximum": {
- "key": 2,
- "value": "Toepassen hoogste leeftijd"
}, - "base": {
- "key": 545,
- "value": "VAKANTIE TOESLAG, periodieke opbouw"
}
}
}
Details of an base for calculation
Activity name : GetBaseForCalculationByBaseForCalculationId
Get the details of a base for calculation.
path Parameters
baseforcalculationId required | string <uuid> The unique identifier of a base for calculation |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "deviations": {
- "percentage": 8,
- "reservationPercentage": 12.0007,
- "financialReservationPercentage": 10.000007
}, - "ageBasedMinimum": {
- "key": 2,
- "value": "Toepassen hoogste leeftijd"
}, - "ageBasedMaximum": {
- "key": 2,
- "value": "Toepassen hoogste leeftijd"
}, - "base": {
- "key": 545,
- "value": "VAKANTIE TOESLAG, periodieke opbouw"
}
}
}
Change the properties of a base for calculation
Activity name : PutBaseForCalculationByBaseForCalculationId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
Edit the properties of a base for calculation
path Parameters
baseforcalculationId required | string <uuid> The unique identifier of a base for calculation |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
to edit
startDate | string <date> The date on which this base starts. A (linked chain)[./#section/Data/Date-chains] per base is maintained within this resource. So multiple bases can be active at the same time but one specific base can never be active multiple times at the same time. |
endDate | string or null <date> The end date of the entity. The date is up to and including. |
object or null Only set a value for the underlying fields if you want to deviate from the values as defined by the selected Deviating is done on either all the fields or none. | |
object <metadata> This fields indicates how the age based minimum is applied | |
object <metadata> This fields indicates how the age based maximum is applied |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "deviations": {
- "percentage": 8,
- "reservationPercentage": 12.0007,
- "financialReservationPercentage": 10.000007
}, - "ageBasedMinimum": {
- "key": 2
}, - "ageBasedMaximum": {
- "key": 2
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "deviations": {
- "percentage": 8,
- "reservationPercentage": 12.0007,
- "financialReservationPercentage": 10.000007
}, - "ageBasedMinimum": {
- "key": 2,
- "value": "Toepassen hoogste leeftijd"
}, - "ageBasedMaximum": {
- "key": 2,
- "value": "Toepassen hoogste leeftijd"
}, - "base": {
- "key": 545,
- "value": "VAKANTIE TOESLAG, periodieke opbouw"
}
}
}
Delete a specific record
Activity name : DeleteBaseForCalculationByBaseForCalculationId
Delete an existing base for calculation
path Parameters
baseforcalculationId required | string <uuid> The unique identifier of a base for calculation |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Create bases for calculation for multiple employments
Activity name : PostCollectiveBasesForCalculationByEmployerId
Create new bases for calculations for multiple employments of an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Stuff to add.
employmentId | string <uuid> ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9... The unique identifier of an object (GUID/UUID) |
startDate | string <date> The date on which this base starts. A (linked chain)[./#section/Data/Date-chains] per base is maintained within this resource. So multiple bases can be active at the same time but one specific base can never be active multiple times at the same time. |
endDate | string or null <date> The end date of the entity. The date is up to and including. |
object or null Only set a value for the underlying fields if you want to deviate from the values as defined by the selected Deviating is done on either all the fields or none. | |
object <metadata> This fields indicates how the age based minimum is applied | |
object <metadata> This fields indicates how the age based maximum is applied | |
object <metadata>
|
Responses
Request samples
- Payload
[- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "deviations": {
- "percentage": 8,
- "reservationPercentage": 12.0007,
- "financialReservationPercentage": 10.000007
}, - "ageBasedMinimum": {
- "key": 2
}, - "ageBasedMaximum": {
- "key": 2
}, - "base": {
- "key": 545
}
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
Set base for calculation enddate for multiple employments
Activity name : PatchCollectiveBasesForCalculationByEmployerId
Set the base for calculation enddate for multiple employments of an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Stuff to change.
employmentId | string <uuid> ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9... The unique identifier of an object (GUID/UUID) |
endDate | string <date> The end date of the entity. The date is up to and including. |
baseForCalculationId | string <uuid> ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9... The unique identifier of an object (GUID/UUID) |
Responses
Request samples
- Payload
[- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "endDate": "2018-10-23",
- "baseForCalculationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
List benefit in kind types for an employer
Activity name : GetBenefitInKindTypesByEmployerId
Get a list of the benefit in kind types for an employer.
Note: The benefit in kind types defined at the employer level can be used as value for the field typeOfBenefitInKind in the BenefitInKind resource at the employment level.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Laptop"
}
]
}
Add an benefit in kind type for an employer
Activity name : PostBenefitInKindTypeByEmployerId
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add an benefit in kind type
description | string [ 1 .. 50 ] characters ^[\s\S]*\S[\s\S]*$ The description of the benifit in kind type |
Responses
Request samples
- Payload
{- "description": "Laptop"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Laptop"
}
}
Details of an benefit in kind type
Activity name : GetBenefitInKindTypeByBenefitInKindTypeId
Get the details of an benefit in kind type
path Parameters
benefitInKindTypeId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Laptop"
}
]
}
Edit an benefit in kind type record
Activity name : PutBenefitInKindTypeByBenefitInKindTypeId
path Parameters
benefitInKindTypeId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
description | string [ 1 .. 50 ] characters ^[\s\S]*\S[\s\S]*$ The description of the benifit in kind type |
Responses
Request samples
- Payload
{- "description": "Laptop"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Laptop"
}
}
Delete an benefit in kind type record
Activity name : DeleteBenefitInKindTypeByBenefitInKindTypeId
Delete an existing benefit in kind type record
path Parameters
benefitInKindTypeId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
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.
list of benefits and deductions
Activity name : GetBenefitsAndDeductionsByEmploymentId
Get a list of benefits and deductions for the employment
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "1995-05-21",
- "endDate": "2019-08-24",
- "payrollComponent": {
- "key": 1,
- "description": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}
}, - "value": 50.87
}
]
}
Add a benefit or deduction record for the employment
Activity name : PostBenefitsAndDeductionsByEmploymentId
Add a benefit or deduction for the employment
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the POST URL.
Defaults : Default values for a new object can be acquired by adding /defaults
to the POST URL.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
benefits and deductions record add to the employment.
startDate | string <date> The start date for the information in the record. A (linked chain)[./#section/Data/Date-chains] per payroll component is maintained with this resource. |
endDate | string or null <date> The end date for the information in the record. |
object <metadata> 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.
| |
value | number [ 0.01 .. 99999.99 ] The value for the selected payroll component. |
Responses
Request samples
- Payload
{- "startDate": "1995-05-21",
- "endDate": "2019-08-24",
- "payrollComponent": {
- "key": 1
}, - "value": 50.87
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "1995-05-21",
- "endDate": "2019-08-24",
- "payrollComponent": {
- "key": 1,
- "description": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}
}, - "value": 50.87
}
}
Detail of a benefit or deduction record
Activity name : GetBenefitsAndDeductionsBybenefitsAndDeductionsId
Get a benefit or deduction for the employment
path Parameters
benefitsanddeductionsId required | string <uuid> The unique identifier of the benefits and deductions data |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "1995-05-21",
- "endDate": "2019-08-24",
- "payrollComponent": {
- "key": 1,
- "description": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}
}, - "value": 50.87
}
}
Edit the details of a benefit or deduction record
Activity name : PutBenefitsAndDeductionsByBenefitsAndDeductionsId
Update a benefit or deduction for the employment
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the POST URL.
path Parameters
benefitsanddeductionsId required | string <uuid> The unique identifier of the benefits and deductions data |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
data to edit.
startDate | string <date> The start date for the information in the record. A (linked chain)[./#section/Data/Date-chains] per payroll component is maintained within this resource. |
endDate | string or null <date> The end date for the information in the record. |
value | number [ 0.01 .. 99999.99 ] The value for the selected payroll component. |
Responses
Request samples
- Payload
{- "startDate": "1995-05-21",
- "endDate": "2019-08-24",
- "value": 50.87
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "1995-05-21",
- "endDate": "2019-08-24",
- "payrollComponent": {
- "key": 1,
- "description": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}
}, - "value": 50.87
}
}
Delete a specific benefit or deduction record
Activity name : DeleteBenefitsAndDeductionsByBenefitsAndDeductionsId
Delete a benefit or deduction for the employment
path Parameters
benefitsanddeductionsId required | string <uuid> The unique identifier of the benefits and deductions data |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Get data to create an importfile
Activity name : GetBenefitsAndDeductionsImportDataByPayrollAdministrationId
Returns, for the given payrolladministration, a set of data that can be used as a base for importing benefits and deductions through a csv file.
Note that on importing, the columnnames must be in Dutch. (Clientnr, PersnrVerl, Persnr, Naam, Ingangsdatum, Component, Omschrijving, Toeslag )
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "clientNumber": 20720,
- "payrollEmployeeNumber": 202,
- "employeeNumber": 156,
- "formattedName": "Jong, I",
- "startDate": "2023-11-01",
- "payrollComponentKey": 1,
- "payrollComponentDescription": "Uren gewerkt",
- "value": 3500
}
]
}
Import benefits and deductions via a csv file
Activity name : PostBenefitsAndDeductionsImportDataByPayrollAdministrationId
Imports a csv file containing benefits and deduction records.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
csv file to be uploaded.
mimeType | string Value: "text/csv" The type of file to import. Currently only csv is supported |
data | string base64 encoded file. |
Responses
Request samples
- Payload
{- "mimeType": "text/csv",
- "data": "YQ=="
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
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.
List of social security benefits records for an employment
Activity name: GetSocialSecurityBenefitsByEmploymentId
Get the list of social security benefits records for an employment
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "supplementation": {
- "type": {
- "key": 3,
- "value": "Suppleren (bruto)"
}, - "percentage": 35
}, - "benefit": {
- "type": {
- "key": 1,
- "value": "ZW eigen risico"
}, - "percentage": 35
}
}
]
}
Create a social security benefits record for an employment
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.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Social security record to add to the employment.
startDate | string <date> The start date of the entity. Valide values are either the startDate of the employment or the firstday of a payrolling year. A (broken chain)[./#section/Data/Date-chains] is maintained within this resource. |
endDate | string or null <date> The end date of the entity. The date is up to and including. |
object | |
object (benefitPostGet) |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "supplementation": {
- "type": {
- "key": 3
}, - "percentage": 35
}, - "benefit": {
- "type": { },
- "percentage": 35
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "supplementation": {
- "type": {
- "key": 3,
- "value": "Suppleren (bruto)"
}, - "percentage": 35
}, - "benefit": {
- "type": {
- "key": 1,
- "value": "ZW eigen risico"
}, - "percentage": 35
}
}
}
Details of a social security benefits record
Activity name: GetSocialSecurityBenefitBySocialSecurityBenefitId
Get the details of a social security benefits record
path Parameters
socialSecurityBenefitId required | string <uuid> The unique identifier of the social security record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "supplementation": {
- "type": {
- "key": 3,
- "value": "Suppleren (bruto)"
}, - "percentage": 35
}, - "benefit": {
- "type": {
- "key": 1,
- "value": "ZW eigen risico"
}, - "percentage": 35
}
}
}
Edit the details of a social security benefits record
Activity name: PutSocialSecurityBenefitBySocialSecurityBenefitId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
Edit the details for a social security record
path Parameters
socialSecurityBenefitId required | string <uuid> The unique identifier of the social security record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Social security record to edit.
startDate | string <date> The start date of the entity. Valide values are either the startDate of the employment or the firstday of a payrolling year. A (broken chain)[./#section/Data/Date-chains] is maintained within this resource. |
endDate | string or null <date> The end date of the entity. The date is up to and including. |
object | |
object (benefitPut) |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "supplementation": {
- "type": {
- "key": 3
}, - "percentage": 35
}, - "benefit": {
- "percentage": 35
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "supplementation": {
- "type": {
- "key": 3,
- "value": "Suppleren (bruto)"
}, - "percentage": 35
}, - "benefit": {
- "type": {
- "key": 1,
- "value": "ZW eigen risico"
}, - "percentage": 35
}
}
}
Delete a specific social security benefits record
Activity name: DeleteSocialSecurityBenefitBySocialSecurityBenefitId
Delete a social security record for the employment
path Parameters
socialSecurityBenefitId required | string <uuid> The unique identifier of the social security record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List pension benefit
Activity name : GetPensionBenefitsByEmploymentId
Get a list of the pension benefits of the employment.
Note: Loket.nl has different ways to register pension benefit.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "payout": 2569
}
]
}
Add a pension benefit for an employment
Activity name : PostPensionBenefitByEmploymentId
Metadata : No metadata
Defaults : No default values
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a pension benefit
startDate | string <date> The date on which this pension benefit starts A (broken chain)[./#section/Data/Date-chains] is maintained within this resource. |
payout | number <double> [ 0 .. 100000 ] ^(\d{1,8})(\.\d{1,2})?$ The ammount of (gross) pension received |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "payout": 2569
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "payout": 2569
}
}
Details of an pension benefit
Activity name : GetPensionBenefitByPensionBenefitId
Get the details of a pension benefit
path Parameters
pensionBenefitId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "payout": 2569
}
]
}
Edit a pension benefit record
Activity name : PutPensionBenefitByPensionBenefitId
Metadata : No metadata
path Parameters
pensionBenefitId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
startDate | string <date> The date on which this pension benefit starts A (broken chain)[./#section/Data/Date-chains] is maintained within this resource. |
payout | number <double> [ 0 .. 100000 ] ^(\d{1,8})(\.\d{1,2})?$ The ammount of (gross) pension received |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "payout": 2569
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "payout": 2569
}
}
Delete a pension benefit record
Activity name : DeletePensionBenefitByPensionBenefitId
Delete an existing pension benefit record
path Parameters
pensionBenefitId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List Benefits in kind
Activity name: GetBenefitsInKindByEmploymentId Get a list of the Benefits in kind of the employment.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "benefitInKindType": {
- "id": "36530F13-59EB-4C15-B5F2-4F92B070A208",
- "description": "Mobiele telefoon"
}, - "brand": "Apple",
- "type": "Iphone 11",
- "value": 1100,
- "supplier": "Mediamarkt",
- "particularities": "geen bijzonderheden"
}
]
}
Add a Benefit in kind for an employment
Activity name : PostBenefitInKindByEmploymentId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata
to the POST URL.
Defaults: Default values for a new object can be acquired by adding `/defaults' to the POST URL.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a benefit in kind
startDate | string <date> The date on which this BenefitInKind starts. So multiple Benefits in kind can be active at the same time but one specific BenefitsInKind can never be active multiple times at the same time. |
endDate | string or null <date> The end date of the entity. The date is up to and including. |
object <metadata> The benefit in kind of the employment. | |
brand | string or null <= 30 characters The brand of the benefit in kind. |
type | string or null <= 30 characters The type of the benefit in kind. |
value | number >= 0 ^(\d{1,5})(\.\d{1,2})?$ The value for the selected benefit of kind. |
supplier | string or null <= 30 characters The supplier of the benefit in kind. |
particularities | string or null <= 4000 characters Extra information about the benefit in kind |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "benefitInKindType": {
- "id": "36530F13-59EB-4C15-B5F2-4F92B070A208"
}, - "brand": "Apple",
- "type": "Iphone 11",
- "value": 1100,
- "supplier": "Mediamarkt",
- "particularities": "geen bijzonderheden"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "benefitInKindType": {
- "id": "36530F13-59EB-4C15-B5F2-4F92B070A208",
- "description": "Mobiele telefoon"
}, - "brand": "Apple",
- "type": "Iphone 11",
- "value": 1100,
- "supplier": "Mediamarkt",
- "particularities": "geen bijzonderheden"
}
}
Details of an benefit in kind
Activity name : GetBenefitInKindByBenefitInKindId
Get the details of a benefit in kind
path Parameters
benefitInKindId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "benefitInKindType": {
- "id": "36530F13-59EB-4C15-B5F2-4F92B070A208",
- "description": "Mobiele telefoon"
}, - "brand": "Apple",
- "type": "Iphone 11",
- "value": 1100,
- "supplier": "Mediamarkt",
- "particularities": "geen bijzonderheden"
}
]
}
Edit a benefit in kind record
Activity name : PutBenefitInKindByBenefitInKindId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding / metadata
to the PUT URL.
path Parameters
benefitInKindId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
startDate | string <date> The date on which this BenefitInKind starts. So multiple Benefits in kind can be active at the same time but one specific BenefitsInKind can never be active multiple times at the same time. |
endDate | string or null <date> The end date of the entity. The date is up to and including. |
object <metadata> The benefit in kind of the employment. | |
brand | string or null <= 30 characters The brand of the benefit in kind. |
type | string or null <= 30 characters The type of the benefit in kind. |
value | number >= 0 ^(\d{1,5})(\.\d{1,2})?$ The value for the selected benefit of kind. |
supplier | string or null <= 30 characters The supplier of the benefit in kind. |
particularities | string or null <= 4000 characters Extra information about the benefit in kind |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "benefitInKindType": {
- "id": "36530F13-59EB-4C15-B5F2-4F92B070A208"
}, - "brand": "Apple",
- "type": "Iphone 11",
- "value": 1100,
- "supplier": "Mediamarkt",
- "particularities": "geen bijzonderheden"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "benefitInKindType": {
- "id": "36530F13-59EB-4C15-B5F2-4F92B070A208",
- "description": "Mobiele telefoon"
}, - "brand": "Apple",
- "type": "Iphone 11",
- "value": 1100,
- "supplier": "Mediamarkt",
- "particularities": "geen bijzonderheden"
}
}
Delete a benefit in kind record
Activity name : DeleteBenefitInKindByBenefitInKindId
Delete an existing benefit in kind record
path Parameters
benefitInKindId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Create benefits and deductions for multiple employments
Activity name : PostCollectiveBenefitsAndDeductionsByEmployerId
Create new benefits and deduction records for multiple employments of an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
BenefitsAndDeductions to add.
employmentId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
startDate | string <date> The start date for the information in the record. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. |
value | number or null <double> [ 0.01 .. 99999.99 ] The value for the component |
object <metadata> 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.
|
Responses
Request samples
- Payload
[- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "1995-05-21",
- "value": 80,
- "payrollComponent": {
- "key": 1
}
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
Close benefits and deductions for multiple employments
Activity name : PutCollectiveBenefitsAndDeductionsByEmployerId
Set the endDate for benefits and deduction records for multiple employments of an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
BenefitsAndDeductions to put.
employmentId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
benefitAndDeductionId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
endDate | string <date> The end date for the information in the record. |
Responses
Request samples
- Payload
[- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "benefitAndDeductionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "endDate": "1995-05-21"
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
Overview of number of billable items per employer
Activity name : GetBillableItemsByProviderId
Get a list of all billable items for the provider.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
query Parameters
startDate required | stringdate Example: startDate=2020-08-01 The start date |
endDate required | stringdate Example: endDate=2020-08-31 The end date |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "providerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employer": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "companyName": "Janssen B.V.",
- "employerNumber": 20720,
- "administrationNumber": "SR2"
}, - "itemType": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Preboarding traject"
}, - "numberOfBillableItems": 64
}
]
}
List of billable items for an employer
Activity name : GetBillableItemsByEmployerId
Get a list of all billable items for the employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "providerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employer": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "companyName": "Janssen B.V."
}, - "requestedDate": "2022-04-12",
- "requestedBy": {
- "user": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen",
- "formattedName": "Wiel - van Bergen S.L. van de"
}, - "name": "B. Janssen"
}, - "issuedTo": {
- "person": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "lastNamePartner": "Wiel",
- "prefixPartner": "van de",
- "formattedName": "Wiel - van Bergen S.L. van de"
}, - "name": "B. Janssen"
}, - "requestedItem": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "itemType": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Preboarding traject"
}, - "preboardingTrajectory": {
- "status": "open",
- "dateLastModification": "2022-04-12"
}
}
}
]
}
NL: Endpoints waarmee inzicht in de status van collective acties kan worden verkregen.
List of collective actions for a user
Activity name : GetCollectiveActionsByBearerToken
A list of collective actions for a user
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
]
}
List of messages of a collective action
Activity name : GetCollectiveActionMessagesByCollectiveActionId
Get the messages of all collectiveActionItems of a single collective action
path Parameters
collectiveActionId required | string <uuid> Example: b14acd0d-75d7-4fc8-8b22-4a3924585cab The unique identifier of the collective action |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "collectiveActionItemId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2023-05-08T15:16:49+02:00",
- "succes": true,
- "collectiveActionType": "Werknemerloket",
- "entityId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
]
}
]
}
NL: Werknemer auto fiscaal. Registration of company car for fiscal (tax-related) purposes
List of fiscal company cars for an employment
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'
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "licensePlateNumber": "GP586D",
- "dateOfFirstAdmission": "2018-01-01",
- "valueForTaxPurposes": 20000,
- "additionalTaxLiabilityGroup": {
- "key": 1,
- "value": "Standaard tarief (25% tot 2017)"
}, - "reasonForNoAdditionalTaxLiability": {
- "key": 1,
- "value": "(2) Werknemer heeft beschikking belastingdienst"
}, - "deviatingAdditionalTaxLiability": 20000,
- "taxableBenefitForPrivateUse": 2000
}
]
}
Create a fiscal company car record for an employment
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.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Fiscal Company Car record to add to the employment.
startDate | string <date> The start date of the entity. A (broken chain)[./#section/Data/Date-chains] is maintained within this resource. |
endDate | string or null <date> The end date of the entity. The date is up to and including. |
licensePlateNumber | string or null [ 0 .. 15 ] characters Vehicle registration number (license plate) of the fiscal company car. The number should be provided with or without any hyphens (-). |
dateOfFirstAdmission | string or null <date> 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. |
valueForTaxPurposes | number or null <double> [ 0.01 .. 999999.99 ] ^(\d{1,6})(.\d{1,2})?$ The value of the car for tax purposes. This field may only be NULL if a reason for no additional tax liability (reden voor geen bijtelling) is provided. It is possible to acquire a value for this field based on the RDW-registration by calling that supplementary endpoint. |
object <metaData> Indication for what additional tax liability percentage (bijtelling) should be used for calculating the tax liabiltiy in the payroll process. It is possible to acquire a value for this field based on the RDW-registration of the vehicle registration number (license plate) by calling that supplementary endpoint. | |
object or null <metaData> 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. | |
deviatingAdditionalTaxLiability | number or null <double> [ 0.01 .. 999999.99 ] ^(\d{1,6})(.\d{1,2})?$ 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. |
taxableBenefitForPrivateUse | number or null <double> [ 0.01 .. 999999.99 ] ^(\d{1,6})(.\d{1,2})?$ 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. |
Responses
Request samples
- Payload
{- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "licensePlateNumber": "GP586D",
- "dateOfFirstAdmission": "2018-01-01",
- "valueForTaxPurposes": 20000,
- "additionalTaxLiabilityGroup": {
- "key": 1
}, - "reasonForNoAdditionalTaxLiability": {
- "key": 1
}, - "deviatingAdditionalTaxLiability": 20000,
- "taxableBenefitForPrivateUse": 2000
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "licensePlateNumber": "GP586D",
- "dateOfFirstAdmission": "2018-01-01",
- "valueForTaxPurposes": 20000,
- "additionalTaxLiabilityGroup": {
- "key": 1,
- "value": "Standaard tarief (25% tot 2017)"
}, - "reasonForNoAdditionalTaxLiability": {
- "key": 1,
- "value": "(2) Werknemer heeft beschikking belastingdienst"
}, - "deviatingAdditionalTaxLiability": 20000,
- "taxableBenefitForPrivateUse": 2000
}
}
Details of a fiscal company car record
Activity name: GetFiscalCompanyCarByFiscalCompanyCarId
Get the details of fiscal company car
Please note this resource is related for the registration of the company car for tax purposes. This is NOT directly related to the registration of the company car(s) related to the HRM-module Verstrekking
path Parameters
fiscalCompanyCarId required | string <uuid> The unique identifier of the fiscal company car |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "licensePlateNumber": "GP586D",
- "dateOfFirstAdmission": "2018-01-01",
- "valueForTaxPurposes": 20000,
- "additionalTaxLiabilityGroup": {
- "key": 1,
- "value": "Standaard tarief (25% tot 2017)"
}, - "reasonForNoAdditionalTaxLiability": {
- "key": 1,
- "value": "(2) Werknemer heeft beschikking belastingdienst"
}, - "deviatingAdditionalTaxLiability": 20000,
- "taxableBenefitForPrivateUse": 2000
}
}
Edit the details of a fiscal company car record
Activity name: PutFiscalCompanyCarByFiscalCompanyCarId
Edit the details for a fiscal company car record.
Please note this resource is related for the registration of the company car for tax purposes. This is NOT directly related to the registration of the company car(s) related to the HRM-module Verstrekking
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
path Parameters
fiscalCompanyCarId required | string <uuid> The unique identifier of the fiscal company car |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Company Car to edit.
startDate | string <date> The start date of the entity. A (broken chain)[./#section/Data/Date-chains] is maintained within this resource. |
endDate | string or null <date> The end date of the entity. The date is up to and including. |
licensePlateNumber | string or null [ 0 .. 15 ] characters Vehicle registration number (license plate) of the fiscal company car. The number should be provided with or without any hyphens (-). |
dateOfFirstAdmission | string or null <date> 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. |
valueForTaxPurposes | number or null <double> [ 0.01 .. 999999.99 ] ^(\d{1,6})(.\d{1,2})?$ The value of the car for tax purposes. This field may only be NULL if a reason for no additional tax liability (reden voor geen bijtelling) is provided. It is possible to acquire a value for this field based on the RDW-registration by calling that supplementary endpoint. |
object <metaData> Indication for what additional tax liability percentage (bijtelling) should be used for calculating the tax liabiltiy in the payroll process. It is possible to acquire a value for this field based on the RDW-registration of the vehicle registration number (license plate) by calling that supplementary endpoint. | |
object or null <metaData> 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. | |
deviatingAdditionalTaxLiability | number or null <double> [ 0.01 .. 999999.99 ] ^(\d{1,6})(.\d{1,2})?$ 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. |
taxableBenefitForPrivateUse | number or null <double> [ 0.01 .. 999999.99 ] ^(\d{1,6})(.\d{1,2})?$ 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. |
Responses
Request samples
- Payload
{- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "licensePlateNumber": "GP586D",
- "dateOfFirstAdmission": "2018-01-01",
- "valueForTaxPurposes": 20000,
- "additionalTaxLiabilityGroup": {
- "key": 1
}, - "reasonForNoAdditionalTaxLiability": {
- "key": 1
}, - "deviatingAdditionalTaxLiability": 20000,
- "taxableBenefitForPrivateUse": 2000
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "licensePlateNumber": "GP586D",
- "dateOfFirstAdmission": "2018-01-01",
- "valueForTaxPurposes": 20000,
- "additionalTaxLiabilityGroup": {
- "key": 1,
- "value": "Standaard tarief (25% tot 2017)"
}, - "reasonForNoAdditionalTaxLiability": {
- "key": 1,
- "value": "(2) Werknemer heeft beschikking belastingdienst"
}, - "deviatingAdditionalTaxLiability": 20000,
- "taxableBenefitForPrivateUse": 2000
}
}
Delete a specific fiscal company car record
Activity name: DeleteFiscalCompanyCarByFiscalCompanyCarId
Delete a fiscal company car record for the employment
Please note this resource is related for the registration of the company car for tax purposes. This is NOT directly related to the registration of the company car(s) related to the HRM-module Verstrekking
path Parameters
fiscalCompanyCarId required | string <uuid> The unique identifier of the fiscal company car |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Acquire the additional tax liability by the license plate number (company car)
Activity name: GetAdditionalTaxliabilityByLicensePlateNumber
This endpoint allows the user to acquire values for specific properties in the company car resource. This endpoint will require a license plate number (vehicle registration number), and will return aggregated data based on its RDW-registration.
query Parameters
licensePlateNumber required | string Example: licensePlateNumber=52LRX4 A valid vehicle registration (license plate) number. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "licensePlateNumber": "GP586D",
- "dateOfFirstAdmission": "2018-01-01",
- "valueForTaxPurposes": 20000,
- "additionalTaxLiabilityGroup": {
- "key": 1,
- "value": "Standaard tarief (25% tot 2017)"
}
}
}
Import fiscal company cars via a csv file
Activity name : PostFiscalCompanyCarImportDataByPayrollAdministrationId
Imports a csv file containing fiscal company car records.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
csv file to be uploaded.
mimeType | string Value: "text/csv" The type of file to import. Currently only csv is supported |
data | string base64 encoded file. |
Responses
Request samples
- Payload
{- "mimeType": "text/csv",
- "data": "YQ=="
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
List of company cars for an employment
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.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "brand": "Volvo",
- "model": "V60",
- "licensePlateNumber": "GP586D",
- "fuelCardNumber": "B100.323.903",
- "leaseOrBuy": {
- "key": 1,
- "value": "Koop"
}, - "supplier": "Leasemaatschappij Tilburg",
- "lease": {
- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "contractNumber": "2021.323.903"
}, - "catalogValue": 20000,
- "kilometersPrivateUse": 10000,
- "comments": "This car is very nice"
}
]
}
Create a company car record for an employment
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.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Company Car record to add to the employment.
startDate | string <date> The start date of the entity. |
endDate | string or null <date> The end date of the entity. The date is up to and including. |
brand | string or null <= 25 Brand of the vehicle. |
model | string or null <= 25 Model of the vehicle. |
licensePlateNumber | string [ 1 .. 8 ] characters Vehicle registration number (license plate) of the company car. The number should be provided with or without any hyphens (-). |
fuelCardNumber | string or null <= 20 Registration number of the fuel card. |
object <metaData> Indication of the ownership of the company car. | |
supplier | string or null <= 30 Name of the company the delivered the company car. |
object or null Details of the leasecontract | |
catalogValue | number or null <double> <= 999999.99 ^(\d{1,6})(.\d{1,2})?$ The catalog value of the car. |
kilometersPrivateUse | integer or null <int32> The number kilometers per year the employee can use the car for private purposes. |
comments | string or null <= 4000 Any comments on the car or the contract. |
Responses
Request samples
- Payload
{- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "brand": "Volvo",
- "model": "V60",
- "licensePlateNumber": "GP586D",
- "fuelCardNumber": "B100.323.903",
- "leaseOrBuy": {
- "key": 1
}, - "supplier": "Leasemaatschappij Tilburg",
- "lease": {
- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "contractNumber": "2021.323.903"
}, - "catalogValue": 20000,
- "kilometersPrivateUse": 10000,
- "comments": "This car is very nice"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "brand": "Volvo",
- "model": "V60",
- "licensePlateNumber": "GP586D",
- "fuelCardNumber": "B100.323.903",
- "leaseOrBuy": {
- "key": 1,
- "value": "Koop"
}, - "supplier": "Leasemaatschappij Tilburg",
- "lease": {
- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "contractNumber": "2021.323.903"
}, - "catalogValue": 20000,
- "kilometersPrivateUse": 10000,
- "comments": "This car is very nice"
}
}
Details of a company car record
Activity name: GetCompanyCarByCompanyCarId
Get the details of a company car
Please note this resource is related for the registration of the company car for HRM purposes. This resource is NOT related to the registration of the fiscal company car(s) which is used in salary calculations.
path Parameters
companyCarId required | string <uuid> The unique identifier of the company car |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "brand": "Volvo",
- "model": "V60",
- "licensePlateNumber": "GP586D",
- "fuelCardNumber": "B100.323.903",
- "leaseOrBuy": {
- "key": 1,
- "value": "Koop"
}, - "supplier": "Leasemaatschappij Tilburg",
- "lease": {
- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "contractNumber": "2021.323.903"
}, - "catalogValue": 20000,
- "kilometersPrivateUse": 10000,
- "comments": "This car is very nice"
}
}
Edit the details of a company car record
Activity name: PutCompanyCarByCompanyCarId
Edit the details for a company car record.
Please note this resource is related for the registration of the company car for HRM purposes. This resource is NOT related to the registration of the fiscal company car(s) which is used in salary calculations.
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
path Parameters
companyCarId required | string <uuid> The unique identifier of the company car |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Company Car to edit.
startDate | string <date> The start date of the entity. |
endDate | string or null <date> The end date of the entity. The date is up to and including. |
brand | string or null <= 25 Brand of the vehicle. |
model | string or null <= 25 Model of the vehicle. |
licensePlateNumber | string [ 1 .. 8 ] characters Vehicle registration number (license plate) of the company car. The number should be provided with or without any hyphens (-). |
fuelCardNumber | string or null <= 20 Registration number of the fuel card. |
object <metaData> Indication of the ownership of the company car. | |
supplier | string or null <= 30 Name of the company the delivered the company car. |
object or null Details of the leasecontract | |
catalogValue | number or null <double> <= 999999.99 ^(\d{1,6})(.\d{1,2})?$ The catalog value of the car. |
kilometersPrivateUse | integer or null <int32> The number kilometers per year the employee can use the car for private purposes. |
comments | string or null <= 4000 Any comments on the car or the contract. |
Responses
Request samples
- Payload
{- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "brand": "Volvo",
- "model": "V60",
- "licensePlateNumber": "GP586D",
- "fuelCardNumber": "B100.323.903",
- "leaseOrBuy": {
- "key": 1
}, - "supplier": "Leasemaatschappij Tilburg",
- "lease": {
- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "contractNumber": "2021.323.903"
}, - "catalogValue": 20000,
- "kilometersPrivateUse": 10000,
- "comments": "This car is very nice"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "brand": "Volvo",
- "model": "V60",
- "licensePlateNumber": "GP586D",
- "fuelCardNumber": "B100.323.903",
- "leaseOrBuy": {
- "key": 1,
- "value": "Koop"
}, - "supplier": "Leasemaatschappij Tilburg",
- "lease": {
- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "contractNumber": "2021.323.903"
}, - "catalogValue": 20000,
- "kilometersPrivateUse": 10000,
- "comments": "This car is very nice"
}
}
Delete a specific company car record
Activity name: DeleteCompanyCarByCompanyCarId
Delete a company car record for the employment
Please note this resource is related for the registration of the company car for HRM purposes. This resource is NOT related to the registration of the fiscal company car(s) which is used in salary calculations.
path Parameters
companyCarId required | string <uuid> The unique identifier of the company car |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List custom fields for an employer
Activity name : GetCustomFieldsByEmployerId
Get a list of the custom fields for an employer.
Note: The custom fields defined at the employer level can be used at the employee and employment level.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Shoe size"
}
]
}
Add a custom field for an employer
Activity name : PostCustomFieldByEmployerId
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a custom field
description | string <= 50 characters The description for the custom field which can be used at the employee and employment level |
Responses
Request samples
- Payload
{- "description": "Shoe size"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Shoe size"
}
}
Details of a custom field
Activity name : GetCustomFieldByCustomFieldId
Get the details of a custom field
path Parameters
customFieldId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Shoe size"
}
]
}
Edit a custom field record
Activity name : PutCustomFieldByCustomFieldId
path Parameters
customFieldId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
description | string <= 50 characters The description for the custom field which can be used at the employee and employment level |
Responses
Request samples
- Payload
{- "description": "Shoe size"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Shoe size"
}
}
Delete a custom field record
Activity name : DeleteCustomFieldByCustomFieldId
Delete an existing custom field record
path Parameters
customFieldId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List employment custom fields for an employment
Activity name : GetEmploymentCustomFieldsByEmploymentId
Get a list of the custom fields for an employment.
Note: custom fields are user defined at the employer level.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "customField": {
- "id": "025ce09b-bff2-4b05-bcf0-711a89da7c08",
- "description": "Shoe size"
}, - "value": "41"
}
]
}
Add an employment custom field for an employment
Activity name : PostEmploymentCustomFieldByEmploymentId
Metadata: Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the POST URL.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a custom field
object <metadata> 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). | |
value | string <= 255 characters The value for the custom field for the employment |
Responses
Request samples
- Payload
{- "customField": {
- "id": "025ce09b-bff2-4b05-bcf0-711a89da7c08"
}, - "value": "41"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "customField": {
- "id": "025ce09b-bff2-4b05-bcf0-711a89da7c08",
- "description": "Shoe size"
}, - "value": "41"
}
}
Details of an employment custom field
Activity name : GetEmploymentCustomFieldByEmploymentCustomFieldId
Get the details of a custom field
path Parameters
employmentCustomFieldId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "customField": {
- "id": "025ce09b-bff2-4b05-bcf0-711a89da7c08",
- "description": "Shoe size"
}, - "value": "41"
}
]
}
Edit an employment custom field record
Activity name : PutEmploymentCustomFieldByEmploymentCustomFieldId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding / metadata
to the PUT URL.
path Parameters
employmentCustomFieldId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
value | string <= 255 characters The value for the custom field for the employment |
Responses
Request samples
- Payload
{- "value": "41"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "customField": {
- "id": "025ce09b-bff2-4b05-bcf0-711a89da7c08",
- "description": "Shoe size"
}, - "value": "41"
}
}
Delete an employment custom field record
Activity name : DeleteEmploymentCustomFieldByEmploymentCustomFieldId
Delete an existing custom field record
path Parameters
employmentCustomFieldId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List employee custom fields for an employee
Activity name : GetEmployeeCustomFieldsByEmployeeId
Get a list of the custom fields for an employee.
Note: custom fields are user defined at the employer level.
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "customField": {
- "id": "025ce09b-bff2-4b05-bcf0-711a89da7c08",
- "description": "Shoe size"
}, - "value": "41"
}
]
}
Add an employee custom field for an employee
Activity name : PostEmployeeCustomFieldByEmployeeId
Metadata: Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the POST URL.
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a custom field
object <metadata> 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). | |
value | string <= 255 characters The value for the custom field for the employee |
Responses
Request samples
- Payload
{- "customField": {
- "id": "025ce09b-bff2-4b05-bcf0-711a89da7c08"
}, - "value": "41"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "customField": {
- "id": "025ce09b-bff2-4b05-bcf0-711a89da7c08",
- "description": "Shoe size"
}, - "value": "41"
}
}
Details of an employee custom field
Activity name : GetEmployeeCustomFieldByEmployeeCustomFieldId
Get the details of a custom field
path Parameters
employeeCustomFieldId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "customField": {
- "id": "025ce09b-bff2-4b05-bcf0-711a89da7c08",
- "description": "Shoe size"
}, - "value": "41"
}
]
}
Edit an employee custom field record
Activity name : PutEmployeeCustomFieldByEmployeeCustomFieldId
Metadata : No metadata available for this endpoint
path Parameters
employeeCustomFieldId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
value | string <= 255 characters The value for the custom field for the employee |
Responses
Request samples
- Payload
{- "value": "41"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "customField": {
- "id": "025ce09b-bff2-4b05-bcf0-711a89da7c08",
- "description": "Shoe size"
}, - "value": "41"
}
}
Delete an employee custom field record
Activity name : DeleteEmployeeCustomFieldByEmployeeCustomFieldId
Delete an existing custom field record
path Parameters
employeeCustomFieldId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Dashboard for a provider
Activity name : GetProviderDashboardByProviderId
Get the url for the PowerBI dashboard for this provider. Please note: the PowerBI dashboard is only accessible for users with an assigned dashboard license.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "embedToken": {
- "token": "G4sJKSADFKJHF.........",
- "expiration": "2024-05-08T15:16:49+02:00"
}
}
}
Dashboard of an employer
Activity name : GetEmployerDashboardByEmployerId
Get the url for the Qlik dashboard for this employer. Please note: the Qlik dashboard is only accessible for users with an assigned Qlik dashboard licenses.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
],
}
Get the list dashboard licenses
Activity name : GetDashboardLicensesByEmployerId
Get the list dashboard licenses
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "license": {
- "user": {
- "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}
}
}
}
]
}
Edit the dashboard license
Activity name: PutDashboardLicensesByEmployerId
Edit the dashboard licenses
Metadata : There is no metadata endpoint for this resource.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Edit dashboard users
object or null |
Responses
Request samples
- Payload
[- {
- "license": {
- "user": {
- "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
}
]
Response samples
- 200
- 400
- 401
- 403
- 409
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "license": {
- "user": {
- "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}
}
}
}
]
}
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
List of declarations for an employment
Activity name : GetDeclarationsByEmploymentId
Returns a list of declarations for the employments of the employer
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollComponent": {
- "key": 11,
- "description": "UREN TVT 130%",
- "deviatingDescription": "Uren tijd voor tijd 130%",
- "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}, - "routeType": {
- "key": 1,
- "value": "Snelste"
}
}, - "calculatedDistanceByRoutingService": 8,
- "numberOfUnits": 8,
- "declarationDate": "2017-11-01",
- "declarationComment": "Overwerk project X",
- "declarationStatus": {
- "key": 1,
- "value": "Open"
}, - "dateOfSubmissionByEmployee": "2018-05-08T15:16:49+02:00",
- "dateOfLastChangeByEmployee": "2018-05-08T15:16:49+02:00",
- "processedInPayrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "reasonForDeviatingFromCalculatedDistance": "There were some ongoing road works i had to get around",
- "route": [
- {
- "pointOfInterest": {
- "name": "Van Spaendonck Groep"
}, - "address": {
- "freeformAddress": "Reitseplein 1, 5037 AA Tilburg",
- "countryCode": "NL"
}, - "position": {
- "latitude": 51.585996,
- "longitude": 5.585996
}
}
]
}
]
}
Create a declaration for an employment
Activity name : PostDeclarationByEmploymentId
Add a declaration for an employment. This can be only be done by the employee.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object <metadata> 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. | |
calculatedDistanceByRoutingService | number or null <double> [ 0.01 .. 99999999.99 ] ^(\d{1,8})(\.\d{1,2})?$ The value calulated by the routing service |
numberOfUnits | number <double> [ 0.01 .. 99999999.99 ] ^(\d{1,8})(\.\d{1,2})?$ The number of units requested |
declarationDate | string <date> The date to which the declaration is applicable. As requested by the employee. |
declarationComment | string or null <= 1000 characters The comment left by the employee |
reasonForDeviatingFromCalculatedDistance | string or null <= 1000 characters The reason why the employee deviated form the calculated distance. |
Array of objects or null 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. |
Responses
Request samples
- Payload
{- "payrollComponent": {
- "key": 11
}, - "calculatedDistanceByRoutingService": 8,
- "numberOfUnits": 8,
- "declarationDate": "2017-11-01",
- "declarationComment": "Overwerk project X",
- "reasonForDeviatingFromCalculatedDistance": "There were some ongoing road works i had to get around",
- "route": [
- {
- "pointOfInterest": {
- "name": "Van Spaendonck Groep"
}, - "address": {
- "freeformAddress": "Reitseplein 1, 5037 AA Tilburg",
- "countryCode": "NL"
}, - "position": {
- "latitude": 51.585996,
- "longitude": 5.585996
}
}
]
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollComponent": {
- "key": 11,
- "description": "UREN TVT 130%",
- "deviatingDescription": "Uren tijd voor tijd 130%",
- "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}, - "routeType": {
- "key": 1,
- "value": "Snelste"
}
}, - "calculatedDistanceByRoutingService": 8,
- "numberOfUnits": 8,
- "declarationDate": "2017-11-01",
- "declarationComment": "Overwerk project X",
- "declarationStatus": {
- "key": 1,
- "value": "Open"
}, - "dateOfSubmissionByEmployee": "2018-05-08T15:16:49+02:00",
- "dateOfLastChangeByEmployee": "2018-05-08T15:16:49+02:00",
- "processedInPayrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "reasonForDeviatingFromCalculatedDistance": "There were some ongoing road works i had to get around",
- "route": [
- {
- "pointOfInterest": {
- "name": "Van Spaendonck Groep"
}, - "address": {
- "freeformAddress": "Reitseplein 1, 5037 AA Tilburg",
- "countryCode": "NL"
}, - "position": {
- "latitude": 51.585996,
- "longitude": 5.585996
}
}
]
}
}
Details of a declaration
Activity name : GetDeclarationByDeclarationId
Get the details of a declaration
path Parameters
declarationId required | string <uuid> The unique identifier of the declaration |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollComponent": {
- "key": 11,
- "description": "UREN TVT 130%",
- "deviatingDescription": "Uren tijd voor tijd 130%",
- "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}, - "routeType": {
- "key": 1,
- "value": "Snelste"
}
}, - "calculatedDistanceByRoutingService": 8,
- "numberOfUnits": 8,
- "declarationDate": "2017-11-01",
- "declarationComment": "Overwerk project X",
- "declarationStatus": {
- "key": 1,
- "value": "Open"
}, - "dateOfSubmissionByEmployee": "2018-05-08T15:16:49+02:00",
- "dateOfLastChangeByEmployee": "2018-05-08T15:16:49+02:00",
- "processedInPayrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "reasonForDeviatingFromCalculatedDistance": "There were some ongoing road works i had to get around",
- "route": [
- {
- "pointOfInterest": {
- "name": "Van Spaendonck Groep"
}, - "address": {
- "freeformAddress": "Reitseplein 1, 5037 AA Tilburg",
- "countryCode": "NL"
}, - "position": {
- "latitude": 51.585996,
- "longitude": 5.585996
}
}
]
}
}
Edit a declaration for an employment
Activity name : PutDeclarationByDeclarationId
Edit a declaration for an employment. This is usually done by the employee.
path Parameters
declarationId required | string <uuid> The unique identifier of the declaration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object <metadata> 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. | |
calculatedDistanceByRoutingService | number or null <double> [ 0.01 .. 99999999.99 ] ^(\d{1,8})(\.\d{1,2})?$ The value calulated by the routing service |
numberOfUnits | number <double> [ 0.01 .. 99999999.99 ] ^(\d{1,8})(\.\d{1,2})?$ The number of units requested |
declarationDate | string <date> The date to which the declaration is applicable. As requested by the employee. |
declarationComment | string or null <= 1000 characters The comment left by the employee |
reasonForDeviatingFromCalculatedDistance | string or null <= 1000 characters The reason why the employee deviated form the calculated distance. |
Array of objects or null 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. |
Responses
Request samples
- Payload
{- "payrollComponent": {
- "key": 11
}, - "calculatedDistanceByRoutingService": 8,
- "numberOfUnits": 8,
- "declarationDate": "2017-11-01",
- "declarationComment": "Overwerk project X",
- "reasonForDeviatingFromCalculatedDistance": "There were some ongoing road works i had to get around",
- "route": [
- {
- "pointOfInterest": {
- "name": "Van Spaendonck Groep"
}, - "address": {
- "freeformAddress": "Reitseplein 1, 5037 AA Tilburg",
- "countryCode": "NL"
}, - "position": {
- "latitude": 51.585996,
- "longitude": 5.585996
}
}
]
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollComponent": {
- "key": 11,
- "description": "UREN TVT 130%",
- "deviatingDescription": "Uren tijd voor tijd 130%",
- "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}, - "routeType": {
- "key": 1,
- "value": "Snelste"
}
}, - "calculatedDistanceByRoutingService": 8,
- "numberOfUnits": 8,
- "declarationDate": "2017-11-01",
- "declarationComment": "Overwerk project X",
- "declarationStatus": {
- "key": 1,
- "value": "Open"
}, - "dateOfSubmissionByEmployee": "2018-05-08T15:16:49+02:00",
- "dateOfLastChangeByEmployee": "2018-05-08T15:16:49+02:00",
- "processedInPayrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "reasonForDeviatingFromCalculatedDistance": "There were some ongoing road works i had to get around",
- "route": [
- {
- "pointOfInterest": {
- "name": "Van Spaendonck Groep"
}, - "address": {
- "freeformAddress": "Reitseplein 1, 5037 AA Tilburg",
- "countryCode": "NL"
}, - "position": {
- "latitude": 51.585996,
- "longitude": 5.585996
}
}
]
}
}
Delete a declaration
Activity name : DeleteDeclarationByDeclarationId
Delete a declaration including attachment if applicable.
path Parameters
declarationId required | string <uuid> The unique identifier of the declaration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Audit trail of a declaration
Activity name : GetDeclarationAuditTrailByDeclarationId
Get the audit trail of a declaration
path Parameters
declarationId required | string <uuid> The unique identifier of the declaration |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "status": {
- "key": 1,
- "value": "Approved"
}, - "performedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "performedOn": "2017-11-01",
- "comment": "Approved"
}
]
}
Upload a receipt to analyze
Activity name : PostAnalyzeReceiptByEmploymentId
Post a receipt for OCR.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: multipart/form-datarequired
Document to be uploaded as attachment to the declaration.
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "confidence": 0.51,
- "boundingRegion": [
- 0
], - "merchantName": {
- "value": "string",
- "confidence": 0.73,
- "boundingRegion": [
- 0
]
}, - "total": {
- "value": 21.99,
- "confidence": 0.73,
- "boundingRegion": [
- 0
]
}, - "subTotal": {
- "value": 19.54,
- "confidence": 0.73,
- "boundingRegion": [
- 0
]
}, - "totalTax": {
- "value": 1.58,
- "confidence": 0.73,
- "boundingRegion": [
- 0
]
}, - "transactionDate": {
- "value": "2024-01-01",
- "confidence": 0.73,
- "boundingRegion": [
- 0
]
}, - "transactionTime": {
- "value": "16:49:02",
- "confidence": 0.73,
- "boundingRegion": [
- 0
]
}, - "payrollComponent": {
- "componentId": 1,
- "name": "Uren gewerkt",
- "deviatingDescription": "Uren tijd voor tijd 130%"
}
}
]
}
List of declarations for the employees of an employer
Activity name : GetDeclarationsByEmployerId
Returns a list of declarations for the employments of the employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employmentInformation": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "firstName": "Susan",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "incomeRelationshipNumber": 12,
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker"
}, - "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Directeur",
- "group": "internal"
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}
}, - "payrollComponent": {
- "key": 11,
- "description": "UREN TVT 130%",
- "deviatingDescription": "Uren tijd voor tijd 130%",
- "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}, - "routeType": {
- "key": 1,
- "value": "Snelste"
}
}, - "calculatedDistanceByRoutingService": 8,
- "numberOfUnits": 8,
- "declarationDate": "2017-11-01",
- "declarationComment": "Overwerk project X",
- "declarationStatus": {
- "key": 1,
- "value": "Open"
}, - "dateOfSubmissionByEmployee": "2018-05-08T15:16:49+02:00",
- "dateOfLastChangeByEmployee": "2018-05-08T15:16:49+02:00",
- "processedInPayrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "reasonForDeviatingFromCalculatedDistance": "There were some ongoing road works i had to get around",
- "route": [
- {
- "pointOfInterest": {
- "name": "Van Spaendonck Groep"
}, - "address": {
- "freeformAddress": "Reitseplein 1, 5037 AA Tilburg",
- "countryCode": "NL"
}, - "position": {
- "latitude": 51.585996,
- "longitude": 5.585996
}
}
]
}
]
}
Review (accept or reject) open declarations
Activity name : PatchReviewDeclarationsByDeclarationIds
Review (accept or reject) open declarations
Please check the description of the status-field in this resource to read about the workflow of declarations.
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
id required | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier (a GUID/UUID) |
action required | string Enum: "accept" "reject" The action to perform on the declaration resulting in a change of
|
Responses
Request samples
- Payload
[- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "action": "accept"
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Process approved declarations
Activity name : PatchProcessDeclarationsByDeclarationId
Process approved declarations into the payrolling data.
Please check the description of the status-field in this resource to read about the workflow of declarations.
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Request Body schema: application/json;version=2018-01-01required
id required | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier (a GUID/UUID) |
payrollPeriodId required | integer <int32> The year and period of the payroll period |
Responses
Request samples
- Payload
[- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriodId": 202004
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
NL: Declaraties/werknemermutaties bijlagen. Declarations (werknemermutaties) may have an attachment linked to it. (via Qwoater dossier)
Download attachment
Activity name : GetAttachmentByDeclarationId
Download the attachment (via Qwoater) for the given declarationId. In case no attachment is know the service will return a 404.
path Parameters
declarationId required | string <uuid> The unique identifier of the declaration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Responses
Response samples
- 401
- 403
{- "message": "Authorization has been denied for this request."
}
Upload attachment
Activity name : PostAttachmentByDeclarationId
Upload an attachment to a declaration. Via Qwoater.
path Parameters
declarationId required | string <uuid> The unique identifier of the declaration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Document to be uploaded as attachment to the declaration.
file | string base64 encoded document file. |
filename | string [ 1 .. 250 ] characters The name of the file. Qwoater: Filename |
Responses
Request samples
- Payload
{- "file": "YQ==",
- "filename": "BowlsJohn.pdf"
}
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Get a list of declarations with attachment
Activity name : GetDeclarationsWithAttachmentByEmployerId
Get a list of all declarationId's of declarations that have an attachment to it.
The attachment is stored in Qwoater, and thus on the background a call to Qwoater will be performed to check whether an attachment is available for a declaration.
If an attachment is available then a call may be performed to the attachment download endpoint to actually start downloading the attachment for this declaration.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "declarationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
]
}
Get a list of declarations with attachment
Activity name : GetDeclarationsWithAttachmentByEmploymentId
Get a list of all declarationId's of declarations that have an attachment to it.
The attachment is stored in Qwoater, and thus on the background a call to Qwoater will be performed to check whether an attachment is available for a declaration.
If an attachment is available then a call may be performed to the attachment download endpoint to actually start downloading the attachment for this declaration.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "declarationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
]
}
attachment indication for a set of declarationIds
Activity name : GetDeclarationsWithAttachmentByDeclarationIds
This endpoint returns from a set of declaration IDs, the declaration Ids for which an attachment is available
All declarationIds must belong to the same employerId.
Attachments 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.
query Parameters
declarationIds required | string <uuid> DeclarationIds for which the attachment is available. This parameter may be included multiple times to indicate multiple declarationIds. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "declarationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
]
}
Download employer dossier document
Activity name : GetDocumentByEmployerIdAndDocumentId
Download the file of a given employer dossier entry. Via Qwoater.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
documentId required | string The unique identifier of the employer dossier document |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Responses
Response samples
- 401
- 403
{- "message": "Authorization has been denied for this request."
}
Delete a document in the employer dossier
Activity name: DeleteDocumentByEmployerIdAndDocumentId
Delete a document in the employer dossier
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
documentId required | string The unique identifier of the employer dossier document |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Edit the details of an employer dossier document
Activity name: PutDocumentByEmployerIdAndDocumentId
Edit the details for a document in the employer dossier
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
documentId required | string The unique identifier of the employer dossier document |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Document record to edit.
description | string (EmployerDossier_components-schemas-description) [ 1 .. 250 ] characters The description defined by the submitter. Qwoater: Docfield 33 Omschrijving |
category | string <metadata> (category) <= 4000 characters The category of the document. Provided value must be a valid metadata option. Qwoater: DocumentType |
year | integer or null <int32> (components-schemas-year) [ 1000 .. 9999 ] The year the document relates to. Qwoater: Docfield 86 Jaar |
attribute | string or null (attribute) <= 250 characters The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk |
dateOfAlert | string or null <date> (dateOfAlert) The time at which document will alerted for cancellation. Qwoater: AlertDate |
Responses
Request samples
- Payload
{- "description": "Copy of id card",
- "category": "Arbeidsovereenkomst",
- "year": 2017,
- "attribute": "VSP004",
- "dateOfAlert": "2018-05-08"
}
Response samples
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Get a list of employer dossier documents
Activity name : GetDocumentsByEmployerId
Get a list of documents within the employer dossier (werkgeverdossier). Via Qwoater.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "qwoaterDocumentId": "",
- "description": "Copy of id card",
- "category": "Arbeidsovereenkomst",
- "year": 2017,
- "attribute": "VSP004",
- "dateOfSubmission": "2018-05-08",
- "dateOfAlert": "2018-05-08",
- "submittedBy": "Bowls, John",
- "isReadBy": {
- "provider": false,
- "employer": false,
- "departmentManager": false,
- "employee": false
}, - "filename": "BowlsJohn.pdf"
}
]
}
Upload a document to the employer dossier
Activity name : PostDocumentByEmployerId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata
to the POST URL.
Upload a document within the employer dossier (werkgeverdossier). Via Qwoater.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Document to be uploaded for the employer.
description | string (EmployerDossier_components-schemas-description) [ 1 .. 250 ] characters The description defined by the submitter. Qwoater: Docfield 33 Omschrijving |
category | string <metadata> (category) <= 4000 characters The category of the document. Provided value must be a valid metadata option. Qwoater: DocumentType |
year | integer or null <int32> (components-schemas-year) [ 1000 .. 9999 ] The year the document relates to. Qwoater: Docfield 86 Jaar |
attribute | string or null (attribute) <= 250 characters The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk |
dateOfAlert | string or null <date> (dateOfAlert) The time at which document will alerted for cancellation. Qwoater: AlertDate |
file | string (file) base64 encoded document file. |
sendEmailNotification | boolean or null (sendEmailNotification) Indicate whether to send an email to the employees. |
Responses
Request samples
- Payload
{- "description": "Copy of id card",
- "category": "Arbeidsovereenkomst",
- "year": 2017,
- "attribute": "VSP004",
- "dateOfAlert": "2018-05-08",
- "file": "YQ==",
- "sendEmailNotification": true
}
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Get audittrail for the document in the employer dossier
Activity name : GetAuditTrailByEmployerIdAndDocumentId
Get audittrail for the document in the employer dossier.
path Parameters
documentId required | string The unique identifier of the employer dossier document |
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "eventDate": "2018-05-08T15:16:49+02:00",
- "event": "Audittrail opgevraagd",
- "endUser": "Hur, Ben",
- "role": "Provider",
- "category": "",
- "year": "2020",
- "attribute": "",
- "description": "VSP004",
- "dateOfAlert": "2018-05-08"
}
]
}
Get a list of employment dossier documents
Activity name : GetDocumentsByEmploymentId
Get a list of documents within the employee's employment dossier (werknemerdossier). Via Qwoater.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "qwoaterDocumentId": "",
- "description": "Copy of id card",
- "category": "Arbeidsovereenkomst",
- "year": 2017,
- "attribute": "VSP004",
- "dateOfSubmission": "2018-05-08",
- "dateOfAlert": "2018-05-08",
- "submittedBy": "Bowls, John",
- "isReadBy": {
- "provider": false,
- "employer": false,
- "departmentManager": false,
- "employee": false
}, - "filename": "BowlsJohn.pdf",
- "signDocumentStatus": {
- "key": "Se",
- "value": "Onderteken-verzoek verzonden"
}, - "isInitiateSignDocumentRequestPossible": true
}
]
}
Upload a document to the employment dossier
Activity name : PostDocumentByEmploymentId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata
to the POST URL.
Upload a document within the employee's employment dossier (werknemerdossier). Via Qwoater.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Document to be uploaded for the employment.
description | string [ 1 .. 250 ] characters The description defined by the submitter. Qwoater: Docfield 33 Omschrijving |
category | string <metadata> <= 4000 characters The category of the document. Provided value must be a valid metadata option. Qwoater: DocumentType |
year | integer or null <int32> [ 1000 .. 9999 ] The year the document relates to. Qwoater: Docfield 86 Jaar |
attribute | string or null <= 250 characters The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk |
dateOfAlert | string or null <date> The time at which document will alerted for cancellation. Qwoater: AlertDate |
filename | string [ 1 .. 255 ] characters The name of the file. Qwoater: Filename |
file | string base64 encoded document file. |
sendEmailNotification | boolean or null Default: false Indicate whether to send an email to the employee. |
Responses
Request samples
- Payload
{- "description": "Copy of id card",
- "category": "Arbeidsovereenkomst",
- "year": 2017,
- "attribute": "VSP004",
- "dateOfAlert": "2018-05-08",
- "filename": "BowlsJohn.pdf",
- "file": "YQ==",
- "sendEmailNotification": true
}
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Download employment dossier document
Activity name : GetDocumentByEmploymentIdAndDocumentId
Download the file of a given employment dossier entry. Via Qwoater.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
documentId required | string The unique identifier of the employment dossier document |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Responses
Response samples
- 401
- 403
{- "message": "Authorization has been denied for this request."
}
Delete a document in the employment dossier
Activity name: DeleteDocumentByEmploymentIdAndDocumentId
Delete a document in the employment dossier
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
documentId required | string The unique identifier of the employment dossier document |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Edit the details of an employment dossier document
Activity name: PutDocumentByEmploymentIdAndDocumentId
Edit the details for a document in the employment dossier
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
documentId required | string The unique identifier of the employment dossier document |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Document record to edit.
description | string [ 1 .. 250 ] characters The description defined by the submitter. Qwoater: Docfield 33 Omschrijving |
category | string <metadata> <= 4000 characters The category of the document. Provided value must be a valid metadata option. Qwoater: DocumentType |
year | integer or null <int32> [ 1000 .. 9999 ] The year the document relates to. Qwoater: Docfield 86 Jaar |
attribute | string or null <= 250 characters The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk |
dateOfAlert | string or null <date> The time at which document will alerted for cancellation. Qwoater: AlertDate |
Responses
Request samples
- Payload
{- "description": "Copy of id card",
- "category": "Arbeidsovereenkomst",
- "year": 2017,
- "attribute": "VSP004",
- "dateOfAlert": "2018-05-08"
}
Response samples
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Get audittrail for the document in the employment dossier
Activity name : GetAuditTrailByEmploymentIdAndDocumentId
Get audittrail for the document in the employment dossier.
path Parameters
documentId required | string The unique identifier of the employment dossier document |
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "eventDate": "2018-05-08T15:16:49+02:00",
- "event": "Audittrail opgevraagd",
- "endUser": "Hur, Ben",
- "role": "Provider",
- "category": "",
- "year": "2020",
- "attribute": "",
- "description": "VSP004",
- "dateOfAlert": "2018-05-08"
}
]
}
Download concept employee dossier document
Activity name : GetDocumentByConceptEmployeeIdAndDocumentId
Download the file of a given concept employee dossier entry. Via Qwoater.
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
documentId required | string The unique identifier of the employment dossier document |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Responses
Response samples
- 401
- 403
{- "message": "Authorization has been denied for this request."
}
Delete a document in the concept employee dossier
Activity name: DeleteDocumentByConceptEmployeeIdAndDocumentId
Delete a document in the concept employee dossier
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
documentId required | string The unique identifier of the employment dossier document |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Edit the details of an concept employee dossier document
Activity name: PutDocumentByConceptEmployeeIdAndDocumentId
Edit the details for a document in the concept employee dossier
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
documentId required | string The unique identifier of the employment dossier document |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Document record to edit.
description | string [ 1 .. 250 ] characters The description defined by the submitter. Qwoater: Docfield 33 Omschrijving |
category | string <metadata> <= 4000 characters The category of the document. Provided value must be a valid metadata option. Qwoater: DocumentType |
year | integer or null <int32> [ 1000 .. 9999 ] The year the document relates to. Qwoater: Docfield 86 Jaar |
attribute | string or null <= 250 characters The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk |
dateOfAlert | string or null <date> The time at which document will alerted for cancellation. Qwoater: AlertDate |
Responses
Request samples
- Payload
{- "description": "Copy of id card",
- "category": "Arbeidsovereenkomst",
- "year": 2017,
- "attribute": "VSP004",
- "dateOfAlert": "2018-05-08"
}
Response samples
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Get a list of concept employee dossier documents
Activity name : GetDocumentsByConceptEmployeeId
Get a list of documents within the concept employee's dossier (werknemerdossier). Via Qwoater.
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "qwoaterDocumentId": "",
- "description": "Copy of id card",
- "category": "Arbeidsovereenkomst",
- "year": 2017,
- "attribute": "VSP004",
- "dateOfSubmission": "2018-05-08",
- "dateOfAlert": "2018-05-08",
- "submittedBy": "Bowls, John",
- "isReadBy": {
- "provider": false,
- "employer": false,
- "departmentManager": false,
- "employee": false
}, - "filename": "BowlsJohn.pdf",
- "signDocumentStatus": {
- "key": "Se",
- "value": "Onderteken-verzoek verzonden"
}, - "isInitiateSignDocumentRequestPossible": true
}
]
}
Upload a document to the concept employee dossier
Activity name : PostDocumentByConceptEmployeeId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata
to the POST URL.
Upload a document within the concept employee's dossier (werknemerdossier). Via Qwoater.
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Document to be uploaded for the concept employee.
description | string [ 1 .. 250 ] characters The description defined by the submitter. Qwoater: Docfield 33 Omschrijving |
category | string <metadata> <= 4000 characters The category of the document. Provided value must be a valid metadata option. Qwoater: DocumentType |
year | integer or null <int32> [ 1000 .. 9999 ] The year the document relates to. Qwoater: Docfield 86 Jaar |
attribute | string or null <= 250 characters The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk |
dateOfAlert | string or null <date> The time at which document will alerted for cancellation. Qwoater: AlertDate |
filename | string [ 1 .. 255 ] characters The name of the file. Qwoater: Filename |
file | string base64 encoded document file. |
Responses
Request samples
- Payload
{- "description": "Copy of id card",
- "category": "Arbeidsovereenkomst",
- "year": 2017,
- "attribute": "VSP004",
- "dateOfAlert": "2018-05-08",
- "filename": "BowlsJohn.pdf",
- "file": "YQ=="
}
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Get audittrail for the document in the concept employee dossier
Activity name : GetAuditTrailByConceptEmployeeIdAndDocumentId
Get audittrail for the document in the concept employee dossier.
path Parameters
documentId required | string The unique identifier of the employment dossier document |
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "eventDate": "2018-05-08T15:16:49+02:00",
- "event": "Audittrail opgevraagd",
- "endUser": "Hur, Ben",
- "role": "Provider",
- "category": "",
- "year": "2020",
- "attribute": "",
- "description": "VSP004",
- "dateOfAlert": "2018-05-08"
}
]
}
Document count
Activity name : GetDocumentCountByConceptEmployeeId
Get a count of the number of documents in the dossier. Via Qwoater.
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "numberOfDocuments": 7
}
}
Delete the complete concept employee dossier
Activity name: DeleteDossierByConceptEmployeeId
Delete a complete dossier, with all documents in it, for the concept employee
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download template document
Activity name : GetDocumentTemplateByEmployerIdAndDocumentId
Download the document template of a given template entry. Via Qwoater.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
documentId required | string The unique identifier of the document template |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Responses
Response samples
- 401
- 403
{- "message": "Authorization has been denied for this request."
}
Delete a document template in the employer dossier
Activity name: DeleteDocumentTemplateByEmployerIdAndDocumentId
Delete a document template in the employer dossier
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
documentId required | string The unique identifier of the document template |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Edit the details of an document template
Activity name: PutDocumentTemplateByEmployerIdAndDocumentId
Edit the details for a document template in the employer dossier
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
documentId required | string The unique identifier of the document template |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Document template record to edit.
description | string [ 1 .. 250 ] characters The description defined by the submitter. Qwoater: Docfield 33 Omschrijving |
year | integer or null <int32> [ 1000 .. 9999 ] The year the document relates to. Qwoater: Docfield 86 Jaar |
attribute | string or null <= 250 characters The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk |
dateOfAlert | string or null <date> The time at which document will alerted for cancellation. Qwoater: AlertDate |
Responses
Request samples
- Payload
{- "description": "Copy of id card",
- "year": 2017,
- "attribute": "VSP004",
- "dateOfAlert": "2018-05-08"
}
Response samples
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Get a list of document templates
Activity name : GetDocumentTemplatesByEmployerId
Get a list of document templates within the employer dossier (werkgeverdossier). Via Qwoater. Note that the 'category' field contains the category of the template.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "qwoaterDocumentId": "",
- "description": "Copy of id card",
- "year": 2017,
- "attribute": "VSP004",
- "dateOfAlert": "2018-05-08",
- "targetCategory": "Arbeidsovereenkomst",
- "dateOfSubmission": "2018-05-08",
- "filename": "BowlsJohn.pdf"
}
]
}
Upload a document template to the employer dossier
Activity name : PostDocumentTemplateByEmployerId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata
to the POST URL.
Upload a document template within the employer dossier (werkgeverdossier). Via Qwoater.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Document template to be uploaded for the employer.
description | string [ 1 .. 250 ] characters The description defined by the submitter. Qwoater: Docfield 33 Omschrijving |
year | integer or null <int32> [ 1000 .. 9999 ] The year the document relates to. Qwoater: Docfield 86 Jaar |
attribute | string or null <= 250 characters The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk |
dateOfAlert | string or null <date> The time at which document will alerted for cancellation. Qwoater: AlertDate |
targetCategory | string <metadata> <= 4000 characters 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 |
filename | string [ 1 .. 255 ] characters The name of the file. Qwoater: Filename |
file | string base64 encoded document file. |
Responses
Request samples
- Payload
{- "description": "Copy of id card",
- "year": 2017,
- "attribute": "VSP004",
- "dateOfAlert": "2018-05-08",
- "targetCategory": "Arbeidsovereenkomst",
- "filename": "BowlsJohn.pdf",
- "file": "YQ=="
}
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Generate a document for an employment - preview
Activity name : PostGenerateDocumentPreviewByEmploymentIdAndDocumentId
Metadata: Available templates can be acquired(GET) at Employer level(/v2/providers/employers/{employerId}/documenttemplates/generatedocument/metadata).
Generate a document for an employment and receive a preview. Via Qwoater.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
documentId required | string Example: P123456789 The unique identifier of the template |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Metadata for the document to be generated.
description | string [ 1 .. 250 ] characters The description defined by the submitter. Qwoater: Docfield 33 Omschrijving |
year | integer or null <int32> [ 1000 .. 9999 ] The year the document relates to. Qwoater: Docfield 86 Jaar |
attribute | string or null <= 250 characters The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk |
dateOfAlert | string or null <date> The date at which document will alerted for cancellation. Qwoater: AlertDate |
filename | string [ 1 .. 250 ] characters The name of the file. Qwoater: Filename |
templateEmployerId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of the employer to which the template belongs (GUID/UUID). |
referenceDate | string <date> This date will be used to select date depending data such as department and function. |
Responses
Request samples
- Payload
{- "description": "Copy of id card",
- "year": 2017,
- "attribute": "VSP004",
- "dateOfAlert": "2018-05-08",
- "filename": "BowlsJohn.pdf",
- "templateEmployerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "referenceDate": "2020-05-08"
}
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Generate a document for an employment
Activity name : PostGenerateDocumentByEmploymentIdAndDocumentId
Metadata: Available templates can be acquired(GET) at Employer level(/v2/providers/employers/{employerId}/documenttemplates/generatedocument/metadata).
Generate a document for an employment and store it in the employment dossier. Via Qwoater.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
documentId required | string Example: P123456789 The unique identifier of the template |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Metadata for the document to be generated.
description | string [ 1 .. 250 ] characters The description defined by the submitter. Qwoater: Docfield 33 Omschrijving |
year | integer or null <int32> [ 1000 .. 9999 ] The year the document relates to. Qwoater: Docfield 86 Jaar |
attribute | string or null <= 250 characters The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk |
dateOfAlert | string or null <date> The date at which document will alerted for cancellation. Qwoater: AlertDate |
filename | string [ 1 .. 250 ] characters The name of the file. Qwoater: Filename |
templateEmployerId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of the employer to which the template belongs (GUID/UUID). |
referenceDate | string <date> This date will be used to select date depending data such as department and function. |
sendEmailNotification | boolean or null Default: false Indicate whether to send an email to the employee. |
Responses
Request samples
- Payload
{- "description": "Copy of id card",
- "year": 2017,
- "attribute": "VSP004",
- "dateOfAlert": "2018-05-08",
- "filename": "BowlsJohn.pdf",
- "templateEmployerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "referenceDate": "2020-05-08",
- "sendEmailNotification": true
}
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Generate a document for an concept employee - preview
Activity name : PostGenerateDocumentPreviewByConceptEmployeeIdAndDocumentId
Metadata: Available templates can be acquired(GET) at Employer level(/v2/providers/employers/{employerId}/documenttemplates/generatedocument/metadata).
Generate a document for an concept employee and receive a preview. Via Qwoater.
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
documentId required | string Example: P123456789 The unique identifier of the template |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Metadata for the document to be generated.
description | string [ 1 .. 250 ] characters The description defined by the submitter. Qwoater: Docfield 33 Omschrijving |
year | integer or null <int32> [ 1000 .. 9999 ] The year the document relates to. Qwoater: Docfield 86 Jaar |
attribute | string or null <= 250 characters The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk |
dateOfAlert | string or null <date> The date at which document will alerted for cancellation. Qwoater: AlertDate |
filename | string [ 1 .. 250 ] characters The name of the file. Qwoater: Filename |
templateEmployerId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of the employer to which the template belongs (GUID/UUID). |
referenceDate | string <date> This date will be used to select date depending data such as department and function. |
Responses
Request samples
- Payload
{- "description": "Copy of id card",
- "year": 2017,
- "attribute": "VSP004",
- "dateOfAlert": "2018-05-08",
- "filename": "BowlsJohn.pdf",
- "templateEmployerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "referenceDate": "2020-05-08"
}
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Generate a document for an concept employee
Activity name : PostGenerateDocumentByConceptEmployeeIdAndDocumentId
Metadata: Available templates can be acquired(GET) at Employer level(/v2/providers/employers/{conceptEmployeeId}/documenttemplates/generatedocument/metadata).
Generate a document for an concept employee and store it in the employment dossier. Via Qwoater.
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
documentId required | string Example: P123456789 The unique identifier of the template |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Metadata for the document to be generated.
description | string [ 1 .. 250 ] characters The description defined by the submitter. Qwoater: Docfield 33 Omschrijving |
year | integer or null <int32> [ 1000 .. 9999 ] The year the document relates to. Qwoater: Docfield 86 Jaar |
attribute | string or null <= 250 characters The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk |
dateOfAlert | string or null <date> The date at which document will alerted for cancellation. Qwoater: AlertDate |
filename | string [ 1 .. 250 ] characters The name of the file. Qwoater: Filename |
templateEmployerId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of the employer to which the template belongs (GUID/UUID). |
referenceDate | string <date> This date will be used to select date depending data such as department and function. |
Responses
Request samples
- Payload
{- "description": "Copy of id card",
- "year": 2017,
- "attribute": "VSP004",
- "dateOfAlert": "2018-05-08",
- "filename": "BowlsJohn.pdf",
- "templateEmployerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "referenceDate": "2020-05-08"
}
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Generate documents for selected employments
Activity name : PostGenerateDocumentsByEmployerIdAndDocumentId
Metadata: Available templates can be acquired(GET) at Employer level(/v2/providers/employers/{employerId}/documenttemplates/generatedocument/metadata).
Generate documents for a selection of employments and store it in the employment dossier. Via Qwoater. (One document is generated and stored for each selected employment)
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
documentId required | string Example: P123456789 The unique identifier of the template |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Metadata for the document to be generated.
description | string [ 1 .. 250 ] characters The description defined by the submitter. Qwoater: Docfield 33 Omschrijving |
year | integer or null <int32> [ 1000 .. 9999 ] The year the document relates to. Qwoater: Docfield 86 Jaar |
attribute | string or null <= 250 characters The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk |
dateOfAlert | string or null <date> The date at which document will alerted for cancellation. Qwoater: AlertDate |
filename | string [ 1 .. 250 ] characters The name of the file. Qwoater: Filename |
templateEmployerId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of the employer to which the template belongs (GUID/UUID). |
referenceDate | string <date> This date will be used to select date depending data such as department and function. |
sendEmailNotification | boolean or null Default: false Indicate whether to send an email to the employees. |
employmentIds | Array of strings <uuid> [ items <uuid >^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... ] |
Responses
Request samples
- Payload
{- "description": "Copy of id card",
- "year": 2017,
- "attribute": "VSP004",
- "dateOfAlert": "2018-05-08",
- "filename": "BowlsJohn.pdf",
- "templateEmployerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "referenceDate": "2020-05-08",
- "sendEmailNotification": true,
- "employmentIds": [
- "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
]
}
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Download signature report for an employer
Activity name : GetSignatureReportByEmployerId
Require an excel file containing information on document signature requests.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
startDate required | string <date> Example: startDate=2023-01-01 The report will include document signatures which were started on or after the startdate |
endDate required | string <date> Example: endDate=2023-01-01 The report will include document signatures which were started on or before the enddate |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Initiate signature - Employment
Activity name : PostInitiateSignatureByEmploymentIdAndDocumentId
Metadata: No metadata available. Defaults are available by adding /defaults to the path.
Initiate the proces to sign a document for an employment by one or more signers.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
documentId required | string Example: P123456789 The unique identifier of the template |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Contactinformation of the signers.
emailAddress | string [ 1 .. 255 ] The email address of the signer. |
name | string [ 1 .. 255 ] The name of the signer |
mobilePhoneNumber | string The mobile phone number of the signer. In E.164 format |
signingOrder | integer or null 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. |
Responses
Request samples
- Payload
[- {
- "name": "Ben Hur",
- "mobilePhoneNumber": "+31612345678",
- "signingOrder": "2"
}
]
Response samples
- 200
- 400
- 401
- 403
{- "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "signDocumentStatus": {
- "Key": "Ne",
- "Value": "Nieuw onderteken-verzoek"
}
}
}
Signature details - Employment
Activity name : GetSignatureByEmploymentIdAndDocumentId
Metadata: No metadata available.
Retrieve the status of the signing.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
documentId required | string Example: P123456789 The unique identifier of the template |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": {
- "signDocumentStatus": {
- "Key": "Ne",
- "Value": "Nieuw onderteken-verzoek"
}, - "signerStatus": [
- {
- "declined": true,
- "emailed": true,
- "signed": true,
- "viewed": true,
- "signedOnDate": "2021-02-24T08:20:33.105668Z",
- "name": "Ben Hur"
}
]
}
}
Delete signature - Employment
Activity name : DeleteSignatureByEmploymentIdAndDocumentId
Metadata: No metadata available.
Delete the proces to sign a document for an employment.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
documentId required | string Example: P123456789 The unique identifier of the template |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Retrieve the report of the signing - Employment
Activity name : GetSignatureReportByEmploymentIdAndDocumentId
Metadata: No metadata available.
Report of the signature.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
documentId required | string Example: P123456789 The unique identifier of the template |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Initiate signature - Conceptemployee
Activity name : PostInitiateSignatureByConceptEmployeeIdAndDocumentId
Metadata: No metadata available. Defaults are available by adding /defaults to the path.
Initiate the proces to sign a document for an employment by one or more signers.
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
documentId required | string Example: P123456789 The unique identifier of the template |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Contactinformation of the signers.
emailAddress | string [ 1 .. 255 ] The email address of the signer. |
name | string [ 1 .. 255 ] The name of the signer |
mobilePhoneNumber | string The mobile phone number of the signer. In E.164 format |
signingOrder | integer or null 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. |
Responses
Request samples
- Payload
[- {
- "name": "Ben Hur",
- "mobilePhoneNumber": "+31612345678",
- "signingOrder": "2"
}
]
Response samples
- 200
- 400
- 401
- 403
{- "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "signDocumentStatus": {
- "Key": "Ne",
- "Value": "Nieuw onderteken-verzoek"
}
}
}
Signature details - Conceptemployee
Activity name : GetSignatureByConceptEmployeeIdAndDocumentId
Metadata: No metadata available.
Retrieve the status of the signing.
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
documentId required | string Example: P123456789 The unique identifier of the template |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": {
- "signDocumentStatus": {
- "Key": "Ne",
- "Value": "Nieuw onderteken-verzoek"
}, - "signerStatus": [
- {
- "declined": true,
- "emailed": true,
- "signed": true,
- "viewed": true,
- "signedOnDate": "2021-02-24T08:20:33.105668Z",
- "name": "Ben Hur"
}
]
}
}
Delete signature - Conceptemployee
Activity name : DeleteSignatureByConceptEmployeeIdAndDocumentId
Metadata: No metadata available.
Delete the proces to sign a document for an Conceptemployee.
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
documentId required | string Example: P123456789 The unique identifier of the template |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Retrieve the report of the signing - Conceptemployee
Activity name : GetSignatureReportByConceptEmployeeIdAndDocumentId
Metadata: No metadata available.
Report of the signature.
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
documentId required | string Example: P123456789 The unique identifier of the template |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
List of authorizations
Activity name : GetDossierAuthorizationsByEmployerId
Get the authorizations per role and per category. Via Qwoater.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "category": "Arbeidsovereenkomst",
- "isAuthorizaionEditRestricted": true,
- "isTemplate": true,
- "canWrite": {
- "provider": true,
- "employer": false,
- "departmentManager": false,
- "employee": false
}
}
]
}
Edit the authorization matrix
Activity name: PutDossierAuthorizationsByEmployerId
Edit the authorizations. Categories not included in de request will be set to inaccessible for all roles.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/jsonrequired
The request body contains an array of objects containing a employment
and an action
field.
category | string The category |
object This object describes the authorization per category for each role. |
Responses
Request samples
- Payload
[- {
- "category": "Arbeidsovereenkomst",
- "canWrite": {
- "provider": true,
- "employer": false,
- "departmentManager": false,
- "employee": false
}
}
]
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Generate complete dossier
Activity name: PostInitiateCompleteDossierByEmployerId
Initiate the proces to generate a zip file containing the complete dossier. (via Qwoater)
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 202
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
]
}
Delete complete dossier
Activity name: DeleteCompleteDossierByEmployerId
Delete all documents in the dossier of an employer and the underlying employments
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download dossier information for an employer
Activity name : GetDossierReportByEmployerId
Get an excel containing information about all documents for an employer and underlying employments.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
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.
List of download requests for an employment
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.
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "year": 2017,
- "downloadRequestStatus": {
- "key": 2,
- "value": "Bestand aangemaakt"
}, - "requestTime": "2018-05-08T15:16:49+02:00",
- "processingFinishedTime": "2018-05-09T15:16:49+02:00",
- "expirationTime": "2018-05-16T15:16:49+02:00",
- "latestDownloadTime": "2018-05-09T15:16:49+02:00",
- "filename": "WerkgeverDownload.rar"
}
]
}
Create a download request
Activity name: PostDownloadRequestByBearerToken
Create a download request for an employment
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Download request to add to the employment.
year | integer <int32> [ 2000 .. 9999 ] The year of the download request relates to |
Responses
Request samples
- Payload
{- "year": 2017
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "year": 2017,
- "downloadRequestStatus": {
- "key": 2,
- "value": "Bestand aangemaakt"
}, - "requestTime": "2018-05-08T15:16:49+02:00",
- "processingFinishedTime": "2018-05-09T15:16:49+02:00",
- "expirationTime": "2018-05-16T15:16:49+02:00",
- "latestDownloadTime": "2018-05-09T15:16:49+02:00",
- "filename": "WerkgeverDownload.rar"
}
}
Details of a download request record
Activity name: GetDownloadRequestByDownloadRequestId
Get the details of a download request record
path Parameters
downloadRequestId required | string <uuid> The unique identifier of the downloadRequest |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "year": 2017,
- "downloadRequestStatus": {
- "key": 2,
- "value": "Bestand aangemaakt"
}, - "requestTime": "2018-05-08T15:16:49+02:00",
- "processingFinishedTime": "2018-05-09T15:16:49+02:00",
- "expirationTime": "2018-05-16T15:16:49+02:00",
- "latestDownloadTime": "2018-05-09T15:16:49+02:00",
- "filename": "WerkgeverDownload.rar"
}
}
Delete a specific download request record
Activity name: DeleteDownloadRequestByDownloadRequestId
Delete a download request for the employment
path Parameters
downloadRequestId required | string <uuid> The unique identifier of the downloadRequest |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download file of download request
Activity name: GetFileByDownloadRequestId
Download the file of a download request record
path Parameters
downloadRequestId required | string <uuid> The unique identifier of the downloadRequest |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
NL: EmailIdenties die kunnen worden gebruikt als afzender bij het versturen van email.
List of EmailIdentities for a provider
Activity name: GetEmailIdentitiesByProviderId
Get the list of EmailIdentities for a provider.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "emailIdentity": "provider.com",
- "emailIdentityType": "DOMAIN",
- "isSpfVerified": true,
- "isDkimVerified": true,
- "lastDkimVerifiedOn": "2022-01-31",
- "lastSpfVerifiedOn": "2022-01-31",
- "dkimTokens": [
- "u6deqmqhlgn3wxslcp4cugcz7ognh4gt"
]
}
]
}
Create an EmailIdentity for a provider
Activity name: PostEmailIdentityByProviderId
Create an EmailIdentity for a provider.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
EmailIdentity to add to the provider.
emailIdentity | string The emailIdentity that can be used when sending email. |
Responses
Request samples
- Payload
{- "emailIdentity": "provider.com"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "emailIdentity": "provider.com",
- "emailIdentityType": "DOMAIN",
- "isSpfVerified": true,
- "isDkimVerified": true,
- "lastDkimVerifiedOn": "2022-01-31",
- "lastSpfVerifiedOn": "2022-01-31",
- "dkimTokens": [
- "u6deqmqhlgn3wxslcp4cugcz7ognh4gt"
]
}
}
Delete an EmailIdentity for a provider
Activity name: DeleteProviderEmailIdentityByEmailIdentityId
Delete an EmailIdentity for a provider. An EmailIdentity can only be deleted when it's not used in an emailTemplate.
path Parameters
emailIdentityId required | string <uuid> The emailIdentity. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Provider emailIdentity test email
Activity name: PostSendProviderTestemailByEmailIdentityId
Send an email to test the email identity configuration.
path Parameters
emailIdentityId required | string <uuid> The emailIdentity. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
to | string The emailadres to which a test email should be send. |
Responses
Request samples
- Payload
{- "to": "[email protected]"
}
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Verify an EmailIdentity for a provider
Activity name: PostVerifyEmailIdentityByProviderId
Verify an EmailIdentity for a provider. The verficationstatus will we saved and used by Loket when sending email.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
EmailIdentity to Verify.
emailIdentity | string The emailIdentity that can be used when sending email. |
Responses
Request samples
- Payload
{- "emailIdentity": "provider.com"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "emailIdentity": "provider.com",
- "emailIdentityType": "DOMAIN",
- "isSpfVerified": true,
- "isDkimVerified": true,
- "lastDkimVerifiedOn": "2022-01-31",
- "lastSpfVerifiedOn": "2022-01-31",
- "dkimTokens": [
- "u6deqmqhlgn3wxslcp4cugcz7ognh4gt"
]
}
}
NL: Email Identies die kunnen worden gebruikt als afzender bij het versturen van email.
List of EmailIdentities for an employer
Activity name: GetEmailIdentitiesByEmployerId
Get the list of EmailIdentities for an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "emailIdentity": "provider.com",
- "emailIdentityType": "DOMAIN",
- "isSpfVerified": true,
- "isDkimVerified": true,
- "lastDkimVerifiedOn": "2022-01-31",
- "lastSpfVerifiedOn": "2022-01-31",
- "dkimTokens": [
- "u6deqmqhlgn3wxslcp4cugcz7ognh4gt"
]
}
]
}
Create an EmailIdentity for an employer
Activity name: PostEmailIdentityByEmployerId
Create an EmailIdentity for an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
EmailIdentity to add to the employer.
emailIdentity | string The emailIdentity that can be used when sending email. |
Responses
Request samples
- Payload
{- "emailIdentity": "provider.com"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "emailIdentity": "provider.com",
- "emailIdentityType": "DOMAIN",
- "isSpfVerified": true,
- "isDkimVerified": true,
- "lastDkimVerifiedOn": "2022-01-31",
- "lastSpfVerifiedOn": "2022-01-31",
- "dkimTokens": [
- "u6deqmqhlgn3wxslcp4cugcz7ognh4gt"
]
}
}
Delete an EmailIdentity for an employer
Activity name: DeleteEmployerEmailIdentityByEmailIdentityId
Delete an EmailIdentity for an employer. An EmailIdentity can only be deleted when it's not used in an emailTemplate.
path Parameters
emailIdentityId required | string <uuid> The emailIdentity. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Employer emailIdentity test email
Activity name: PostSendEmployerTestemailByEmailIdentityId
Send an email to test the email identity configuration.
path Parameters
emailIdentityId required | string <uuid> The emailIdentity. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
to | string The emailadres to which a test email should be send. |
Responses
Request samples
- Payload
{- "to": "[email protected]"
}
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Verify an EmailIdentity for an employer
Activity name: PostVerifyEmailIdentityByEmployerId
Verify an EmailIdentity for an employer. The verficationstatus will we saved and used by Loket when sending email.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
EmailIdentity to Verify.
emailIdentity | string The emailIdentity that can be used when sending email. |
Responses
Request samples
- Payload
{- "emailIdentity": "provider.com"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "emailIdentity": "provider.com",
- "emailIdentityType": "DOMAIN",
- "isSpfVerified": true,
- "isDkimVerified": true,
- "lastDkimVerifiedOn": "2022-01-31",
- "lastSpfVerifiedOn": "2022-01-31",
- "dkimTokens": [
- "u6deqmqhlgn3wxslcp4cugcz7ognh4gt"
]
}
}
List email templates for an provider
Activity name : GetEmailTemplatesByProviderId
Get a list of the email templates for an provider.
Note: Email templates can be defined on employer, provider and loket level. This endpoint returns for each emailtype the email template which is currently in use for the provider.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "type": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlofaanvraag behandeld (voor de indiener)",
- "sortOrder": 210
}, - "category": {
- "key": 3,
- "value": "Verlof"
}, - "email": {
- "subject": "Verlofaanvraag behandeld",
- "body": "Je verlofaanvraag is behandeld.",
- "senderEmail": "[email protected]"
}, - "dependsOnModule": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlof"
}, - "definedAtLevel": "provider",
- "isEmailTemplateEditable": true
}
]
}
Details of an provider email template
Activity name : GetEmailTemplateByProviderIdAndEmailTemplateId
Get the details of an email template. The available email template placeholders can be aquired by adding /metadata to the url.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
emailTemplateId required | string <uuid> The unique identifier of the email template record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "type": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlofaanvraag behandeld (voor de indiener)",
- "sortOrder": 210
}, - "category": {
- "key": 3,
- "value": "Verlof"
}, - "email": {
- "subject": "Verlofaanvraag behandeld",
- "body": "Je verlofaanvraag is behandeld.",
- "senderEmail": "[email protected]"
}, - "dependsOnModule": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlof"
}, - "definedAtLevel": "provider",
- "isEmailTemplateEditable": true
}
]
}
Edit an email template record at provider level
Activity name : PutEmailTemplateByProviderIdAndEmailTemplateId
Edit the email template. The subject, body and senderEmail can be editted.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
emailTemplateId required | string <uuid> The unique identifier of the email template record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
subject | string [ 1 .. 512 ] characters The subjectline of the email. |
body | string [ 1 .. 6000 ] characters The body text of the email. |
senderEmail | string [ 1 .. 255 ] characters The email address of the sender. |
Responses
Request samples
- Payload
{- "subject": "Verlofaanvraag behandeld",
- "body": "Je verlofaanvraag is behandeld.",
- "senderEmail": "[email protected]"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "type": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlofaanvraag behandeld (voor de indiener)",
- "sortOrder": 210
}, - "category": {
- "key": 3,
- "value": "Verlof"
}, - "email": {
- "subject": "Verlofaanvraag behandeld",
- "body": "Je verlofaanvraag is behandeld.",
- "senderEmail": "[email protected]"
}, - "dependsOnModule": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlof"
}, - "definedAtLevel": "provider",
- "isEmailTemplateEditable": true
}
}
Delete an email template record
Activity name : DeleteEmailTemplateByProviderIdAndEmailTemplateId
Delete an existing provider email template record
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
emailTemplateId required | string <uuid> The unique identifier of the email template record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List email templates for an employer
Activity name : GetEmailTemplatesByEmployerId
Get a list of the email templates for an employer.
Note: Email templates can be defined on employer, provider and loket level. This endpoint returns for each emailtype the email template which is currently in use for the employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "type": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlofaanvraag behandeld (voor de indiener)",
- "sortOrder": 210
}, - "category": {
- "key": 3,
- "value": "Verlof"
}, - "email": {
- "subject": "Verlofaanvraag behandeld",
- "body": "Je verlofaanvraag is behandeld.",
- "senderEmail": "[email protected]"
}, - "dependsOnModule": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlof"
}, - "definedAtLevel": "employer",
- "isEmailTemplateEditable": true
}
]
}
Details of an email template
Activity name : GetEmailTemplateByEmployerIdAndEmailTemplateId
Get the details of an email template. The available email template placeholders can be aquired by adding /metadata to the url.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
emailTemplateId required | string <uuid> The unique identifier of the email template record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "type": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlofaanvraag behandeld (voor de indiener)",
- "sortOrder": 210
}, - "category": {
- "key": 3,
- "value": "Verlof"
}, - "email": {
- "subject": "Verlofaanvraag behandeld",
- "body": "Je verlofaanvraag is behandeld.",
- "senderEmail": "[email protected]"
}, - "dependsOnModule": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlof"
}, - "definedAtLevel": "employer",
- "isEmailTemplateEditable": true
}
]
}
Edit an employer email template record
Activity name : PutEmailTemplateByEmployerIdAndEmailTemplateId
Edit the email template. The subject, body and senderEmail can be editted.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
emailTemplateId required | string <uuid> The unique identifier of the email template record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
subject | string [ 1 .. 512 ] characters The subjectline of the email. |
body | string [ 1 .. 6000 ] characters The body text of the email. |
senderEmail | string [ 1 .. 255 ] characters The email address of the sender. |
Responses
Request samples
- Payload
{- "subject": "Verlofaanvraag behandeld",
- "body": "Je verlofaanvraag is behandeld.",
- "senderEmail": "[email protected]"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "type": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlofaanvraag behandeld (voor de indiener)",
- "sortOrder": 210
}, - "category": {
- "key": 3,
- "value": "Verlof"
}, - "email": {
- "subject": "Verlofaanvraag behandeld",
- "body": "Je verlofaanvraag is behandeld.",
- "senderEmail": "[email protected]"
}, - "dependsOnModule": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlof"
}, - "definedAtLevel": "employer",
- "isEmailTemplateEditable": true
}
}
Delete an email template record
Activity name : DeleteEmailTemplateByEmployerIdAndEmailTemplateId
Delete an existing employer email template record
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
emailTemplateId required | string <uuid> The unique identifier of the email template record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
The event notification configuration for a payroll administration
Activity name : GetEventNotificationConfigurationsByPayrollAdministrationId
Get a list of the notification configurations for certain events for an employer. Currently its only possible to configure email recipients for an event notification.
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.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "type": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlofaanvraag behandeld (voor de indiener)",
- "sortOrder": 210
}, - "category": {
- "key": 3,
- "value": "Verlof"
}, - "dependsOnModule": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlof"
}, - "definedAtLevel": "Provider",
- "emailAddress": "[email protected]"
}
]
}
Details of an event notification configuration for a payroll administration
Activity name : GetEventNotificationConfigurationByPayrollAdministrationIdAndEventTypeId
Get the details of an event notification configuration.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
eventTypeId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "type": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlofaanvraag behandeld (voor de indiener)",
- "sortOrder": 210
}, - "category": {
- "key": 3,
- "value": "Verlof"
}, - "dependsOnModule": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlof"
}, - "definedAtLevel": "Provider",
- "emailAddress": "[email protected]"
}
}
Edit an event notification configuration for a payroll administration
Activity name : PutEventNotificationConfigurationByPayrollAdministrationIdAndEventTypeId
Edit the event notification configuration.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
eventTypeId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
emailAddress | string (emailAddressNonNullable) <= 6000 characters ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\... The e-mail address that will receive the notification. It is possible to configure multiple addresses by dividing them with a ; |
Responses
Request samples
- Payload
{- "emailAddress": "[email protected]"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "type": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlofaanvraag behandeld (voor de indiener)",
- "sortOrder": 210
}, - "category": {
- "key": 3,
- "value": "Verlof"
}, - "dependsOnModule": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlof"
}, - "definedAtLevel": "Provider",
- "emailAddress": "[email protected]"
}
}
Delete an event notification configuration for a payroll administration
Activity name : DeleteEventNotificationConfigurationByPayrollAdministrationIdAndEventTypeId
Delete an existing event notification configuration
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
eventTypeId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
The event notification configuration for a provider
Activity name : GetEventNotificationConfigurationsByProviderId
Get a list of the notification configurations for certain events for a provider. Currently its only possible to configure email recipients for an event notification.
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.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "type": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlofaanvraag behandeld (voor de indiener)",
- "sortOrder": 210
}, - "category": {
- "key": 3,
- "value": "Verlof"
}, - "dependsOnModule": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlof"
}, - "definedAtLevel": "Provider",
- "emailAddress": "[email protected]"
}
]
}
Details of an event notification configuration for a provider
Activity name : GetEventNotificationConfigurationByProviderIdAndEventTypeId
Get the details of an event notification configuration.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
eventTypeId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "type": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlofaanvraag behandeld (voor de indiener)",
- "sortOrder": 210
}, - "category": {
- "key": 3,
- "value": "Verlof"
}, - "dependsOnModule": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlof"
}, - "definedAtLevel": "Provider",
- "emailAddress": "[email protected]"
}
}
Edit an event notification configuration for a provider
Activity name : PutEventNotificationConfigurationByProviderIdAndEventTypeId
Edit the event notification configuration.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
eventTypeId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
emailAddress | string (emailAddressNonNullable) <= 6000 characters ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\... The e-mail address that will receive the notification. It is possible to configure multiple addresses by dividing them with a ; |
Responses
Request samples
- Payload
{- "emailAddress": "[email protected]"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "type": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlofaanvraag behandeld (voor de indiener)",
- "sortOrder": 210
}, - "category": {
- "key": 3,
- "value": "Verlof"
}, - "dependsOnModule": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verlof"
}, - "definedAtLevel": "Provider",
- "emailAddress": "[email protected]"
}
}
Delete an event notification configuration for a provider
Activity name : DeleteEventNotificationConfigurationByProviderIdAndEventTypeId
Delete an existing event notification configuration
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
eventTypeId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download actual master data report (Stamgegevens actueel)
Activity name : GetEmploymentActualMasterDataReportByEmployerId
Acquire the actual master data report (Stamgegevens actueel) on employer level, as generated by the reporting service.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate required | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download master data report (Stamgegevens)
Activity name : GetEmploymentMasterDataReportByEmployerId
Acquire the master data report (Stamgegevens) on employer level, as generated by the reporting service.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate required | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
includeEmploymentsThatEndedBeforeReferenceDate required | boolean If set to true records with an enddate before the reference will be included in the output. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download the fiscal company car report (Auto van de zaak)
Activity name : GetFiscalCompanyCarReportByEmployerId
Acquire the fiscal company car report (Auto van de zaak) on employer level, as generated by the reporting service.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate required | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
includeEmploymentsThatEndedBeforeReferenceDate required | boolean If set to true records with an enddate before the reference will be included in the output. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List contract codes for an employer
Activity name : GetContractCodesByEmployerId
Get a list of the contract codes for an employer.
Note: The contract codes defined at the employer level can be used as value for the field contractCode in the WorkingHours and ConceptEmployee resource.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 1022,
- "description": "Special contract"
}
]
}
Add a contract code for an employer
Activity name : PostContractCodeByEmployerId
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a contract code
code | integer <int32> An unique code for the contract code within the scope of the employer |
description | string <= 50 characters The description of the contract code |
Responses
Request samples
- Payload
{- "code": 1022,
- "description": "Special contract"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 1022,
- "description": "Special contract"
}
}
Details of a contract code
Activity name : GetContractCodeByContractCodeId
Get the details of a contract code
path Parameters
contractCodeId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 1022,
- "description": "Special contract"
}
]
}
Edit a contract code record
Activity name : PutContractCodeByContractCodeId
path Parameters
contractCodeId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
code | integer <int32> An unique code for the contract code within the scope of the employer |
description | string <= 50 characters The description of the contract code |
Responses
Request samples
- Payload
{- "code": 1022,
- "description": "Special contract"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 1022,
- "description": "Special contract"
}
}
Delete a contract code record
Activity name : DeleteContractCodeByContractCodeId
Delete an existing contract code record
path Parameters
contractCodeId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of distribution units
Activity name : GetDistributionUnitsByEmployerId
Get a list of all distribution units for the employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}
]
}
Create a distribution unit for an employer
Activity name: PostDistributionUnitByEmployerId
Create a distribution unit for an employer
Metadata : No metadata available.
Defaults: No default values
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Distribution unit to add to the employer.
code | integer <int32> |
description | string (components-schemas-description) <= 50 characters |
Responses
Request samples
- Payload
{- "code": 2,
- "description": "Sales"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}
}
Details of a distribution unit
Activity name: GetDistributionUnitByDistributionUnitId
Get the details of a distribution unit
path Parameters
distributionUnitId required | string <uuid> The unique identifier of the distribution unit |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}
}
Edit the details of a distribution unit
Activity name: PutDistributionUnitByDistributionUnitId
Edit the details for a distribution unit
Metadata : No metadata available.
path Parameters
distributionUnitId required | string <uuid> The unique identifier of the distribution unit |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
distribution unit to edit.
description | string (components-schemas-description) <= 50 characters |
Responses
Request samples
- Payload
{- "description": "Sales"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}
}
Employment templates
Activity name : GetEmploymentTemplatesByEmployerId Get the employment templates that are available at this employer's level.
An employment templates (werknemersjabloon) provides as predefined set of values for a new employment. This is mostly when creating a new employee or employment as this allows the user to apply the template's values and augment this with any specific values.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "templateName": "Sjabloon voor Oproepkracht",
- "employmentData": {
- "startDate": "2019-01-01",
- "historicalStartDate": "2012-05-01",
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker"
}, - "nonPayrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "description": "Bakker"
}, - "commissionUntilDate": "2019-01-01",
- "incomeRelationshipNumber": 12,
- "employeeProfileId": {
- "key": 1,
- "value": "Profiel full-timers"
}, - "employmentDurationType": {
- "key": 1,
- "value": "Contract of indefinite duration"
}, - "startDateContractOfIndefiniteDuration": "2018-05-08",
- "employmentContractType": {
- "key": 1,
- "value": "Labor agreement"
}, - "typeOfEmployee": {
- "key": 1,
- "value": "Werknemer"
}, - "cancellationPeriodEmployee": 1,
- "cancellationPeriodEmployer": 1,
- "cancellationPeriodTimeUnit": {
- "key": 4,
- "value": "Maand(en)"
}, - "cancellationNoticeDate": "2019-05-31",
- "startCancellationNoticePeriod": "2019-06-01",
- "isDirectorAndMajorShareholder": false,
- "isOnCallEmployment": true,
- "hasOnCallAppearanceObligation": true,
- "vacationCoupons": {
- "key": 1,
- "value": "n.v.t."
}, - "specialIncomeRatio": {
- "key": 0,
- "value": "n.v.t."
}, - "isAnonymousEmployee": true,
- "isPreviousOwner": false,
- "isFamilyOfOwner": false,
- "isGemoedsbezwaardNationalInsurance": true,
- "isGemoedsbezwaardEmployeeInsurance": true,
- "namePayslip": "Steve Jobs",
- "calculateWorkingHours": true,
- "essMutationSet": {
- "key": 1,
- "value": "Standaard"
}, - "exemptionInsuranceObligation": {
- "key": 0,
- "value": "Geen uitzondering."
}, - "firstDayNotification": false,
- "sendMdvNotification": true,
- "periodPayGradeAdjustment": 2,
- "signalPayGradeAdjustment": false,
- "typeOfParticipation": {
- "key": 0,
- "value": "n.v.t."
}, - "valueOfParticipation": {
- "key": 0,
- "value": "n.v.t."
}, - "professionCode": 4,
- "deviatingCLATaxReturn": 2,
- "participation55plusRegulationUWV": false,
- "writtenEmploymentContract": true
}, - "workingHoursData": {
- "shift": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "deviatingHoursPerWeek": 32,
- "deviatingSvDaysPerPeriod": 32,
- "averageParttimeFactor": 37.5,
- "regularWorkPattern": true,
- "flexibleHoursContract": {
- "key": 0,
- "value": "n.v.t."
}, - "contractCode": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 1022,
- "description": "SLA-PT-met toeslagen ATW (88)"
}, - "calculateUsingWorkPattern": {
- "leaveHours": true,
- "hoursBrokenPeriod": false,
- "hoursPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "workPattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "wageData": {
- "grossWage": 23,
- "grossWageType": {
- "key": 2,
- "value": "hourly"
}, - "netWage": 1,
- "netWageType": {
- "key": 1,
- "value": "hourly"
}, - "payScale": {
- "key": 1,
- "value": "Glastuinbouw maand, Loongebouw A"
}, - "payGrade": {
- "key": 1,
- "value": "Schaal B1, 15 jaar"
}, - "applyPayGrade": true
}, - "organizationalEntityData": {
- "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Directeur",
- "group": "internal"
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "standardFunction": {
- "key": 1,
- "value": "Administrateur",
- "code": "A21",
- "category": 1
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}, - "placeOfEmployment": "Amsterdam office",
- "internalTelephoneExtensionNumber": "0133031600"
}, - "socialSecurityData": {
- "isInsuredForSicknessBenefitsAct": false,
- "isInsuredForUnemploymentInsuranceAct": false,
- "isInsuredForOccupationalDisabilityInsuranceAct": false,
- "healthCareInsuranceActType": {
- "key": 2,
- "value": "(C/K) Wel verzekeringsplichtig, normaal tarief"
}
}, - "fiscalData": {
- "annualSalary": 60000,
- "deviatingPayrollTaxTableColour": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "applyDayTables": false,
- "deviatingPayrollTaxPercentage": 27.45,
- "applyDeviatingPayrollTaxPercentageOn": {
- "key": 2,
- "value": "Afwijkend voor tabel- en tariefloon"
}, - "applyPayrollTaxDeduction": false,
- "applyStudentDeduction": false,
- "deviatingCalculationRulePayrollTax": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "residentOf": {
- "key": 2,
- "value": "Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden"
}
}, - "otherPayrollVariablesData": {
- "deviatingPremiumGroup": {
- "key": 2,
- "value": "(12) Metaal- en technische bedrijfstakken"
}
}
}
]
}
Create an Employment template for an employer
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 ../providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}
.
* Possible options for payGrade can be acquired via ../providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}
.
A payGrade
has time based values dictating the wage for a given period. These values can be acquired by performing another metadata request to GET ../providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}/paygrade/{payGradeKey}
. This endpoint has the optional parameter "date" that may be used to specifying a measure date.
Defaults : Default values for a new object can be acquired by adding /defaults
to the POST URL.
Default values that are dependent on the selected payroll administration can be acquired by adding /providers/employers/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 /providers/employers/employmenttemplates/defaults/nonpayrolladministration/{nonPayrollAdministrationId}
.
"
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
X-ValidateOnly | boolean If set to true only the validations will be performed no changes will be committed. |
Request Body schema: application/json;version=2018-01-01required
Employment template to create to the employer.
templateName | string [ 1 .. 255 ] characters Name of the template |
object or null (employment) | |
object or null (workingHours) | |
object or null (wage) | |
object or null (organizationalEntity) | |
object or null (socialSecurity) | |
object or null (fiscal) | |
object or null (otherPayrollVariables) |
Responses
Request samples
- Payload
{- "templateName": "Sjabloon voor Oproepkracht",
- "employmentData": {
- "startDate": "2019-01-01",
- "historicalStartDate": "2012-05-01",
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "nonPayrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "commissionUntilDate": "2019-01-01",
- "incomeRelationshipNumber": 12,
- "employeeProfileId": {
- "key": 1
}, - "employmentDurationType": {
- "key": 1
}, - "startDateContractOfIndefiniteDuration": "2018-05-08",
- "employmentContractType": {
- "key": 1
}, - "typeOfEmployee": {
- "key": 1
}, - "cancellationPeriodEmployee": 1,
- "cancellationPeriodEmployer": 1,
- "cancellationPeriodTimeUnit": {
- "key": 4
}, - "cancellationNoticeDate": "2019-05-31",
- "startCancellationNoticePeriod": "2019-06-01",
- "isDirectorAndMajorShareholder": false,
- "isOnCallEmployment": true,
- "hasOnCallAppearanceObligation": true,
- "vacationCoupons": {
- "key": 1
}, - "specialIncomeRatio": {
- "key": 0
}, - "isAnonymousEmployee": true,
- "isPreviousOwner": false,
- "isFamilyOfOwner": false,
- "isGemoedsbezwaardNationalInsurance": true,
- "isGemoedsbezwaardEmployeeInsurance": true,
- "namePayslip": "Steve Jobs",
- "calculateWorkingHours": true,
- "essMutationSet": {
- "key": 1
}, - "exemptionInsuranceObligation": {
- "key": 0
}, - "sendMdvNotification": true,
- "periodPayGradeAdjustment": 2,
- "signalPayGradeAdjustment": false,
- "typeOfParticipation": {
- "key": 0
}, - "valueOfParticipation": {
- "key": 0
}, - "professionCode": 4,
- "deviatingCLATaxReturn": 2,
- "participation55plusRegulationUWV": false,
- "writtenEmploymentContract": true
}, - "workingHoursData": {
- "shift": {
- "shiftNumber": 1
}, - "deviatingHoursPerWeek": 32,
- "deviatingSvDaysPerPeriod": 32,
- "averageParttimeFactor": 37.5,
- "regularWorkPattern": true,
- "flexibleHoursContract": {
- "key": 0
}, - "contractCode": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "calculateUsingWorkPattern": {
- "leaveHours": true,
- "hoursBrokenPeriod": false,
- "hoursPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "workPattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "wageData": {
- "grossWage": 23,
- "grossWageType": {
- "key": 2
}, - "netWage": 1,
- "netWageType": { },
- "payScale": { },
- "payGrade": { },
- "applyPayGrade": true
}, - "organizationalEntityData": {
- "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "standardFunction": {
- "key": 1
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "placeOfEmployment": "Amsterdam office",
- "internalTelephoneExtensionNumber": "0133031600"
}, - "socialSecurityData": {
- "isInsuredForSicknessBenefitsAct": false,
- "isInsuredForUnemploymentInsuranceAct": false,
- "isInsuredForOccupationalDisabilityInsuranceAct": false,
- "healthCareInsuranceActType": {
- "key": 2
}
}, - "fiscalData": {
- "annualSalary": 60000,
- "deviatingPayrollTaxTableColour": {
- "key": 2
}, - "applyDayTables": false,
- "applyDeviatingPayrollTaxPercentageOn": {
- "key": 2
}, - "applyPayrollTaxDeduction": false,
- "applyStudentDeduction": false,
- "deviatingCalculationRulePayrollTax": {
- "key": 2
}, - "residentOf": {
- "key": 2
}
}, - "otherPayrollVariablesData": {
- "deviatingPremiumGroup": {
- "key": 2
}
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "templateName": "Sjabloon voor Oproepkracht",
- "employmentData": {
- "startDate": "2019-01-01",
- "historicalStartDate": "2012-05-01",
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker"
}, - "nonPayrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "description": "Bakker"
}, - "commissionUntilDate": "2019-01-01",
- "incomeRelationshipNumber": 12,
- "employeeProfileId": {
- "key": 1,
- "value": "Profiel full-timers"
}, - "employmentDurationType": {
- "key": 1,
- "value": "Contract of indefinite duration"
}, - "startDateContractOfIndefiniteDuration": "2018-05-08",
- "employmentContractType": {
- "key": 1,
- "value": "Labor agreement"
}, - "typeOfEmployee": {
- "key": 1,
- "value": "Werknemer"
}, - "cancellationPeriodEmployee": 1,
- "cancellationPeriodEmployer": 1,
- "cancellationPeriodTimeUnit": {
- "key": 4,
- "value": "Maand(en)"
}, - "cancellationNoticeDate": "2019-05-31",
- "startCancellationNoticePeriod": "2019-06-01",
- "isDirectorAndMajorShareholder": false,
- "isOnCallEmployment": true,
- "hasOnCallAppearanceObligation": true,
- "vacationCoupons": {
- "key": 1,
- "value": "n.v.t."
}, - "specialIncomeRatio": {
- "key": 0,
- "value": "n.v.t."
}, - "isAnonymousEmployee": true,
- "isPreviousOwner": false,
- "isFamilyOfOwner": false,
- "isGemoedsbezwaardNationalInsurance": true,
- "isGemoedsbezwaardEmployeeInsurance": true,
- "namePayslip": "Steve Jobs",
- "calculateWorkingHours": true,
- "essMutationSet": {
- "key": 1,
- "value": "Standaard"
}, - "exemptionInsuranceObligation": {
- "key": 0,
- "value": "Geen uitzondering."
}, - "firstDayNotification": false,
- "sendMdvNotification": true,
- "periodPayGradeAdjustment": 2,
- "signalPayGradeAdjustment": false,
- "typeOfParticipation": {
- "key": 0,
- "value": "n.v.t."
}, - "valueOfParticipation": {
- "key": 0,
- "value": "n.v.t."
}, - "professionCode": 4,
- "deviatingCLATaxReturn": 2,
- "participation55plusRegulationUWV": false,
- "writtenEmploymentContract": true
}, - "workingHoursData": {
- "shift": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "deviatingHoursPerWeek": 32,
- "deviatingSvDaysPerPeriod": 32,
- "averageParttimeFactor": 37.5,
- "regularWorkPattern": true,
- "flexibleHoursContract": {
- "key": 0,
- "value": "n.v.t."
}, - "contractCode": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 1022,
- "description": "SLA-PT-met toeslagen ATW (88)"
}, - "calculateUsingWorkPattern": {
- "leaveHours": true,
- "hoursBrokenPeriod": false,
- "hoursPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "workPattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "wageData": {
- "grossWage": 23,
- "grossWageType": {
- "key": 2,
- "value": "hourly"
}, - "netWage": 1,
- "netWageType": {
- "key": 1,
- "value": "hourly"
}, - "payScale": {
- "key": 1,
- "value": "Glastuinbouw maand, Loongebouw A"
}, - "payGrade": {
- "key": 1,
- "value": "Schaal B1, 15 jaar"
}, - "applyPayGrade": true
}, - "organizationalEntityData": {
- "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Directeur",
- "group": "internal"
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "standardFunction": {
- "key": 1,
- "value": "Administrateur",
- "code": "A21",
- "category": 1
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}, - "placeOfEmployment": "Amsterdam office",
- "internalTelephoneExtensionNumber": "0133031600"
}, - "socialSecurityData": {
- "isInsuredForSicknessBenefitsAct": false,
- "isInsuredForUnemploymentInsuranceAct": false,
- "isInsuredForOccupationalDisabilityInsuranceAct": false,
- "healthCareInsuranceActType": {
- "key": 2,
- "value": "(C/K) Wel verzekeringsplichtig, normaal tarief"
}
}, - "fiscalData": {
- "annualSalary": 60000,
- "deviatingPayrollTaxTableColour": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "applyDayTables": false,
- "deviatingPayrollTaxPercentage": 27.45,
- "applyDeviatingPayrollTaxPercentageOn": {
- "key": 2,
- "value": "Afwijkend voor tabel- en tariefloon"
}, - "applyPayrollTaxDeduction": false,
- "applyStudentDeduction": false,
- "deviatingCalculationRulePayrollTax": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "residentOf": {
- "key": 2,
- "value": "Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden"
}
}, - "otherPayrollVariablesData": {
- "deviatingPremiumGroup": {
- "key": 2,
- "value": "(12) Metaal- en technische bedrijfstakken"
}
}
}
}
Edit the details of an employment template
Activity name : PutEmploymentTemplateByEmploymentTemplateId
Edit the details of an employment template
- Possible options (metadata) for generic fields of the type "metadata" can be acquired (GET) by adding
/metadata
to the URL. - Possible options dependent on a specific payrollAdministration can be acquired via
../providers/employers/conceptemployees/metadata/payrollAdministration/{payrollAdministrationId}
. - Possible options for payGrade can be acquired via
../providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}
.
A payGrade
has time based values dictating the wage for a given period. These values can be acquired by performing another metadata request ../providers/employers/conceptemployees/metadata/payscale/{payScaleKey}/paygrade/{payGradeKey}
.
NonPayrollAdministrations For nonPayrollAdministrations the equivalent MetaData-endpoints are also available as described above. Default values that are dependent on the selected non-payroll administration can be acquired via /providers/employers/employmenttemplates/defaults/nonpayrolladministration/{nonPayrollAdministrationId}
.
path Parameters
employmenttemplateId required | string <uuid> The unique identifier of the concept employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
X-ValidateOnly | boolean If set to true only the validations will be performed no changes will be committed. |
Request Body schema: application/json;version=2018-01-01required
Employment template to edit.
templateName | string [ 1 .. 255 ] characters Name of the template |
object or null (employment) | |
object or null (workingHours) | |
object or null (wage) | |
object or null (organizationalEntity) | |
object or null (socialSecurity) | |
object or null (fiscal) | |
object or null (otherPayrollVariables) |
Responses
Request samples
- Payload
{- "templateName": "Sjabloon voor Oproepkracht",
- "employmentData": {
- "startDate": "2019-01-01",
- "historicalStartDate": "2012-05-01",
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "nonPayrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "commissionUntilDate": "2019-01-01",
- "incomeRelationshipNumber": 12,
- "employeeProfileId": {
- "key": 1
}, - "employmentDurationType": {
- "key": 1
}, - "startDateContractOfIndefiniteDuration": "2018-05-08",
- "employmentContractType": {
- "key": 1
}, - "typeOfEmployee": {
- "key": 1
}, - "cancellationPeriodEmployee": 1,
- "cancellationPeriodEmployer": 1,
- "cancellationPeriodTimeUnit": {
- "key": 4
}, - "cancellationNoticeDate": "2019-05-31",
- "startCancellationNoticePeriod": "2019-06-01",
- "isDirectorAndMajorShareholder": false,
- "isOnCallEmployment": true,
- "hasOnCallAppearanceObligation": true,
- "vacationCoupons": {
- "key": 1
}, - "specialIncomeRatio": {
- "key": 0
}, - "isAnonymousEmployee": true,
- "isPreviousOwner": false,
- "isFamilyOfOwner": false,
- "isGemoedsbezwaardNationalInsurance": true,
- "isGemoedsbezwaardEmployeeInsurance": true,
- "namePayslip": "Steve Jobs",
- "calculateWorkingHours": true,
- "essMutationSet": {
- "key": 1
}, - "exemptionInsuranceObligation": {
- "key": 0
}, - "sendMdvNotification": true,
- "periodPayGradeAdjustment": 2,
- "signalPayGradeAdjustment": false,
- "typeOfParticipation": {
- "key": 0
}, - "valueOfParticipation": {
- "key": 0
}, - "professionCode": 4,
- "deviatingCLATaxReturn": 2,
- "participation55plusRegulationUWV": false,
- "writtenEmploymentContract": true
}, - "workingHoursData": {
- "shift": {
- "shiftNumber": 1
}, - "deviatingHoursPerWeek": 32,
- "deviatingSvDaysPerPeriod": 32,
- "averageParttimeFactor": 37.5,
- "regularWorkPattern": true,
- "flexibleHoursContract": {
- "key": 0
}, - "contractCode": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "calculateUsingWorkPattern": {
- "leaveHours": true,
- "hoursBrokenPeriod": false,
- "hoursPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "workPattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "wageData": {
- "grossWage": 23,
- "grossWageType": {
- "key": 2
}, - "netWage": 1,
- "netWageType": { },
- "payScale": { },
- "payGrade": { },
- "applyPayGrade": true
}, - "organizationalEntityData": {
- "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "standardFunction": {
- "key": 1
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "placeOfEmployment": "Amsterdam office",
- "internalTelephoneExtensionNumber": "0133031600"
}, - "socialSecurityData": {
- "isInsuredForSicknessBenefitsAct": false,
- "isInsuredForUnemploymentInsuranceAct": false,
- "isInsuredForOccupationalDisabilityInsuranceAct": false,
- "healthCareInsuranceActType": {
- "key": 2
}
}, - "fiscalData": {
- "annualSalary": 60000,
- "deviatingPayrollTaxTableColour": {
- "key": 2
}, - "applyDayTables": false,
- "applyDeviatingPayrollTaxPercentageOn": {
- "key": 2
}, - "applyPayrollTaxDeduction": false,
- "applyStudentDeduction": false,
- "deviatingCalculationRulePayrollTax": {
- "key": 2
}, - "residentOf": {
- "key": 2
}
}, - "otherPayrollVariablesData": {
- "deviatingPremiumGroup": {
- "key": 2
}
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "templateName": "Sjabloon voor Oproepkracht",
- "employmentData": {
- "startDate": "2019-01-01",
- "historicalStartDate": "2012-05-01",
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker"
}, - "nonPayrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "description": "Bakker"
}, - "commissionUntilDate": "2019-01-01",
- "incomeRelationshipNumber": 12,
- "employeeProfileId": {
- "key": 1,
- "value": "Profiel full-timers"
}, - "employmentDurationType": {
- "key": 1,
- "value": "Contract of indefinite duration"
}, - "startDateContractOfIndefiniteDuration": "2018-05-08",
- "employmentContractType": {
- "key": 1,
- "value": "Labor agreement"
}, - "typeOfEmployee": {
- "key": 1,
- "value": "Werknemer"
}, - "cancellationPeriodEmployee": 1,
- "cancellationPeriodEmployer": 1,
- "cancellationPeriodTimeUnit": {
- "key": 4,
- "value": "Maand(en)"
}, - "cancellationNoticeDate": "2019-05-31",
- "startCancellationNoticePeriod": "2019-06-01",
- "isDirectorAndMajorShareholder": false,
- "isOnCallEmployment": true,
- "hasOnCallAppearanceObligation": true,
- "vacationCoupons": {
- "key": 1,
- "value": "n.v.t."
}, - "specialIncomeRatio": {
- "key": 0,
- "value": "n.v.t."
}, - "isAnonymousEmployee": true,
- "isPreviousOwner": false,
- "isFamilyOfOwner": false,
- "isGemoedsbezwaardNationalInsurance": true,
- "isGemoedsbezwaardEmployeeInsurance": true,
- "namePayslip": "Steve Jobs",
- "calculateWorkingHours": true,
- "essMutationSet": {
- "key": 1,
- "value": "Standaard"
}, - "exemptionInsuranceObligation": {
- "key": 0,
- "value": "Geen uitzondering."
}, - "firstDayNotification": false,
- "sendMdvNotification": true,
- "periodPayGradeAdjustment": 2,
- "signalPayGradeAdjustment": false,
- "typeOfParticipation": {
- "key": 0,
- "value": "n.v.t."
}, - "valueOfParticipation": {
- "key": 0,
- "value": "n.v.t."
}, - "professionCode": 4,
- "deviatingCLATaxReturn": 2,
- "participation55plusRegulationUWV": false,
- "writtenEmploymentContract": true
}, - "workingHoursData": {
- "shift": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "deviatingHoursPerWeek": 32,
- "deviatingSvDaysPerPeriod": 32,
- "averageParttimeFactor": 37.5,
- "regularWorkPattern": true,
- "flexibleHoursContract": {
- "key": 0,
- "value": "n.v.t."
}, - "contractCode": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 1022,
- "description": "SLA-PT-met toeslagen ATW (88)"
}, - "calculateUsingWorkPattern": {
- "leaveHours": true,
- "hoursBrokenPeriod": false,
- "hoursPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "workPattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "wageData": {
- "grossWage": 23,
- "grossWageType": {
- "key": 2,
- "value": "hourly"
}, - "netWage": 1,
- "netWageType": {
- "key": 1,
- "value": "hourly"
}, - "payScale": {
- "key": 1,
- "value": "Glastuinbouw maand, Loongebouw A"
}, - "payGrade": {
- "key": 1,
- "value": "Schaal B1, 15 jaar"
}, - "applyPayGrade": true
}, - "organizationalEntityData": {
- "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Directeur",
- "group": "internal"
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "standardFunction": {
- "key": 1,
- "value": "Administrateur",
- "code": "A21",
- "category": 1
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}, - "placeOfEmployment": "Amsterdam office",
- "internalTelephoneExtensionNumber": "0133031600"
}, - "socialSecurityData": {
- "isInsuredForSicknessBenefitsAct": false,
- "isInsuredForUnemploymentInsuranceAct": false,
- "isInsuredForOccupationalDisabilityInsuranceAct": false,
- "healthCareInsuranceActType": {
- "key": 2,
- "value": "(C/K) Wel verzekeringsplichtig, normaal tarief"
}
}, - "fiscalData": {
- "annualSalary": 60000,
- "deviatingPayrollTaxTableColour": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "applyDayTables": false,
- "deviatingPayrollTaxPercentage": 27.45,
- "applyDeviatingPayrollTaxPercentageOn": {
- "key": 2,
- "value": "Afwijkend voor tabel- en tariefloon"
}, - "applyPayrollTaxDeduction": false,
- "applyStudentDeduction": false,
- "deviatingCalculationRulePayrollTax": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "residentOf": {
- "key": 2,
- "value": "Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden"
}
}, - "otherPayrollVariablesData": {
- "deviatingPremiumGroup": {
- "key": 2,
- "value": "(12) Metaal- en technische bedrijfstakken"
}
}
}
}
Delete a employment template
Activity name : DeleteEmploymentTemplateByEmploymentTemplateId
Delete a employment template
path Parameters
employmenttemplateId required | string <uuid> The unique identifier of the concept employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Employer configuration
Activity name : GetEmployerConfigurationByEmployerId
Get the configuration at Employer level. This configuration is managed by the provider.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "deviatingProviderLogo": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "attribute": "Logo 1",
- "name": "EmployerLogo"
}
}
}
Edit Employer configuration
Activity name : PutEmployerConfigurationByEmployerId
Edit the configuration at Employer level. This configuration is managed by the provider.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object or null The deviating provider logo. When provided, this logo will be used as providerlogo instead of the default providerlogo. |
Responses
Request samples
- Payload
{- "deviatingProviderLogo": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "deviatingProviderLogo": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "attribute": "Logo 1",
- "name": "EmployerLogo"
}
}
}
NL: Fiscaal / Fiscale gegevens. Manage the fiscal property settings for an employment.
List of fiscal properties for an employment
Activity name: GetFiscalPropertiesByEmploymentId
Get the list of fiscal properties for an employment
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "annualSalary": 60000,
- "deviatingTaxTableCode": {
- "key": 1,
- "value": "999 Overige gevallen waarin geen tabel is toegepast"
}, - "deviatingPayrollTaxTableColour": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "applyDayTables": false,
- "deviatingPayrollTaxPercentage": 25,
- "applyDeviatingPayrollTaxPercentageOn": {
- "key": 2,
- "value": "Afwijkend voor tabel- en tariefloon"
}, - "applyPayrollTaxDeduction": true,
- "applyStudentDeduction": false,
- "residentOf": {
- "key": 2,
- "value": "Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden"
}, - "applySalarysplit": {
- "key": 2,
- "value": "LB obv wereldinkomen (%NL/WI)"
}, - "percentageForeignIncome": 50,
- "deviatingCalculationRulePayrollTax": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "thirtyPercentFacility": {
- "key": 1,
- "value": "Netto"
}, - "deviatingPercentageThirtyPercentFacility": 20.2345,
- "doesWageIncludeAow": false,
- "doesWageIncludeWajong": false,
- "hasEmployeeLoan": false,
- "usesTransportByWithholdingAgent": false,
- "deviatingSmallJobsArrangement": false,
- "contributionReductionEducation": {
- "key": 2,
- "value": "4. Opleiding hbo"
}, - "specialIndication": {
- "one": 1,
- "two": 1,
- "three": 1,
- "four": 1
}, - "applySingleElderlyTaxDeduction": false
}
]
}
Create a fiscal record for an employment
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.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: required
Fiscal properties record to add to the employment.
startDate | string <date> (components-schemas-startDate) The start date of the entity. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. |
annualSalary | number <double> (annualSalary) [ 0 .. 999999999 ] ^(\d{0,9})$ The fiscal annual salary. NL: Fiscaal jaarloon |
object or null <metadata> (deviatingTaxTableCode) 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 | |
object <metadata> (deviatingPayrollTaxTableColour) 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 | |
applyDayTables | boolean or null (applyDayTables) Indicates whether the value of the day table is used for the calculation of payroll tax. NL: DagtabelToepassen |
deviatingPayrollTaxPercentage | number or null <double> (deviatingPayrollTaxPercentage) [ 0 .. 99.99 ] ^(\d{1,2})(\.\d{1,2})?$ Indicates the deviating payroll tax percentage which is to be applied. NL: AfwijkendLoonbelastingPercentage |
object <metadata> (applyDeviatingPayrollTaxPercentageOn) Indicates on what type of payroll calculation the deviating payroll tax percentage is applicable. NL: AfwijkendPercentageToepassen | |
applyPayrollTaxDeduction | boolean (applyPayrollTaxDeduction) Indicates whether payroll tax deduction is appliclable (loonheffingskorting). NL: ArbeidskortingToepassen |
applyStudentDeduction | boolean or null (applyStudentDeduction) Apply the "Scholierenregeling". NL; ArbeidskortingToepassen |
object <metadata> (residentOf) Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen. NL: InwonerVan | |
object <metadata> (applySalarysplit) Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen. | |
percentageForeignIncome | number or null <double> (percentageForeignIncome) [ 0.01 .. 99.99 ] ^(\d{1,2})(\.\d{1,2})?$ Indicates what percentage of the income of this employment is taxable outside the Netherlands. NL: PercentageBuitenlandsInkomen |
object <metadata> (deviatingCalculationRulePayrollTax) Indicates if, while calculating payroll taxes and social security contributions, certain deviations are applicable. NL; Herleidingsregel | |
object or null <metadata> (thirtyPercentFacility) If the employee comes to work in the Netherlands from another country, the employer may grant an untaxed reimbursement. (30%-regeling). | |
deviatingPercentageThirtyPercentFacility | number or null <double> (deviatingPercentageThirtyPercentFacility) [ 0.000001 .. 29.999999 ] ^(\d{1,2})(\.\d{1,6})?$ Indicates a deviating percentage which should be applied for the 30% facility (30%-regeling) |
doesWageIncludeAow | boolean (doesWageIncludeAow) Indicates whether wage include AOW pension (affects payrolling). NL: LoonInclusiefAowUitkering |
doesWageIncludeWajong | boolean (doesWageIncludeWajong) Indicates whether wage include Wajong benefits (affects payrolling). NL: LoonInclusiefWajong |
hasEmployeeLoan | boolean (hasEmployeeLoan) Whether an employee loan (Personeelslening) is applicable may be indicated here. The Personeelslening indirectly affects the income tax calculations. |
usesTransportByWithholdingAgent | boolean (usesTransportByWithholdingAgent) The so-called 'vervoer vanwege inhoudingsplichtige' is a tax rule that may apply. By example when the employer organizes the transport for the employee. |
deviatingSmallJobsArrangement | boolean or null (deviatingSmallJobsArrangement) Kleine banenregeling |
object or null <metadata> (contributionReductionEducation) Afdr. verm. onderwijs | |
applySingleElderlyTaxDeduction | boolean (applySingleElderlyTaxDeduction) Indicates whether wage include Wajong benefits (affects payrolling). NL: LoonInclusiefWajong |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "annualSalary": 60000,
- "deviatingTaxTableCode": {
- "key": 1
}, - "deviatingPayrollTaxTableColour": {
- "key": 2
}, - "applyDayTables": false,
- "deviatingPayrollTaxPercentage": 25,
- "applyDeviatingPayrollTaxPercentageOn": {
- "key": 2
}, - "applyPayrollTaxDeduction": true,
- "applyStudentDeduction": false,
- "residentOf": {
- "key": 2
}, - "applySalarysplit": {
- "key": 2
}, - "percentageForeignIncome": 50,
- "deviatingCalculationRulePayrollTax": {
- "key": 2
}, - "thirtyPercentFacility": {
- "key": 1
}, - "deviatingPercentageThirtyPercentFacility": 20.2345,
- "doesWageIncludeAow": false,
- "doesWageIncludeWajong": false,
- "hasEmployeeLoan": false,
- "usesTransportByWithholdingAgent": false,
- "deviatingSmallJobsArrangement": false,
- "contributionReductionEducation": {
- "key": 2
}, - "applySingleElderlyTaxDeduction": false
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "annualSalary": 60000,
- "deviatingTaxTableCode": {
- "key": 1,
- "value": "999 Overige gevallen waarin geen tabel is toegepast"
}, - "deviatingPayrollTaxTableColour": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "applyDayTables": false,
- "deviatingPayrollTaxPercentage": 25,
- "applyDeviatingPayrollTaxPercentageOn": {
- "key": 2,
- "value": "Afwijkend voor tabel- en tariefloon"
}, - "applyPayrollTaxDeduction": true,
- "applyStudentDeduction": false,
- "residentOf": {
- "key": 2,
- "value": "Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden"
}, - "applySalarysplit": {
- "key": 2,
- "value": "LB obv wereldinkomen (%NL/WI)"
}, - "percentageForeignIncome": 50,
- "deviatingCalculationRulePayrollTax": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "thirtyPercentFacility": {
- "key": 1,
- "value": "Netto"
}, - "deviatingPercentageThirtyPercentFacility": 20.2345,
- "doesWageIncludeAow": false,
- "doesWageIncludeWajong": false,
- "hasEmployeeLoan": false,
- "usesTransportByWithholdingAgent": false,
- "deviatingSmallJobsArrangement": false,
- "contributionReductionEducation": {
- "key": 2,
- "value": "4. Opleiding hbo"
}, - "specialIndication": {
- "one": 1,
- "two": 1,
- "three": 1,
- "four": 1
}, - "applySingleElderlyTaxDeduction": false
}
}
Details of a fiscal record
Activity name: GetFiscalPropertiesByFiscalPropertiesId
Get the details of fiscal
path Parameters
fiscalPropertiesId required | string <uuid> The unique identifier of the fiscal properties record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "annualSalary": 60000,
- "deviatingTaxTableCode": {
- "key": 1,
- "value": "999 Overige gevallen waarin geen tabel is toegepast"
}, - "deviatingPayrollTaxTableColour": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "applyDayTables": false,
- "deviatingPayrollTaxPercentage": 25,
- "applyDeviatingPayrollTaxPercentageOn": {
- "key": 2,
- "value": "Afwijkend voor tabel- en tariefloon"
}, - "applyPayrollTaxDeduction": true,
- "applyStudentDeduction": false,
- "residentOf": {
- "key": 2,
- "value": "Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden"
}, - "applySalarysplit": {
- "key": 2,
- "value": "LB obv wereldinkomen (%NL/WI)"
}, - "percentageForeignIncome": 50,
- "deviatingCalculationRulePayrollTax": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "thirtyPercentFacility": {
- "key": 1,
- "value": "Netto"
}, - "deviatingPercentageThirtyPercentFacility": 20.2345,
- "doesWageIncludeAow": false,
- "doesWageIncludeWajong": false,
- "hasEmployeeLoan": false,
- "usesTransportByWithholdingAgent": false,
- "deviatingSmallJobsArrangement": false,
- "contributionReductionEducation": {
- "key": 2,
- "value": "4. Opleiding hbo"
}, - "specialIndication": {
- "one": 1,
- "two": 1,
- "three": 1,
- "four": 1
}, - "applySingleElderlyTaxDeduction": false
}
}
Edit the details of a fiscal record
Activity name: PutFiscalPropertiesByFiscalPropertiesId
Edit the details for a fiscal properties record
Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
path Parameters
fiscalPropertiesId required | string <uuid> The unique identifier of the fiscal properties record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: required
Fiscal to edit.
startDate | string <date> (components-schemas-startDate) The start date of the entity. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. |
annualSalary | number <double> (annualSalary) [ 0 .. 999999999 ] ^(\d{0,9})$ The fiscal annual salary. NL: Fiscaal jaarloon |
object or null <metadata> (deviatingTaxTableCode) 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 | |
object <metadata> (deviatingPayrollTaxTableColour) 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 | |
applyDayTables | boolean or null (applyDayTables) Indicates whether the value of the day table is used for the calculation of payroll tax. NL: DagtabelToepassen |
deviatingPayrollTaxPercentage | number or null <double> (deviatingPayrollTaxPercentage) [ 0 .. 99.99 ] ^(\d{1,2})(\.\d{1,2})?$ Indicates the deviating payroll tax percentage which is to be applied. NL: AfwijkendLoonbelastingPercentage |
object <metadata> (applyDeviatingPayrollTaxPercentageOn) Indicates on what type of payroll calculation the deviating payroll tax percentage is applicable. NL: AfwijkendPercentageToepassen | |
applyPayrollTaxDeduction | boolean (applyPayrollTaxDeduction) Indicates whether payroll tax deduction is appliclable (loonheffingskorting). NL: ArbeidskortingToepassen |
applyStudentDeduction | boolean or null (applyStudentDeduction) Apply the "Scholierenregeling". NL; ArbeidskortingToepassen |
object <metadata> (residentOf) Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen. NL: InwonerVan | |
object <metadata> (applySalarysplit) Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen. | |
percentageForeignIncome | number or null <double> (percentageForeignIncome) [ 0.01 .. 99.99 ] ^(\d{1,2})(\.\d{1,2})?$ Indicates what percentage of the income of this employment is taxable outside the Netherlands. NL: PercentageBuitenlandsInkomen |
object <metadata> (deviatingCalculationRulePayrollTax) Indicates if, while calculating payroll taxes and social security contributions, certain deviations are applicable. NL; Herleidingsregel | |
object or null <metadata> (thirtyPercentFacility) If the employee comes to work in the Netherlands from another country, the employer may grant an untaxed reimbursement. (30%-regeling). | |
deviatingPercentageThirtyPercentFacility | number or null <double> (deviatingPercentageThirtyPercentFacility) [ 0.000001 .. 29.999999 ] ^(\d{1,2})(\.\d{1,6})?$ Indicates a deviating percentage which should be applied for the 30% facility (30%-regeling) |
doesWageIncludeAow | boolean (doesWageIncludeAow) Indicates whether wage include AOW pension (affects payrolling). NL: LoonInclusiefAowUitkering |
doesWageIncludeWajong | boolean (doesWageIncludeWajong) Indicates whether wage include Wajong benefits (affects payrolling). NL: LoonInclusiefWajong |
hasEmployeeLoan | boolean (hasEmployeeLoan) Whether an employee loan (Personeelslening) is applicable may be indicated here. The Personeelslening indirectly affects the income tax calculations. |
usesTransportByWithholdingAgent | boolean (usesTransportByWithholdingAgent) The so-called 'vervoer vanwege inhoudingsplichtige' is a tax rule that may apply. By example when the employer organizes the transport for the employee. |
deviatingSmallJobsArrangement | boolean or null (deviatingSmallJobsArrangement) Kleine banenregeling |
object or null <metadata> (contributionReductionEducation) Afdr. verm. onderwijs | |
applySingleElderlyTaxDeduction | boolean (applySingleElderlyTaxDeduction) Indicates whether wage include Wajong benefits (affects payrolling). NL: LoonInclusiefWajong |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "annualSalary": 60000,
- "deviatingTaxTableCode": {
- "key": 1
}, - "deviatingPayrollTaxTableColour": {
- "key": 2
}, - "applyDayTables": false,
- "deviatingPayrollTaxPercentage": 25,
- "applyDeviatingPayrollTaxPercentageOn": {
- "key": 2
}, - "applyPayrollTaxDeduction": true,
- "applyStudentDeduction": false,
- "residentOf": {
- "key": 2
}, - "applySalarysplit": {
- "key": 2
}, - "percentageForeignIncome": 50,
- "deviatingCalculationRulePayrollTax": {
- "key": 2
}, - "thirtyPercentFacility": {
- "key": 1
}, - "deviatingPercentageThirtyPercentFacility": 20.2345,
- "doesWageIncludeAow": false,
- "doesWageIncludeWajong": false,
- "hasEmployeeLoan": false,
- "usesTransportByWithholdingAgent": false,
- "deviatingSmallJobsArrangement": false,
- "contributionReductionEducation": {
- "key": 2
}, - "applySingleElderlyTaxDeduction": false
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "annualSalary": 60000,
- "deviatingTaxTableCode": {
- "key": 1,
- "value": "999 Overige gevallen waarin geen tabel is toegepast"
}, - "deviatingPayrollTaxTableColour": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "applyDayTables": false,
- "deviatingPayrollTaxPercentage": 25,
- "applyDeviatingPayrollTaxPercentageOn": {
- "key": 2,
- "value": "Afwijkend voor tabel- en tariefloon"
}, - "applyPayrollTaxDeduction": true,
- "applyStudentDeduction": false,
- "residentOf": {
- "key": 2,
- "value": "Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden"
}, - "applySalarysplit": {
- "key": 2,
- "value": "LB obv wereldinkomen (%NL/WI)"
}, - "percentageForeignIncome": 50,
- "deviatingCalculationRulePayrollTax": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "thirtyPercentFacility": {
- "key": 1,
- "value": "Netto"
}, - "deviatingPercentageThirtyPercentFacility": 20.2345,
- "doesWageIncludeAow": false,
- "doesWageIncludeWajong": false,
- "hasEmployeeLoan": false,
- "usesTransportByWithholdingAgent": false,
- "deviatingSmallJobsArrangement": false,
- "contributionReductionEducation": {
- "key": 2,
- "value": "4. Opleiding hbo"
}, - "specialIndication": {
- "one": 1,
- "two": 1,
- "three": 1,
- "four": 1
}, - "applySingleElderlyTaxDeduction": false
}
}
Delete a specific fiscal properties record
Activity name: DeleteFiscalPropertiesByFiscalPropertiesId
Delete a fiscal properties record for the employment
path Parameters
fiscalPropertiesId required | string <uuid> The unique identifier of the fiscal properties record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Calculate AnnualSalary
Activity name: GetCalculatedAnnualSalaryByPayrollAdministrationId
Get calculated values for the annual salary for employments within a payroll administration. Only eligable employments are included in the result.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "annualSalary": 60000
}
]
}
Create fiscal properties for multiple employments
Activity name : PostCollectiveFiscalPropertiesByEmployerId
Create new fiscal properties records for multiple employments of an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Fiscal properties to add.
employmentId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
startDate | string <date> The start date for the information in the record. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. |
annualSalary | number <double> (annualSalary) [ 0 .. 999999999 ] ^(\d{0,9})$ The fiscal annual salary. NL: Fiscaal jaarloon |
Responses
Request samples
- Payload
[- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "1995-05-21",
- "annualSalary": 60000
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
NL: Diversen salarisverwerking. A collection of a divers set of payroll, wagetax and pension variables.
List of other payroll variables for an employment
Activity name : GetOtherPayrollVariablesByEmploymentId
Get a list of the other payroll variables for an employment Other payroll variables are a set of infrequently used properties for the payroll (wage tax and pension) proces
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "productivityPercentage": 100,
- "payrollProperties": {
- "deviatingPremiumGroup": {
- "key": 2,
- "value": "(1) Agrarisch bedrijf kort"
}, - "wageCostBenefit": {
- "key": 2,
- "value": "LKV herplaatsen arbeidsgehandicapte werknemer"
}, - "wajongWithWageDispensation": false,
- "phaseClassification": {
- "key": 2,
- "value": "(38) Fase A zonder uitzendbeding met uitsluiting van ldv"
}, - "incidentalIncomeDeduction": {
- "key": 2,
- "value": "Bevalling of zwangerschap"
}, - "terminateIncomenumberFlexibleEmployment": {
- "key": 2,
- "value": "(1) Einde werk/contract, geen werk aangeboden"
}, - "applyMinimumWageVocationalLearningPathway": true,
- "occupationalDisabilityPremiumDiscount": {
- "key": 2,
- "value": "(7) Werknemer van 62, 63 of 64 jaar voor wie code 6 niet van toepassing is"
}, - "occupationalDisabilityDeductionAfter2009": 1,
- "occupationalDisabilityDeductionTo2009": 1,
- "collectiveLaborAgreementCodeHiringEmployer": {
- "key": 151,
- "value": "TUINBOUWVEILINGEN",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23"
}, - "applyYearlyHoursNorm": false
}, - "pensionProperties": {
- "annualCalculationBaseAbp": 1.5,
- "leaveAbp": {
- "leaveType": {
- "key": 2,
- "value": "Politiek verlof"
}, - "valueOfParticipationDuringLeave": 1
}, - "deviatingDisabilityInsuranceActPercentageForCordares": {
- "key": 2,
- "value": "15- 25 %"
}, - "applyDispensationRiskFund": false,
- "compulsoryEducationDays": 2,
- "occupationalPensionFund": 2,
- "specificationOfIncomeRelationshipApg": {
- "key": 1,
- "value": "Geen bijzonderheden",
- "code": "WNE"
}
}, - "insuranceProperties": {
- "applicableForNoRiskPolicy": false
}
}
]
}
Add other payroll variables for an employment
Activity name : PostOtherPayrollVariablesByEmploymentId
Add other payroll variables for an employment.
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the POST URL.
Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add other payroll variables for an employment
startDate | string <date> The date on which this record starts. A (broken chain)[./#section/Data/Date-chains] is maintained with this record. |
endDate | string or null <date> The end date of the entity. The date is up to and including. |
productivityPercentage | number <double> [ 0 .. 100 ] ^(\d{1,3})(\.\d{1,2})?$ productivityPercentage (Productiviteitspercentage) can be used to indicate the productivity percentage of an employment. |
object | |
object | |
object |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "productivityPercentage": 100,
- "payrollProperties": {
- "deviatingPremiumGroup": {
- "key": 2
}, - "wageCostBenefit": {
- "key": 2
}, - "wajongWithWageDispensation": false,
- "phaseClassification": {
- "key": 2
}, - "incidentalIncomeDeduction": {
- "key": 2
}, - "terminateIncomenumberFlexibleEmployment": {
- "key": 2
}, - "applyMinimumWageVocationalLearningPathway": true,
- "occupationalDisabilityPremiumDiscount": {
- "key": 2
}, - "occupationalDisabilityDeductionAfter2009": 1,
- "occupationalDisabilityDeductionTo2009": 1,
- "collectiveLaborAgreementCodeHiringEmployer": {
- "key": 151
}, - "applyYearlyHoursNorm": false
}, - "pensionProperties": {
- "annualCalculationBaseAbp": 1.5,
- "leaveAbp": {
- "leaveType": {
- "key": 2
}, - "valueOfParticipationDuringLeave": 1
}, - "deviatingDisabilityInsuranceActPercentageForCordares": {
- "key": 2
}, - "applyDispensationRiskFund": false,
- "compulsoryEducationDays": 2,
- "occupationalPensionFund": 2,
- "specificationOfIncomeRelationshipApg": {
- "key": 1
}
}, - "insuranceProperties": {
- "applicableForNoRiskPolicy": false
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "productivityPercentage": 100,
- "payrollProperties": {
- "deviatingPremiumGroup": {
- "key": 2,
- "value": "(1) Agrarisch bedrijf kort"
}, - "wageCostBenefit": {
- "key": 2,
- "value": "LKV herplaatsen arbeidsgehandicapte werknemer"
}, - "wajongWithWageDispensation": false,
- "phaseClassification": {
- "key": 2,
- "value": "(38) Fase A zonder uitzendbeding met uitsluiting van ldv"
}, - "incidentalIncomeDeduction": {
- "key": 2,
- "value": "Bevalling of zwangerschap"
}, - "terminateIncomenumberFlexibleEmployment": {
- "key": 2,
- "value": "(1) Einde werk/contract, geen werk aangeboden"
}, - "applyMinimumWageVocationalLearningPathway": true,
- "occupationalDisabilityPremiumDiscount": {
- "key": 2,
- "value": "(7) Werknemer van 62, 63 of 64 jaar voor wie code 6 niet van toepassing is"
}, - "occupationalDisabilityDeductionAfter2009": 1,
- "occupationalDisabilityDeductionTo2009": 1,
- "collectiveLaborAgreementCodeHiringEmployer": {
- "key": 151,
- "value": "TUINBOUWVEILINGEN",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23"
}, - "applyYearlyHoursNorm": false
}, - "pensionProperties": {
- "annualCalculationBaseAbp": 1.5,
- "leaveAbp": {
- "leaveType": {
- "key": 2,
- "value": "Politiek verlof"
}, - "valueOfParticipationDuringLeave": 1
}, - "deviatingDisabilityInsuranceActPercentageForCordares": {
- "key": 2,
- "value": "15- 25 %"
}, - "applyDispensationRiskFund": false,
- "compulsoryEducationDays": 2,
- "occupationalPensionFund": 2,
- "specificationOfIncomeRelationshipApg": {
- "key": 1,
- "value": "Geen bijzonderheden",
- "code": "WNE"
}
}, - "insuranceProperties": {
- "applicableForNoRiskPolicy": false
}
}
}
Details of other payroll variables for an employment
Activity name : GetOtherPayrollVariablesByOtherPayrollVariablesId
Get the details of other payroll variables for an employment
path Parameters
otherPayrollVariablesId required | string <uuid> The unique identifier of the other payroll variables record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "productivityPercentage": 100,
- "payrollProperties": {
- "deviatingPremiumGroup": {
- "key": 2,
- "value": "(1) Agrarisch bedrijf kort"
}, - "wageCostBenefit": {
- "key": 2,
- "value": "LKV herplaatsen arbeidsgehandicapte werknemer"
}, - "wajongWithWageDispensation": false,
- "phaseClassification": {
- "key": 2,
- "value": "(38) Fase A zonder uitzendbeding met uitsluiting van ldv"
}, - "incidentalIncomeDeduction": {
- "key": 2,
- "value": "Bevalling of zwangerschap"
}, - "terminateIncomenumberFlexibleEmployment": {
- "key": 2,
- "value": "(1) Einde werk/contract, geen werk aangeboden"
}, - "applyMinimumWageVocationalLearningPathway": true,
- "occupationalDisabilityPremiumDiscount": {
- "key": 2,
- "value": "(7) Werknemer van 62, 63 of 64 jaar voor wie code 6 niet van toepassing is"
}, - "occupationalDisabilityDeductionAfter2009": 1,
- "occupationalDisabilityDeductionTo2009": 1,
- "collectiveLaborAgreementCodeHiringEmployer": {
- "key": 151,
- "value": "TUINBOUWVEILINGEN",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23"
}, - "applyYearlyHoursNorm": false
}, - "pensionProperties": {
- "annualCalculationBaseAbp": 1.5,
- "leaveAbp": {
- "leaveType": {
- "key": 2,
- "value": "Politiek verlof"
}, - "valueOfParticipationDuringLeave": 1
}, - "deviatingDisabilityInsuranceActPercentageForCordares": {
- "key": 2,
- "value": "15- 25 %"
}, - "applyDispensationRiskFund": false,
- "compulsoryEducationDays": 2,
- "occupationalPensionFund": 2,
- "specificationOfIncomeRelationshipApg": {
- "key": 1,
- "value": "Geen bijzonderheden",
- "code": "WNE"
}
}, - "insuranceProperties": {
- "applicableForNoRiskPolicy": false
}
}
]
}
Change the details of an other payroll variables record
Activity name : PutOtherPayrollVariablesByOtherPayrollVariablesId
Change the details of an other payroll variables record
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
path Parameters
otherPayrollVariablesId required | string <uuid> The unique identifier of the other payroll variables record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
startDate | string <date> The date on which this record starts. A (broken chain)[./#section/Data/Date-chains] is maintained with this record. |
endDate | string or null <date> The end date of the entity. The date is up to and including. |
productivityPercentage | number <double> [ 0 .. 100 ] ^(\d{1,3})(\.\d{1,2})?$ productivityPercentage (Productiviteitspercentage) can be used to indicate the productivity percentage of an employment. |
object | |
object | |
object |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "productivityPercentage": 100,
- "payrollProperties": {
- "deviatingPremiumGroup": {
- "key": 2
}, - "wageCostBenefit": {
- "key": 2
}, - "wajongWithWageDispensation": false,
- "phaseClassification": {
- "key": 2
}, - "incidentalIncomeDeduction": {
- "key": 2
}, - "terminateIncomenumberFlexibleEmployment": {
- "key": 2
}, - "applyMinimumWageVocationalLearningPathway": true,
- "occupationalDisabilityPremiumDiscount": {
- "key": 2
}, - "occupationalDisabilityDeductionAfter2009": 1,
- "occupationalDisabilityDeductionTo2009": 1,
- "collectiveLaborAgreementCodeHiringEmployer": {
- "key": 151
}, - "applyYearlyHoursNorm": false
}, - "pensionProperties": {
- "annualCalculationBaseAbp": 1.5,
- "leaveAbp": {
- "leaveType": {
- "key": 2
}, - "valueOfParticipationDuringLeave": 1
}, - "deviatingDisabilityInsuranceActPercentageForCordares": {
- "key": 2
}, - "applyDispensationRiskFund": false,
- "compulsoryEducationDays": 2,
- "occupationalPensionFund": 2,
- "specificationOfIncomeRelationshipApg": {
- "key": 1
}
}, - "insuranceProperties": {
- "applicableForNoRiskPolicy": false
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "productivityPercentage": 100,
- "payrollProperties": {
- "deviatingPremiumGroup": {
- "key": 2,
- "value": "(1) Agrarisch bedrijf kort"
}, - "wageCostBenefit": {
- "key": 2,
- "value": "LKV herplaatsen arbeidsgehandicapte werknemer"
}, - "wajongWithWageDispensation": false,
- "phaseClassification": {
- "key": 2,
- "value": "(38) Fase A zonder uitzendbeding met uitsluiting van ldv"
}, - "incidentalIncomeDeduction": {
- "key": 2,
- "value": "Bevalling of zwangerschap"
}, - "terminateIncomenumberFlexibleEmployment": {
- "key": 2,
- "value": "(1) Einde werk/contract, geen werk aangeboden"
}, - "applyMinimumWageVocationalLearningPathway": true,
- "occupationalDisabilityPremiumDiscount": {
- "key": 2,
- "value": "(7) Werknemer van 62, 63 of 64 jaar voor wie code 6 niet van toepassing is"
}, - "occupationalDisabilityDeductionAfter2009": 1,
- "occupationalDisabilityDeductionTo2009": 1,
- "collectiveLaborAgreementCodeHiringEmployer": {
- "key": 151,
- "value": "TUINBOUWVEILINGEN",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23"
}, - "applyYearlyHoursNorm": false
}, - "pensionProperties": {
- "annualCalculationBaseAbp": 1.5,
- "leaveAbp": {
- "leaveType": {
- "key": 2,
- "value": "Politiek verlof"
}, - "valueOfParticipationDuringLeave": 1
}, - "deviatingDisabilityInsuranceActPercentageForCordares": {
- "key": 2,
- "value": "15- 25 %"
}, - "applyDispensationRiskFund": false,
- "compulsoryEducationDays": 2,
- "occupationalPensionFund": 2,
- "specificationOfIncomeRelationshipApg": {
- "key": 1,
- "value": "Geen bijzonderheden",
- "code": "WNE"
}
}, - "insuranceProperties": {
- "applicableForNoRiskPolicy": false
}
}
}
Delete a specific other payroll variables record
Activity name : DeleteOtherPayrollVariablesByOtherPayrollVariablesId
Delete an existing other payroll variables record (for an employment)
path Parameters
otherPayrollVariablesId required | string <uuid> The unique identifier of the other payroll variables record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
NL: Sociale verzekering. The configuration of these social security indications determines how these are handled in the payroll calculation processes for this employment.
List of social security records for an employment
Activity name: GetSocialSecurityConfigurationsByEmploymentId
Get the list of social security configuration records for an employment
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "isInsuredForSicknessBenefitsAct": true,
- "isInsuredForUnemploymentInsuranceAct": true,
- "isInsuredForOccupationalDisabilityInsuranceAct": true
}
]
}
Create a social security record for an employment
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.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Social security record to add to the employment.
startDate | string <date> The start date of the entity. Valide values are either the startDate of the employment or the firstday of a payrolling year. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. |
isInsuredForSicknessBenefitsAct | boolean Will contributions for the Sickness Benefits Act (ZW) be payed for this employment |
isInsuredForUnemploymentInsuranceAct | boolean Will contributions for the Unemployment Insurance Act (WW) be payed for this employment |
isInsuredForOccupationalDisabilityInsuranceAct | boolean Will contributions for the Occupational Disability Insurance Act (WAO) be payed for this employment |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "isInsuredForSicknessBenefitsAct": true,
- "isInsuredForUnemploymentInsuranceAct": true,
- "isInsuredForOccupationalDisabilityInsuranceAct": true
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "isInsuredForSicknessBenefitsAct": true,
- "isInsuredForUnemploymentInsuranceAct": true,
- "isInsuredForOccupationalDisabilityInsuranceAct": true
}
}
Details of a social security record
Activity name: GetSocialSecurityConfigurationBySocialSecurityConfigurationId
Get the details of a social security configuration record
path Parameters
socialSecurityConfigurationId required | string <uuid> The unique identifier of the social security record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "isInsuredForSicknessBenefitsAct": true,
- "isInsuredForUnemploymentInsuranceAct": true,
- "isInsuredForOccupationalDisabilityInsuranceAct": true
}
}
Edit the details of a social security record
Activity name: PutSocialSecurityConfigurationBySocialSecurityConfigurationId
Edit the details for a social security record
path Parameters
socialSecurityConfigurationId required | string <uuid> The unique identifier of the social security record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Social security record to edit.
startDate | string <date> The start date of the entity. Valide values are either the startDate of the employment or the firstday of a payrolling year. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. |
isInsuredForSicknessBenefitsAct | boolean Will contributions for the Sickness Benefits Act (ZW) be payed for this employment |
isInsuredForUnemploymentInsuranceAct | boolean Will contributions for the Unemployment Insurance Act (WW) be payed for this employment |
isInsuredForOccupationalDisabilityInsuranceAct | boolean Will contributions for the Occupational Disability Insurance Act (WAO) be payed for this employment |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "isInsuredForSicknessBenefitsAct": true,
- "isInsuredForUnemploymentInsuranceAct": true,
- "isInsuredForOccupationalDisabilityInsuranceAct": true
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "isInsuredForSicknessBenefitsAct": true,
- "isInsuredForUnemploymentInsuranceAct": true,
- "isInsuredForOccupationalDisabilityInsuranceAct": true
}
}
Delete a specific social security record
Activity name: DeleteSocialSecurityConfigurationBySocialSecurityConfigurationId
Delete a social security record for the employment
path Parameters
socialSecurityConfigurationId required | string <uuid> The unique identifier of the social security record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
NL: Extra dienstverband. Create an additonal employment for an already existing Employee (tweede dienstverband)
Create employment for existing employee
Activity name : PostEmploymentByEmployeeId
Create an additional employment for an already existing employee.
Please note that the creation of an Employment is not RESTful by design.
In Loket, when a new Employee is created it will have to be created including its underlying Employment and its accessory resources. This specific endpoint is relevant in the following scenario: there is already an Employee with at least one Employment, and one wishes to create an additional Employment for that currently existing Employee. When successfully calling this endpoint, an Employment with its accessory resources will be created.
Metadata :
* Possible options (metadata) for generic fields of the type \metadata" can be acquired (GET) by adding /metadata
to the URL.
* Possible options dependent on a specific payrollAdministration can be acquired by adding /metadata/payrolladministration/{payrollAdministrationId}
to the url.
* Possible options for payGrade can be acquired by adding metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}
to the url.
A payGrade
has time based values dictating the wage for a given period. These values can be acquired by performing another metadata request by adding /metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}/paygrade/{payGradeKey}
to the url. This endpoint has the optional parameter "date" that may be used to specifying a measure date.
Defaults : Default values for a new object can be acquired by adding /defaults
to the URL.
Default values that are dependent on the selected payroll administration can be acquired by adding ../providers/employers/employees/employments/defaults/payrolladministration/{payrollAdministrationId}
to the URL.
NonPayrollAdministrations For nonPayrollAdministrations the equivalent metaData-endpoints are also available as described above. Also, a defaults endpoint is available for the nonPayrollAdministration. Please note that this requires ../nonpayrolladministrations/{nonPayrollAdministrationId}
in the path.
"
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
The request body contains an object for the additional employment.
object (schemas-employee) | |
object (schemas-employment) | |
object (schemas-workingHours) | |
object (components-schemas-wage) | |
object (components-schemas-organizationalEntity) | |
object (components-schemas-socialSecurity) | |
object (components-schemas-fiscal) | |
object (components-schemas-otherPayrollVariables) |
Responses
Request samples
- Payload
{- "employeeData": {
- "iban": "NL52ABNA0424968264"
}, - "employmentData": {
- "startDate": "2019-01-01",
- "historicalStartDate": "2012-05-01",
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "nonPayrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "commissionUntilDate": "2019-01-01",
- "incomeRelationshipNumber": 12,
- "employeeProfileId": {
- "key": 1
}, - "employmentDurationType": {
- "key": 1
}, - "startDateContractOfIndefiniteDuration": "2018-05-08",
- "employmentContractType": {
- "key": 1
}, - "typeOfEmployee": {
- "key": 1
}, - "cancellationPeriodEmployee": 1,
- "cancellationPeriodEmployer": 1,
- "cancellationPeriodTimeUnit": {
- "key": 4
}, - "cancellationNoticeDate": "2019-05-31",
- "startCancellationNoticePeriod": "2019-06-01",
- "isDirectorAndMajorShareholder": false,
- "isOnCallEmployment": true,
- "hasOnCallAppearanceObligation": true,
- "vacationCoupons": {
- "key": 1
}, - "specialIncomeRatio": {
- "key": 0
}, - "isAnonymousEmployee": true,
- "isPreviousOwner": false,
- "isFamilyOfOwner": false,
- "isGemoedsbezwaardNationalInsurance": true,
- "isGemoedsbezwaardEmployeeInsurance": true,
- "namePayslip": "Steve Jobs",
- "calculateWorkingHours": true,
- "essMutationSet": {
- "key": 1
}, - "exemptionInsuranceObligation": {
- "key": 0
}, - "firstDayNotification": false,
- "sendMdvNotification": true,
- "periodPayGradeAdjustment": 2,
- "signalPayGradeAdjustment": false,
- "typeOfParticipation": {
- "key": 0
}, - "valueOfParticipation": {
- "key": 0
}, - "professionCode": 4,
- "deviatingCLATaxReturn": 2,
- "participation55plusRegulationUWV": false,
- "writtenEmploymentContract": true
}, - "workingHoursData": {
- "shift": {
- "shiftNumber": 1
}, - "deviatingHoursPerWeek": 32,
- "deviatingSvDaysPerPeriod": 32,
- "averageParttimeFactor": 37.5,
- "regularWorkPattern": true,
- "flexibleHoursContract": {
- "key": 0
}, - "contractCode": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "calculateUsingWorkPattern": {
- "leaveHours": true,
- "hoursBrokenPeriod": false,
- "hoursPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "workPattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "wageData": {
- "grossWage": 23,
- "grossWageType": {
- "key": 2
}, - "netWage": 1,
- "netWageType": { },
- "payScale": { },
- "payGrade": { },
- "applyPayGrade": true
}, - "organizationalEntityData": {
- "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "standardFunction": {
- "key": 1
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "placeOfEmployment": "Amsterdam office",
- "internalTelephoneExtensionNumber": "0133031600"
}, - "socialSecurityData": {
- "isInsuredForSicknessBenefitsAct": false,
- "isInsuredForUnemploymentInsuranceAct": false,
- "isInsuredForOccupationalDisabilityInsuranceAct": false,
- "healthCareInsuranceActType": {
- "key": 2
}
}, - "fiscalData": {
- "annualSalary": 60000,
- "deviatingPayrollTaxTableColour": {
- "key": 2
}, - "applyDayTables": false,
- "deviatingPayrollTaxPercentage": 27.45,
- "applyDeviatingPayrollTaxPercentageOn": {
- "key": 2
}, - "applyPayrollTaxDeduction": false,
- "applyStudentDeduction": false,
- "deviatingCalculationRulePayrollTax": {
- "key": 2
}, - "residentOf": {
- "key": 2
}
}, - "otherPayrollVariablesData": {
- "deviatingPremiumGroup": {
- "key": 2
}
}
}
Response samples
- 201
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
Create transition compensation employment for existing employment
Activity name : PostTransitionCompensationEmploymentByEmploymentId
Create an additional employment for an already existing and terminated employment with the sole purpose to pay out a transition compensation.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01
This endpoint does not require a request body. However, the Accept
header does need to be set to ensure the correct resource version is used.
Responses
Request samples
- Payload
{ }
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
Activate employee profile for the employment
Activity name : PatchEmployeeProfileByEmploymentId
Create Fondsen, Grondslagen and toeslagen based on the employment's employeeProfile.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01
activationDate | string <date> The date on which the profile should be activated. |
employeeProfileId | integer or null <int32> The Id of the employeeProfile. If not provided, the employeeProfile which is set at employment level, is used. |
Responses
Request samples
- Payload
{- "activationDate": "2021-01-01",
- "employeeProfileId": 1
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "employmentFunds": [
- "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
], - "employmentFundsABP": [
- "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
], - "basesForCalculation": [
- "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
], - "benefitsAndDeductions": [
- "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
]
}
}
List of Contacts for an employer
Activity name: GetContactsByEmployerId
Get the list of Contacts for all employees of an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "contacts": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Johanna Bakker",
- "description": "Moeder",
- "phoneNumber": "013-12345678",
- "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "postalCode": "1234 AA",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "particularities": "Genoemd adres is een priveadres"
}
}
]
}
List of Children for an employer
Activity name: GetChildrenByEmployerId
Get the list of Children for all employees of an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "children": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "dateOfBirth": "1995-05-21",
- "dateOfDeath": "2019-08-24",
- "gender": {
- "key": 2,
- "value": "female"
}, - "residenceStatus": {
- "key": 2,
- "value": "Living at home"
}
}
}
]
}
List of citizenServiceNumber for an employer
Activity name: GetCitizenServiceNumbersByEmployerId
Get the list of citizenServiceNumber for all employees of an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "citizenServiceNumber": {
- "citizenServiceNumber": "042168588"
}
}
]
}
List of employee custom fields for an employer
Activity name: GetEmployeeCustomFieldsByEmployerId
Get the list of custom fields for all employees of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeCustomFields": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "customField": {
- "id": "025ce09b-bff2-4b05-bcf0-711a89da7c08",
- "description": "Shoe size"
}, - "value": "41"
}
}
]
}
List of Partners for an employer
Activity name: GetActualPartnersByEmployerId
Get the list of Actual partners for all employees of an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "partner": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "1995-05-21",
- "endDate": "1995-05-21",
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "dateOfDeath": "2019-08-24",
- "howToFormatLastName": {
- "key": 2,
- "value": "last name + last name partner"
}, - "title": {
- "key": 2,
- "value": "e.g. Msc, PHD or Baron"
}, - "gender": {
- "key": 2,
- "value": "female"
}, - "waoClassification": {
- "key": 2,
- "value": "15 - 24"
}
}
}
]
}
List of employment custom fields for an employer
Activity name: GetEmploymentCustomFieldsByEmployerId
Get the list of custom fields for all employments of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employmentCustomFields": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "customField": {
- "id": "025ce09b-bff2-4b05-bcf0-711a89da7c08",
- "description": "Shoe size"
}, - "value": "41"
}
}
]
}
List of payment information for an employer
Activity name: GetPaymentInformationSepaByEmployerId
Get the list of sepa paymentinformation for all employments of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "paymentInformationSepa": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollComponent": {
- "key": 260,
- "value": "NETTOLOON"
}, - "iban": "NL52ABNA0424968264",
- "bic": "AUDFDE21",
- "visibleOnPayslip": true,
- "nameBeneficiary": "Ben Hur",
- "cityBeneficiary": "Rome",
- "description1": "xx",
- "description2": "x"
}
}
]
}
List of actual organizational entities for an employer
Activity name: GetActualOrganizationalEntitiesByEmployerId
Get the list of actual organizational entities for an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "organizationalEntity": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Directeur",
- "group": "internal"
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "standardFunction": {
- "key": 1,
- "value": "Administrateur",
- "code": "A21",
- "category": 1
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}, - "placeOfEmployment": "Amsterdam office",
- "internalTelephoneExtensionNumber": "678"
}
}
]
}
List of actual wages for an employer
Activity name: GetActualWagesByEmployerId
Get the list of actual wages for an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "wage": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "1995-05-21",
- "endDate": "2019-08-24",
- "payrollPeriodType": {
- "key": 1,
- "value": "Maand"
}, - "grossWage": 2300,
- "grossWageType": {
- "key": 2,
- "value": "hourly"
}, - "isGrossWageFullTime": true,
- "netWage": 2400,
- "netWageType": {
- "key": 1,
- "value": "hourly"
}, - "employerCosts": 3500,
- "employerCostsType": {
- "key": 1,
- "value": "hourly"
}, - "payScale": {
- "key": 1,
- "value": "Glastuinbouw maand, Loongebouw A"
}, - "payGrade": {
- "key": 1,
- "value": "Schaal B1, 15 jaar"
}, - "applyPayGrade": true
}
}
]
}
List of actual working hours for an employer
Activity name: GetActualWorkingHoursByEmployerId
Get the list of actual working hours for an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "workingHours": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "shift": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "deviatingHoursPerWeek": 32,
- "averageHoursPerWeek": 32,
- "deviatingSvDaysPerPeriod": 20,
- "averageParttimeFactor": 37.5,
- "regularWorkPattern": true,
- "shiftRateSickLeave": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "flexibleHoursContract": {
- "key": 2,
- "value": "Minimum uren contract"
}, - "workPattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}, - "calculateUsingWorkPattern": {
- "leaveHours": true,
- "hoursBrokenPeriod": false,
- "hoursRegularPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "contractCode": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 1022,
- "description": "SLA-PT-met toeslagen ATW (88)"
}, - "aggregatedHoursPerWeek": 24
}
}
]
}
List of actual benefitsanddeductions for an employer
Activity name: GetActualBenefitsAndDeductionsByEmployerId
Get the list of actual benefitsanddeductions for an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "benefitsAndDeductions": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "1995-05-21",
- "endDate": "2019-08-24",
- "payrollComponent": {
- "key": 1,
- "description": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}
}, - "value": 50.87
}
}
]
}
List of actual employmentfunds for an employer
Activity name: GetActualEmploymentFundsByEmployerId
Get the list of actual employmentfunds for all employments of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employmentFund": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "fund": {
- "key": 1,
- "description": "Ouderdomspensioen"
}, - "deviations": {
- "employmentContributionPercentage": 11,
- "totalContributionPercentage": 12.0007
}, - "fixedContribution": {
- "employmentContribution": 1789,
- "totalContribution": 2569
}
}
}
]
}
List of actual abpfunds for an employer
Activity name: GetActualAbpFundsByEmployerId
Get the list of actual abpfunds for all employments of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "abpFund": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "fund": {
- "key": 1,
- "description": "Ouderdomspensioen"
}, - "deviations": {
- "employmentContributionPercentage": 11,
- "totalContributionPercentage": 12.007
}, - "fixedContribution": {
- "employmentContribution": 1789,
- "totalContribution": 2569
}
}
}
]
}
List of actual fiscal properties for an employer
Activity name: GetActualFiscalPropertiesByEmployerId
Get the list of actual fiscal properties for all employments of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "fiscalProperties": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "annualSalary": 60000,
- "deviatingTaxTableCode": {
- "key": 1,
- "value": "999 Overige gevallen waarin geen tabel is toegepast"
}, - "deviatingPayrollTaxTableColour": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "applyDayTables": false,
- "deviatingPayrollTaxPercentage": 25,
- "applyDeviatingPayrollTaxPercentageOn": {
- "key": 2,
- "value": "Afwijkend voor tabel- en tariefloon"
}, - "applyPayrollTaxDeduction": true,
- "applyStudentDeduction": false,
- "residentOf": {
- "key": 2,
- "value": "Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden"
}, - "applySalarysplit": {
- "key": 2,
- "value": "LB obv wereldinkomen (%NL/WI)"
}, - "percentageForeignIncome": 50,
- "deviatingCalculationRulePayrollTax": {
- "key": 2,
- "value": "Werknemer belastingpl. en niet premiepl. WLZ"
}, - "thirtyPercentFacility": {
- "key": 1,
- "value": "Netto"
}, - "deviatingPercentageThirtyPercentFacility": 20.2345,
- "doesWageIncludeAow": false,
- "doesWageIncludeWajong": false,
- "hasEmployeeLoan": false,
- "usesTransportByWithholdingAgent": false,
- "deviatingSmallJobsArrangement": false,
- "contributionReductionEducation": {
- "key": 2,
- "value": "4. Opleiding hbo"
}, - "specialIndication": {
- "one": 1,
- "two": 1,
- "three": 1,
- "four": 1
}, - "applySingleElderlyTaxDeduction": false
}
}
]
}
List of actual healthcare configurations for an employer
Activity name: GetActualHealthCareInsuranceActConfigurationsByEmployerId
Get the list of actual healthcare insurance act configurations for all employments of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "healthCareInsuranceActConfiguration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "healthcareInsuranceActType": {
- "key": 2,
- "value": "(C/K) Wel verzekeringsplichtig, normaal tarief"
}, - "additionalContributionEmployer": 320,
- "nominalPremium": 320,
- "additionalPremium": 120
}
}
]
}
List of actual social security configurations for an employer
Activity name: GetActualSocialSecurityConfigurationsByEmployerId
Get the list of actual social security configurations for all employments of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "socialSecurityConfiguration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "isInsuredForSicknessBenefitsAct": true,
- "isInsuredForUnemploymentInsuranceAct": true,
- "isInsuredForOccupationalDisabilityInsuranceAct": true
}
}
]
}
List of actual social security benefits for an employer
Activity name: GetActualSocialSecurityBenefitsByEmployerId
Get the list of actual social security benefits for all employments of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "socialSecurityBenefits": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "supplementation": {
- "type": {
- "key": 3,
- "value": "Suppleren (bruto)"
}, - "percentage": 35
}, - "benefit": {
- "type": {
- "key": 1,
- "value": "ZW eigen risico"
}, - "percentage": 35
}
}
}
]
}
List of actual awf contributions for an employer
Activity name: GetActualDeviatingAwfContributionsByEmployerId
Get the list of actual deviating awf contributions for all employments of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "deviatingAwfContribution": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "typeOfDeviatingAwfContribution": {
- "key": 2,
- "value": "Hoog"
}
}
}
]
}
List of actual benefits in kind for an employer
Activity name: GetActualBenefitsInKindByEmployerId
Get the list of actual benefits in kind for all employments of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "benefitsInKind": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "benefitInKindType": {
- "id": "36530F13-59EB-4C15-B5F2-4F92B070A208",
- "description": "Mobiele telefoon"
}, - "brand": "Apple",
- "type": "Iphone 11",
- "value": 1100,
- "supplier": "Mediamarkt",
- "particularities": "geen bijzonderheden"
}
}
]
}
List of actual company cars for an employer
Activity name: GetActualCompanyCarsByEmployerId
Get the list of actual company cars for all employments of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "companyCars": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "brand": "Volvo",
- "model": "V60",
- "licensePlateNumber": "GP586D",
- "fuelCardNumber": "B100.323.903",
- "leaseOrBuy": {
- "key": 1,
- "value": "Koop"
}, - "supplier": "Leasemaatschappij Tilburg",
- "lease": {
- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "contractNumber": "2021.323.903"
}, - "catalogValue": 20000,
- "kilometersPrivateUse": 10000,
- "comments": "This car is very nice"
}
}
]
}
List of actual fiscal company cars for an employer
Activity name: GetActualFiscalCompanyCarsByEmployerId
Get the list of actual fiscal company cars for all employments of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "fiscalCompanyCars": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2021-01-01",
- "endDate": "2023-10-23",
- "licensePlateNumber": "GP586D",
- "dateOfFirstAdmission": "2018-01-01",
- "valueForTaxPurposes": 20000,
- "additionalTaxLiabilityGroup": {
- "key": 1,
- "value": "Standaard tarief (25% tot 2017)"
}, - "reasonForNoAdditionalTaxLiability": {
- "key": 1,
- "value": "(2) Werknemer heeft beschikking belastingdienst"
}, - "deviatingAdditionalTaxLiability": 20000,
- "taxableBenefitForPrivateUse": 2000
}
}
]
}
List of actual journal allocations for an employer
Activity name: GetActualJournalAllocationsByEmployerId
Get the list of actual journal allocations for all employments of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "journalAllocations": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "journalProfileConfiguration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2017-01-01",
- "periodEndDate": "2017-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2017-01-01",
- "periodEndDate": "2017-01-31"
}, - "journalProfile": {
- "key": 2,
- "value": "General ledger supermarkets"
}
}, - "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "allocationBasedOnActualHours": {
- "costCenter": {
- "key": 2,
- "code": "SAL073",
- "description": "Sales Den Bosch"
}, - "costUnit": {
- "key": 2,
- "code": "01",
- "description": "Cars"
}
}, - "allocationBasedOnFixedWeights": [
- {
- "costCenter": {
- "key": 2,
- "code": "SAL073",
- "description": "Sales Den Bosch"
}, - "costUnit": {
- "key": 2,
- "code": "01",
- "description": "Cars"
}, - "weight": 1
}
]
}
}
]
}
List of actual bases for calculation for an employer
Activity name: GetActualBasesForCalculationByEmployerId
Get the list of actual bases for calculation for all employments of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "basesForCalculation": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "deviations": {
- "percentage": 8,
- "reservationPercentage": 12.0007,
- "financialReservationPercentage": 10.000007
}, - "ageBasedMinimum": {
- "key": 2,
- "value": "Toepassen hoogste leeftijd"
}, - "ageBasedMaximum": {
- "key": 2,
- "value": "Toepassen hoogste leeftijd"
}, - "base": {
- "key": 545,
- "value": "VAKANTIE TOESLAG, periodieke opbouw"
}
}
}
]
}
List of actual other payrollvariables for an employer
Activity name: GetActualOtherPayrollVariablesByEmployerId
Get the list of actual other payrollvariables for all employments of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "otherPayrollVariables": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "productivityPercentage": 100,
- "payrollProperties": {
- "deviatingPremiumGroup": {
- "key": 2,
- "value": "(1) Agrarisch bedrijf kort"
}, - "wageCostBenefit": {
- "key": 2,
- "value": "LKV herplaatsen arbeidsgehandicapte werknemer"
}, - "wajongWithWageDispensation": false,
- "phaseClassification": {
- "key": 2,
- "value": "(38) Fase A zonder uitzendbeding met uitsluiting van ldv"
}, - "incidentalIncomeDeduction": {
- "key": 2,
- "value": "Bevalling of zwangerschap"
}, - "terminateIncomenumberFlexibleEmployment": {
- "key": 2,
- "value": "(1) Einde werk/contract, geen werk aangeboden"
}, - "applyMinimumWageVocationalLearningPathway": true,
- "occupationalDisabilityPremiumDiscount": {
- "key": 2,
- "value": "(7) Werknemer van 62, 63 of 64 jaar voor wie code 6 niet van toepassing is"
}, - "occupationalDisabilityDeductionAfter2009": 1,
- "occupationalDisabilityDeductionTo2009": 1,
- "collectiveLaborAgreementCodeHiringEmployer": {
- "key": 151,
- "value": "TUINBOUWVEILINGEN",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23"
}, - "applyYearlyHoursNorm": false
}, - "pensionProperties": {
- "annualCalculationBaseAbp": 1.5,
- "leaveAbp": {
- "leaveType": {
- "key": 2,
- "value": "Politiek verlof"
}, - "valueOfParticipationDuringLeave": 1
}, - "deviatingDisabilityInsuranceActPercentageForCordares": {
- "key": 2,
- "value": "15- 25 %"
}, - "applyDispensationRiskFund": false,
- "compulsoryEducationDays": 2,
- "occupationalPensionFund": 2,
- "specificationOfIncomeRelationshipApg": {
- "key": 1,
- "value": "Geen bijzonderheden",
- "code": "WNE"
}
}, - "insuranceProperties": {
- "applicableForNoRiskPolicy": false
}
}
}
]
}
List of actual payment information non sepa for an employer
Activity name: GetActualPaymentInformationNonSepaByEmployerId
Get the list of actual payment information non sepa records for all employments of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "paymentInformationNonSepa": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollComponent": {
- "key": 260,
- "value": "NETTOLOON"
}, - "bankAccountNumber": "0403830171874018",
- "beneficiary": {
- "name": "Ben Hur",
- "city": "Rome",
- "address": "Via Roma 3",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "bank": {
- "bankIdentifierCode": "AUDFDE21",
- "name": "Ben Hur",
- "city": "Rome",
- "address": "Via Roma 3",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}
}
}
]
}
List of actual bases for employment fund calculation for an employer
Activity name: GetActualBasesForEmploymentFundCalculationByEmployerId
Get the list of actual bases for employment fund calculation for all employments of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "basesForEmploymentFundCalculation": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "origin": {
- "key": 1,
- "value": "Normale wijziging"
}, - "base": 25000
}
}
]
}
List of actual pension benefits for an employer
Activity name: GetActualPensionBenefitsByEmployerId
Get the list of actual pension benefits for all employments of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "pensionBenefits": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "payout": 2569
}
}
]
}
List of actual deviating hourly wage for an employer
Activity name: GetActualDeviatingHourlyWagesByEmployerId
Get the list of actual deviating hourly wage for all employments of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "deviatingHourlyWage": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "payrollComponent": {
- "key": 70,
- "description": "LOON/SALARIS"
}, - "value": 50.87
}
}
]
}
List of actual cost per hour for an employer
Activity name: GetActualCostPerHourByEmployerId
Get the list of actual cost per hour for all employments of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
includeEstimation | boolean Example: includeEstimation=true include an estimation if no cost per unit records are present |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "costperhour": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriods": {
- "id": 202001,
- "year": 2020,
- "periodNumber": 1,
- "startDate": "2020-01-01",
- "endDate": "2020-01-31"
}, - "costPerHour": 21.2,
- "registrationMethod": {
- "key": 1,
- "value": "Verloning"
}
}
}
]
}
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.
List of Deviating AWF contributions records for an employment
Activity name: GetDeviatingAwfContributionsByEmploymentId Get the list of Deviating AWF contributions records for an employment
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "typeOfDeviatingAwfContribution": {
- "key": 2,
- "value": "Hoog"
}
}
]
}
Create a Deviating AWF contributions record for an employment
Activity name: PostDeviatingAwfContributionByEmploymentId Create a Deviating AWF contributions record for an employment
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata
to the POST URL.
Defaults: Default values for a new object can be acquired by adding `/defaults' to the POST URL.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Deviating AWF Contribution record to add to the employment.
object <metadata> (startPeriod) | |
object or null <metadata> (endPeriod) | |
object <metadata> |
Responses
Request samples
- Payload
{- "startPeriod": {
- "year": 2017,
- "periodNumber": 1
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1
}, - "typeOfDeviatingAwfContribution": {
- "key": 2
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "typeOfDeviatingAwfContribution": {
- "key": 2,
- "value": "Hoog"
}
}
}
Details of a Deviating AWF contributions record
Activity name: GetDeviatingAwfContributionByDeviatingAwfContributionId
Get the details of a Deviating AWF contributions record
path Parameters
deviatingAwfContributionId required | string <uuid> The unique identifier of the Deviating AWF contribution record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "typeOfDeviatingAwfContribution": {
- "key": 2,
- "value": "Hoog"
}
}
}
Edit the details of a Deviating AWF contributions record
Activity name: PutDeviatingAwfContributionByDeviatingAwfContributionId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding / metadata
to the PUT URL.
Edit the details for a Deviating AWF contribution record
path Parameters
deviatingAwfContributionId required | string <uuid> The unique identifier of the Deviating AWF contribution record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Deviating AWF Contribution record to edit.
object <metadata> (startPeriod) | |
object or null <metadata> (endPeriod) | |
object <metadata> |
Responses
Request samples
- Payload
{- "startPeriod": {
- "year": 2017,
- "periodNumber": 1
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1
}, - "typeOfDeviatingAwfContribution": {
- "key": 2
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "typeOfDeviatingAwfContribution": {
- "key": 2,
- "value": "Hoog"
}
}
}
Delete a specific Deviating AWF contributions record
Activity name: DeleteDeviatingAwfContributionByDeviatingAwfContributionId
Delete a Deviating AWF contribution record for the employment
path Parameters
deviatingAwfContributionId required | string <uuid> The unique identifier of the Deviating AWF contribution record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
NL: Transitievergoeding. Calculation help for determining tranistion compensation amount (transitievergoeding)
Get default input parameters transition compensation
Activity name : GetCalculateTransitionCompensationDefaultsByEmploymentId
Get the default values of the input parameters for the POST action.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "grossMonthlyWage": 2300,
- "grossMonthlySupplement": 212,
- "shiftBonusPercentage": 12,
- "baseCalculationsBonusPercentage": 12
}
}
Calculate transition compensation
This is a controller endpoint to perform a calculation. No actual data will be stored as a result of these actions.
Activity name : PostCalculateTransitionCompensationByEmploymentId
Defaults : Default values for a new object can be acquired by adding /defaults
to the POST URL. This will only include the default values for the input parameter fields (the actual calculation of the transition compensation is not part of that)
A calculation help for determining the transition compensation amount. (rekenhulp transitievergoeding)
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Transition compensation input parameters
startDate | string <date> The date on which this employment starts. |
endDate | string <date> The date on which the employment ends. |
grossMonthlyWage | number <double> [ 0 .. 999999.99 ] Gross wage/ basic wage for the employment per month. |
grossMonthlySupplement | number <double> [ 0 .. 999999.99 ] An additional monthly amount, if applicable. |
shiftBonusPercentage | number <double> [ 0 .. 99.99 ] The bonus percentage used in wage calculations based on given shift. |
baseCalculationsBonusPercentage | number <double> [ 0 .. 99.99 ] The bonus percentage used in wage calculations based on an accumulation of given base calculations (grondslagen) |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "grossMonthlyWage": 2300,
- "grossMonthlySupplement": 212,
- "shiftBonusPercentage": 12,
- "baseCalculationsBonusPercentage": 12
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "monthlyWage": 2300,
- "employmentDurationInDecimalYears": 3.5,
- "transitionCompensationAmount": 8050
}
}
List wachtgeld
Activity name : GetWachtgeldByEmploymentId
Get a list of wachtgeld of the employment.
Note: Wachtgeld, or redundancy pay, is an additional benefit that you receive on top of your unemployment benefit.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2021-06-01",
- "endDate": "2018-10-23",
- "value": 50.87,
- "valueAdditionalIncomeCivilService": 50.87,
- "valueAdditionalIncomeNonCivilService": 50.87
}
]
}
Add a wachtgeld for an employment
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.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a wachtgeld
startDate | string <date> The date on which this wachtgeld record starts. A (linked chain)[./#section/Data/Date-chains] per wachtgeld is maintained within this resource. So only one wachtgeld record can be active at the same time. |
value | number or null [ 0.01 .. 99999.99 ] ^(\d{1,5})(\.\d{1,2})?$ The value for the wachtgeld. |
valueAdditionalIncomeCivilService | number or null [ 0.01 .. 99999.99 ] ^(\d{1,5})(\.\d{1,2})?$ The value of additional income civil service (Neveninkomsten ambtelijk). |
valueAdditionalIncomeNonCivilService | number or null [ 0.01 .. 99999.99 ] ^(\d{1,5})(\.\d{1,2})?$ The value of additional income non civil service (Neveninkomsten niet ambtelijk). |
Responses
Request samples
- Payload
{- "startDate": "2021-06-01",
- "value": 50.87,
- "valueAdditionalIncomeCivilService": 50.87,
- "valueAdditionalIncomeNonCivilService": 50.87
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2021-06-01",
- "endDate": "2018-10-23",
- "value": 50.87,
- "valueAdditionalIncomeCivilService": 50.87,
- "valueAdditionalIncomeNonCivilService": 50.87
}
}
Details of wachtgeld
Activity name : GetWachtgeldByWachtgeldId
Get the details of a wachtgeld record
path Parameters
wachtgeldId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2021-06-01",
- "endDate": "2018-10-23",
- "value": 50.87,
- "valueAdditionalIncomeCivilService": 50.87,
- "valueAdditionalIncomeNonCivilService": 50.87
}
]
}
Edit a wachtgeld record
Activity name : PutWachtgeldByWachtgeldId
Metadata : No metadata.
path Parameters
wachtgeldId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
startDate | string <date> The date on which this wachtgeld record starts. A (linked chain)[./#section/Data/Date-chains] per wachtgeld is maintained within this resource. So only one wachtgeld record can be active at the same time. |
value | number or null [ 0.01 .. 99999.99 ] ^(\d{1,5})(\.\d{1,2})?$ The value for the wachtgeld. |
valueAdditionalIncomeCivilService | number or null [ 0.01 .. 99999.99 ] ^(\d{1,5})(\.\d{1,2})?$ The value of additional income civil service (Neveninkomsten ambtelijk). |
valueAdditionalIncomeNonCivilService | number or null [ 0.01 .. 99999.99 ] ^(\d{1,5})(\.\d{1,2})?$ The value of additional income non civil service (Neveninkomsten niet ambtelijk). |
Responses
Request samples
- Payload
{- "startDate": "2021-06-01",
- "value": 50.87,
- "valueAdditionalIncomeCivilService": 50.87,
- "valueAdditionalIncomeNonCivilService": 50.87
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2021-06-01",
- "endDate": "2018-10-23",
- "value": 50.87,
- "valueAdditionalIncomeCivilService": 50.87,
- "valueAdditionalIncomeNonCivilService": 50.87
}
}
Delete a wachtgeld record
Activity name : DeleteWachtgeldByWachtgeldId
Delete an existing wachtgeld record
path Parameters
wachtgeldId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Collective set SignalPayGradeAdjustment
Activity name : PatchCollectiveSignalPayGradeAdjustmentByEmployerId
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/jsonrequired
The request body contains an array of employments.
id required | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier (GUID/UUID) of the employment |
action required | string Enum: "enable" "disable" The action to perform. |
Responses
Request samples
- Payload
[- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "action": "enable"
}
]
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download actual master data report (Stamgegevens actueel)
Activity name : GetEmploymentActualMasterDataReportByEmploymentId
Acquire the actual master data report (Stamgegevens actueel) on employment level, as generated by the reporting service.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
referenceDate required | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download master data report (Stamgegevens)
Activity name : GetEmploymentMasterDataReportByEmploymentId
Acquire the master data report (Stamgegevens) on employment level, as generated by the reporting service.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of contacts for an employee
Activity name : GetContactsByEmployeeId
Get list of contacts for an employee
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Johanna Bakker",
- "description": "Moeder",
- "phoneNumber": "013-12345678",
- "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "postalCode": "1234 AA",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "particularities": "Genoemd adres is een priveadres"
}
]
}
Create a contact for an employee
Activity name : PostContactByEmployeeId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the POST URL.
Defaults : No default values
Create a new contact for an employee
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Contact to add to the employee.
name | string <= 70 characters Name of the contact |
description | string <= 50 characters Describes the relationship of the contact to the employee |
phoneNumber | string or null <= 15 characters The phone number of the contact |
object or null | |
particularities | string or null <= 4000 characters Extra information about the contact |
Responses
Request samples
- Payload
{- "name": "Johanna Bakker",
- "description": "Moeder",
- "phoneNumber": "013-12345678",
- "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "postalCode": "1234 AA",
- "country": {
- "key": 1
}
}, - "particularities": "Genoemd adres is een priveadres"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Johanna Bakker",
- "description": "Moeder",
- "phoneNumber": "013-12345678",
- "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "postalCode": "1234 AA",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "particularities": "Genoemd adres is een priveadres"
}
}
Details of a single contact
Activity name : GetContactByContactId
Get the details of a single contact
path Parameters
contactId required | string <uuid> The unique identifier of the employee contact detail |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Johanna Bakker",
- "description": "Moeder",
- "phoneNumber": "013-12345678",
- "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "postalCode": "1234 AA",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "particularities": "Genoemd adres is een priveadres"
}
}
Edit a contact
Activity name : PutContactByContactId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
Edit the details of a contact
path Parameters
contactId required | string <uuid> The unique identifier of the employee contact detail |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Contact to edit.
name | string <= 70 characters Name of the contact |
description | string <= 50 characters Describes the relationship of the contact to the employee |
phoneNumber | string or null <= 15 characters The phone number of the contact |
object or null | |
particularities | string or null <= 4000 characters Extra information about the contact |
Responses
Request samples
- Payload
{- "name": "Johanna Bakker",
- "description": "Moeder",
- "phoneNumber": "013-12345678",
- "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "postalCode": "1234 AA",
- "country": {
- "key": 1
}
}, - "particularities": "Genoemd adres is een priveadres"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Johanna Bakker",
- "description": "Moeder",
- "phoneNumber": "013-12345678",
- "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "postalCode": "1234 AA",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "particularities": "Genoemd adres is een priveadres"
}
}
Delete a specific contact
Activity name : DeleteContactByContactId
Delete an existing Contact (for an employee)
path Parameters
contactId required | string <uuid> The unique identifier of the employee contact detail |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of children for an employee
Activity name : GetChildrenByEmployeeId
Get the list of children of the employee
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "dateOfBirth": "1995-05-21",
- "dateOfDeath": "2019-08-24",
- "gender": {
- "key": 2,
- "value": "female"
}, - "residenceStatus": {
- "key": 2,
- "value": "Living at home"
}
}
]
}
Create an child for an employee
Activity name : PostChildByEmployeeId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the POST URL.
Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.
Add a child for an employee
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a child for an employee.
firstName | string or null (firstName) [ 1 .. 28 ] characters The first name, given name, forename or Christian name as part of a persons personal name. |
lastName | string (lastName) [ 1 .. 25 ] characters The last name, family name or surname as part of a persons personal name. |
prefix | string or null (prefix) [ 1 .. 10 ] characters The prefix to the last name |
initials | string (schemas-initials) [ 1 .. 6 ] characters The initials |
dateOfBirth | string <date> (dateOfBirth) The date of birth |
dateOfDeath | string or null <date> (dateOfDeath) The date of death |
object <metadata> (gender) The gender | |
object or null <metadata> Indicator to tell if the child is living at home or not. Use null if unknown. |
Responses
Request samples
- Payload
{- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "dateOfBirth": "1995-05-21",
- "dateOfDeath": "2019-08-24",
- "gender": {
- "key": 2
}, - "residenceStatus": {
- "key": 2
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "dateOfBirth": "1995-05-21",
- "dateOfDeath": "2019-08-24",
- "gender": {
- "key": 2,
- "value": "female"
}, - "residenceStatus": {
- "key": 2,
- "value": "Living at home"
}
}
}
Details of a child
Activity name : GetChildByChildId
Get the details of a child
path Parameters
childId required | string <uuid> The unique identifier of a child |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "dateOfBirth": "1995-05-21",
- "dateOfDeath": "2019-08-24",
- "gender": {
- "key": 2,
- "value": "female"
}, - "residenceStatus": {
- "key": 2,
- "value": "Living at home"
}
}
}
Edit the details of a child
Activity name : PutChildByChildId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
Edit the details of a child
path Parameters
childId required | string <uuid> The unique identifier of a child |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Child to edit.
firstName | string or null (firstName) [ 1 .. 28 ] characters The first name, given name, forename or Christian name as part of a persons personal name. |
lastName | string (lastName) [ 1 .. 25 ] characters The last name, family name or surname as part of a persons personal name. |
prefix | string or null (prefix) [ 1 .. 10 ] characters The prefix to the last name |
initials | string (schemas-initials) [ 1 .. 6 ] characters The initials |
dateOfBirth | string <date> (dateOfBirth) The date of birth |
dateOfDeath | string or null <date> (dateOfDeath) The date of death |
object <metadata> (gender) The gender | |
object or null <metadata> Indicator to tell if the child is living at home or not. Use null if unknown. |
Responses
Request samples
- Payload
{- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "dateOfBirth": "1995-05-21",
- "dateOfDeath": "2019-08-24",
- "gender": {
- "key": 2
}, - "residenceStatus": {
- "key": 2
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "dateOfBirth": "1995-05-21",
- "dateOfDeath": "2019-08-24",
- "gender": {
- "key": 2,
- "value": "female"
}, - "residenceStatus": {
- "key": 2,
- "value": "Living at home"
}
}
}
Delete a specific child record
Activity name : DeleteChildByChildId
Delete an existing child (for an employee)
path Parameters
childId required | string <uuid> The unique identifier of a child |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of partners for an employee
Activity name : GetPartnersByEmployeeId
Get the list of partners of the employee
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "1995-05-21",
- "endDate": "1995-05-21",
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "dateOfDeath": "2019-08-24",
- "howToFormatLastName": {
- "key": 2,
- "value": "last name + last name partner"
}, - "title": {
- "key": 2,
- "value": "e.g. Msc, PHD or Baron"
}, - "gender": {
- "key": 2,
- "value": "female"
}, - "waoClassification": {
- "key": 2,
- "value": "15 - 24"
}
}
]
}
Create the partner for an employee
Activity name : PostPartnerByEmployeeId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the POST URL.
Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.
Create the partner for an employee
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Partner to add to the employee.
startDate | string or null <date> startdate |
endDate | string or null <date> end date |
firstName | string or null (firstName) [ 1 .. 28 ] characters The first name, given name, forename or Christian name as part of a persons personal name. |
lastName | string (lastName) [ 1 .. 25 ] characters The last name, family name or surname as part of a persons personal name. |
prefix | string or null (prefix) [ 1 .. 10 ] characters The prefix to the last name |
initials | string or null [ 1 .. 6 ] characters The initials |
dateOfBirth | string <date> (dateOfBirth) The date of birth |
placeOfBirth | string or null (placeOfBirth) [ 1 .. 24 ] characters The place of birth |
dateOfDeath | string or null <date> (dateOfDeath) The date of death |
object <metadata> Indicates how the system will format the last name. | |
object or null <metadata> (title) The title to be used (if any). | |
object <metadata> (gender) The gender | |
object or null <metadata> The occupational disability classification in the form of a percentage range. |
Responses
Request samples
- Payload
{- "startDate": "1995-05-21",
- "endDate": "1995-05-21",
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "dateOfDeath": "2019-08-24",
- "howToFormatLastName": {
- "key": 2
}, - "title": {
- "key": 2
}, - "gender": {
- "key": 2
}, - "waoClassification": {
- "key": 2
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "1995-05-21",
- "endDate": "1995-05-21",
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "dateOfDeath": "2019-08-24",
- "howToFormatLastName": {
- "key": 2,
- "value": "last name + last name partner"
}, - "title": {
- "key": 2,
- "value": "e.g. Msc, PHD or Baron"
}, - "gender": {
- "key": 2,
- "value": "female"
}, - "waoClassification": {
- "key": 2,
- "value": "15 - 24"
}
}
}
Details of a single partner
Activity name : GetPartnerByPartnerId
Get the details of a single partner
path Parameters
partnerId required | string <uuid> The unique identifier of a partner |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "1995-05-21",
- "endDate": "1995-05-21",
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "dateOfDeath": "2019-08-24",
- "howToFormatLastName": {
- "key": 2,
- "value": "last name + last name partner"
}, - "title": {
- "key": 2,
- "value": "e.g. Msc, PHD or Baron"
}, - "gender": {
- "key": 2,
- "value": "female"
}, - "waoClassification": {
- "key": 2,
- "value": "15 - 24"
}
}
}
Edit the details for a partner
Activity name : PutPartnerByPartnerId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
Edit the partner information
path Parameters
partnerId required | string <uuid> The unique identifier of a partner |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Partner to edit.
startDate | string or null <date> startdate |
endDate | string or null <date> end date |
firstName | string or null (firstName) [ 1 .. 28 ] characters The first name, given name, forename or Christian name as part of a persons personal name. |
lastName | string (lastName) [ 1 .. 25 ] characters The last name, family name or surname as part of a persons personal name. |
prefix | string or null (prefix) [ 1 .. 10 ] characters The prefix to the last name |
initials | string or null [ 1 .. 6 ] characters The initials |
dateOfBirth | string <date> (dateOfBirth) The date of birth |
placeOfBirth | string or null (placeOfBirth) [ 1 .. 24 ] characters The place of birth |
dateOfDeath | string or null <date> (dateOfDeath) The date of death |
object <metadata> Indicates how the system will format the last name. | |
object or null <metadata> (title) The title to be used (if any). | |
object <metadata> (gender) The gender | |
object or null <metadata> The occupational disability classification in the form of a percentage range. |
Responses
Request samples
- Payload
{- "startDate": "1995-05-21",
- "endDate": "1995-05-21",
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "dateOfDeath": "2019-08-24",
- "howToFormatLastName": {
- "key": 2
}, - "title": {
- "key": 2
}, - "gender": {
- "key": 2
}, - "waoClassification": {
- "key": 2
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "1995-05-21",
- "endDate": "1995-05-21",
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "dateOfDeath": "2019-08-24",
- "howToFormatLastName": {
- "key": 2,
- "value": "last name + last name partner"
}, - "title": {
- "key": 2,
- "value": "e.g. Msc, PHD or Baron"
}, - "gender": {
- "key": 2,
- "value": "female"
}, - "waoClassification": {
- "key": 2,
- "value": "15 - 24"
}
}
}
Delete a specific partner record
Activity name : DeletePartnerByPartnerId
Delete an existing partner
path Parameters
partnerId required | string <uuid> The unique identifier of a partner |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of educations for an employee
Activity name : GetEducationsByEmployeeId
Get list of educations for an employee
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "HBO accountancy",
- "typeOfEducation": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "WO",
- "description": "Wetenschappelijk"
}, - "furtherIndication": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "WO",
- "description": "Wetenschappelijk"
}, - "educationLevel": {
- "key": 1,
- "value": "HBO"
}, - "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "institute": {
- "Name": "Avans Hogeschool",
- "city": "Leiden"
}, - "hasDiploma": {
- "key": 1,
- "value": "Onbekend"
}, - "yearOfDiploma": 1995,
- "endOfValidityDate": "2023-12-31",
- "employeeCosts": 150,
- "employerCosts": 850,
- "particularities": "Van de opleiding is alleen een certificaat verkregen"
}
]
}
Create a education for an employee
Activity name : PostEducationByEmployeeId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the POST URL.
Defaults : No default values
Create a new education for an employee
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Education to add to the employee.
name | string <= 50 characters Name of the education |
object or null <metadata> The type of the education. | |
object or null <metadata> The futher indication of the education. | |
object or null <metadata> Indicates the level of the education. | |
startDate | string or null <date> The date on which this education starts. |
endDate | string or null <date> The end date of the entity. The date is up to and including. |
object or null | |
object or null <metadata> Indicates whether the employee has graduated. | |
yearOfDiploma | integer or null <int32> [ 1900 .. 2099 ] Year in which the diploma was aquired |
endOfValidityDate | string or null <date> The end date of the diploma validity . The date is up to and including. |
employeeCosts | number or null <double> >= 0.01 The costs of the education for the employee |
employerCosts | number or null <double> >= 0.01 The costs of the education for the employer |
particularities | string or null <= 4000 characters Extra information about the education |
Responses
Request samples
- Payload
{- "name": "HBO accountancy",
- "typeOfEducation": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "furtherIndication": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "educationLevel": {
- "key": 1
}, - "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "institute": {
- "Name": "Avans Hogeschool",
- "city": "Leiden"
}, - "hasDiploma": {
- "key": 1
}, - "yearOfDiploma": 1995,
- "endOfValidityDate": "2023-12-31",
- "employeeCosts": 150,
- "employerCosts": 850,
- "particularities": "Van de opleiding is alleen een certificaat verkregen"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "HBO accountancy",
- "typeOfEducation": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "WO",
- "description": "Wetenschappelijk"
}, - "furtherIndication": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "WO",
- "description": "Wetenschappelijk"
}, - "educationLevel": {
- "key": 1,
- "value": "HBO"
}, - "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "institute": {
- "Name": "Avans Hogeschool",
- "city": "Leiden"
}, - "hasDiploma": {
- "key": 1,
- "value": "Onbekend"
}, - "yearOfDiploma": 1995,
- "endOfValidityDate": "2023-12-31",
- "employeeCosts": 150,
- "employerCosts": 850,
- "particularities": "Van de opleiding is alleen een certificaat verkregen"
}
}
Details of a single education
Activity name : GetEducationByEducationId
Get the details of a single education
path Parameters
employeeEducationId required | string <uuid> The unique identifier of the employee education detail |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "HBO accountancy",
- "typeOfEducation": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "WO",
- "description": "Wetenschappelijk"
}, - "furtherIndication": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "WO",
- "description": "Wetenschappelijk"
}, - "educationLevel": {
- "key": 1,
- "value": "HBO"
}, - "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "institute": {
- "Name": "Avans Hogeschool",
- "city": "Leiden"
}, - "hasDiploma": {
- "key": 1,
- "value": "Onbekend"
}, - "yearOfDiploma": 1995,
- "endOfValidityDate": "2023-12-31",
- "employeeCosts": 150,
- "employerCosts": 850,
- "particularities": "Van de opleiding is alleen een certificaat verkregen"
}
}
Edit a Education
Activity name : PutEducationByEducationId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
Edit the details of a education
path Parameters
employeeEducationId required | string <uuid> The unique identifier of the employee education detail |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Education to edit.
name | string <= 50 characters Name of the education |
object or null <metadata> The type of the education. | |
object or null <metadata> The futher indication of the education. | |
object or null <metadata> Indicates the level of the education. | |
startDate | string or null <date> The date on which this education starts. |
endDate | string or null <date> The end date of the entity. The date is up to and including. |
object or null | |
object or null <metadata> Indicates whether the employee has graduated. | |
yearOfDiploma | integer or null <int32> [ 1900 .. 2099 ] Year in which the diploma was aquired |
endOfValidityDate | string or null <date> The end date of the diploma validity . The date is up to and including. |
employeeCosts | number or null <double> >= 0.01 The costs of the education for the employee |
employerCosts | number or null <double> >= 0.01 The costs of the education for the employer |
particularities | string or null <= 4000 characters Extra information about the education |
Responses
Request samples
- Payload
{- "name": "HBO accountancy",
- "typeOfEducation": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "furtherIndication": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "educationLevel": {
- "key": 1
}, - "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "institute": {
- "Name": "Avans Hogeschool",
- "city": "Leiden"
}, - "hasDiploma": {
- "key": 1
}, - "yearOfDiploma": 1995,
- "endOfValidityDate": "2023-12-31",
- "employeeCosts": 150,
- "employerCosts": 850,
- "particularities": "Van de opleiding is alleen een certificaat verkregen"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "HBO accountancy",
- "typeOfEducation": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "WO",
- "description": "Wetenschappelijk"
}, - "furtherIndication": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "WO",
- "description": "Wetenschappelijk"
}, - "educationLevel": {
- "key": 1,
- "value": "HBO"
}, - "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "institute": {
- "Name": "Avans Hogeschool",
- "city": "Leiden"
}, - "hasDiploma": {
- "key": 1,
- "value": "Onbekend"
}, - "yearOfDiploma": 1995,
- "endOfValidityDate": "2023-12-31",
- "employeeCosts": 150,
- "employerCosts": 850,
- "particularities": "Van de opleiding is alleen een certificaat verkregen"
}
}
Delete a specific education
Activity name : DeleteEducationByEducationId
Delete an existing Education (for an employee)
path Parameters
employeeEducationId required | string <uuid> The unique identifier of the employee education detail |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List education further indications for an employer
Activity name : GetEducationFurtherIndicationsByEmployerId
Get a list of the education further indications for an employer.
Note: The education further indications defined at the employer level can be used as value for the field furtherIndication in the Education resource at the employee level.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "lts",
- "description": "Lagere technische school"
}
]
}
Add an education further indication for an employer
Activity name : PostEducationFurtherIndicationByEmployerId
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add an education further indication
code | string [ 1 .. 10 ] characters ^[\s\S]*\S[\s\S]*$ An unique code for the eduction further indication within the scope of the employer |
description | string [ 1 .. 50 ] characters ^[\s\S]*\S[\s\S]*$ The description of the education furhter indication |
Responses
Request samples
- Payload
{- "code": "lts",
- "description": "Lagere technische school"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "lts",
- "description": "Lagere technische school"
}
}
Details of an education further indication
Activity name : GetEducationFurtherIndicationByEducationFurtherIndicationId
Get the details of an education further indication
path Parameters
educationFurtherIndicationId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "lts",
- "description": "Lagere technische school"
}
]
}
Edit an education further indication record
Activity name : PutEducationFurtherIndicationByEducationFurtherIndicationId
path Parameters
educationFurtherIndicationId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
code | string [ 1 .. 10 ] characters ^[\s\S]*\S[\s\S]*$ An unique code for the eduction further indication within the scope of the employer |
description | string [ 1 .. 50 ] characters ^[\s\S]*\S[\s\S]*$ The description of the education furhter indication |
Responses
Request samples
- Payload
{- "code": "lts",
- "description": "Lagere technische school"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "lts",
- "description": "Lagere technische school"
}
}
Delete an education further indication record
Activity name : DeleteEducationFurtherIndicationByEducationFurtherIndicationId
Delete an existing education further indication record
path Parameters
educationFurtherIndicationId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List education types for an employer
Activity name : GetEducationTypesByEmployerId
Get a list of the education types for an employer.
Note: The education types defined at the employer level can be used as value for the field typeOfEducation in the Education resource at the employee level.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "WO",
- "description": "Wetenschappelijk onderwijs"
}
]
}
Add an education type for an employer
Activity name : PostEducationTypeByEmployerId
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add an education type
code | string [ 1 .. 10 ] characters ^[\s\S]*\S[\s\S]*$ An unique code for the eduction type within the scope of the employer |
description | string [ 1 .. 50 ] characters ^[\s\S]*\S[\s\S]*$ The description of the education type |
Responses
Request samples
- Payload
{- "code": "WO",
- "description": "Wetenschappelijk onderwijs"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "WO",
- "description": "Wetenschappelijk onderwijs"
}
}
Details of an education type
Activity name : GetEducationTypeByEducationTypeId
Get the details of an education type
path Parameters
educationTypeId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "WO",
- "description": "Wetenschappelijk onderwijs"
}
]
}
Edit an education type record
Activity name : PutEducationTypeByEducationTypeId
path Parameters
educationTypeId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
code | string [ 1 .. 10 ] characters ^[\s\S]*\S[\s\S]*$ An unique code for the eduction type within the scope of the employer |
description | string [ 1 .. 50 ] characters ^[\s\S]*\S[\s\S]*$ The description of the education type |
Responses
Request samples
- Payload
{- "code": "WO",
- "description": "Wetenschappelijk onderwijs"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "WO",
- "description": "Wetenschappelijk onderwijs"
}
}
Delete an education type record
Activity name : DeleteEducationTypeByEducationTypeId
Delete an existing education type record
path Parameters
educationTypeId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Get available external tenants (provider scope)
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.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "externalId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Loket tenant"
}
]
}
Get available external tenants (employer scope)
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.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "externalId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Loket tenant"
}
]
}
External tenants may be used to login to Loket.nl via Azure Active Directory. In order to do that a user must be configured in such a way that it is allowed to a certain external tenant to log in. This resource contains the link between an employer user and an allowed external tenant (for that user)
Configured external tenant for an employer user
Activity name : GetConfiguredExternalTenantByEmployerUserId
Get the external tenant that is configured for this specific user.
path Parameters
employerUserId required | string <uuid> The unique identifier of a employer user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "externalTenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Loket tenant"
}, - "externalUser": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
}
Add an external tenant for an employer user
Activity name : PatchConfiguredExternalTenantByEmployerUserId
Metadata : N/A.
Defaults : N/A.
Modify an external tenant to the list of an configured external tenants for an employer user. An configured external tenant may be removed by sending a request body with both an empty externalTenant object and an empty externalUser object.
path Parameters
employerUserId required | string <uuid> The unique identifier of a employer user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add an external tenant for an employer user.
object or null | |
object or null |
Responses
Request samples
- Payload
{- "externalTenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "externalUser": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "externalTenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Loket tenant"
}, - "externalUser": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
}
External tenants may be used to login to Loket.nl via Azure Active Directory. In order to do that a user must be configured in such a way that it is allowed to a certain external tenant to log in. This resource contains the link between a provider user and an allowed external tenant (for that user)
Configured external tenant for a provider user
Activity name : GetConfiguredExternalTenantByProviderUserId
Get the external tenant that is configured for this specific user.
path Parameters
providerUserId required | string <uuid> The unique identifier of a provider user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "externalTenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Loket tenant"
}, - "externalUser": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
}
Add an external tenant for a provider user
Activity name : PatchConfiguredExternalTenantByProviderUserId
Metadata : N/A.
Defaults : N/A.
Modify an external tenant to the list of an configured external tenants for an employer user. An configured external tenant may be removed by sending a request body with both an empty externalTenant object and an empty externalUser object.
path Parameters
providerUserId required | string <uuid> The unique identifier of a provider user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add an external tenant for a provider user.
object or null | |
object or null |
Responses
Request samples
- Payload
{- "externalTenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "externalUser": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "externalTenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Loket tenant"
}, - "externalUser": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
}
list of insurance contracts
Activity name : GetAchmeaInsuranceContractsByUserId Get a list of all Achmea insurance contracts accessible to the current user
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "belongsToEmployerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-05-21",
- "endDate": "2025-05-21",
- "contractNumber": "0015697843"
}
]
}
list of wage percentages for an insurance contract
Activity name : GetWagePercentagesByAchmeaInsuranceContractId
Get a list of all wage percentages (year-end bonus and holiday allowance percentages) for an Achmea insurance contract.
path Parameters
achmeaInsuranceContractId required | string <uuid> The unique identifier of an Achmea insurance contract |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-21",
- "endDate": "2019-08-24",
- "yearEndPercentage": 15,
- "holidayAllowancePercentage": 8
}
]
}
Get Benify URL for an employee
Activity name : GetBenifyUrlByEmployeeId
Get a URL to access the Benify portal for an employee.
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
],
}
Get Yourcampus URL for a user
Activity name : GetYourcampusUrlByUserId
Get a URL to access the Yourcampus portal for a user
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
],
}
List of employers using Qwoater
Activity name : GetQwoaterEmployersByUser
Returns a list of employerIds that have at least one Qwoater product enabled with the corresponding providerId and lastModifiedVersionNumber for the employer.
What does the 'last modified' version number reflect
The sequence number of an employer is a sequential number that reflects whether any changes have occurred in any of its UNDERLYING employments.
More precisely, it reflects the sequence number after the latest change of any database record that relates to an employment within this employer. What we consider to be 'underlying' employment data is based on a predefined set of tables, and of course given id. This predefined set of tables can be found here
The scope of this predefined set is to represent 'static' employment data (vaste gegevens), and thus excludes payroll period data (variabele gegevens).
When to use
This endpoint is most useful for integrations that regularly synchronize Loket employment data with another system. As there are no webhooks available, in practice these integrations would need to regularly poll all data to see whether there any changes in the employment data. The most elementary approach of getting all employment data every time you sync acquires a LOT of calls, in some cases even millions per day. Even though we can handle quite a lot, this is not always the desired way for both client and server. Hence, this endpoint enables an alternative solution to set up such an integration.
How to use
With every update (including additions and deletions) the version number will increase. I.e. the version number will NEVER decrease over time. (Please note this is not only true within the context of a single employer (or any other entity) but applies to all changes in the database).
Consequently, in practice one would use this endpoint to check if any empLoyer version numbers have increased by applying the filter query parameter to the version field, for example ?filter=lastModifiedVersionNumber gt 70429274
.
Recommended usage
- Perform your regular synchronization of static employment data
- Store the highest version number, for which you have now processed all changes. (You may use the following parameter to do this
?orderBy=-lastModifiedVersionNumber
) - Next time you want to perform synchronization. Call this endpoint with parameter
?filter=lastModifiedVersionNumber gt {{YourVersionNumber}}
- Only get employment information for employers that are included in that filtered list. (exclude all other employers as you already know there have been no changes since the last synchronization)
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "providerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "lastModifiedVersionNumber": 70429274999853
}
]
}
List of journal runs for an administration
Activity name : GetJournalRunsByPayrollAdministrationId
Returns the journal runs for a payroll administration.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "sequenceNumber": 8,
- "payrollRun": {
- "payrollRunId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31",
- "testYear": false
}, - "sequenceNumberApproved": 6
}, - "journalRunStatus": {
- "key": 4,
- "value": "Journaal gereed"
}, - "requestTime": "2018-05-08T15:16:49+02:00",
- "processingFinishedTime": "2018-05-08T15:16:49+02:00",
- "requestedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "removeTime": "2018-05-08T15:16:49+02:00",
- "removedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "methodOfCreation": {
- "key": 2,
- "value": "Individueel"
}
}
]
}
Details of a journal run
Activity name : GetJournalRunByJournalRunId
Returns the details of a journal run.
path Parameters
journalrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "sequenceNumber": 8,
- "payrollRun": {
- "payrollRunId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31",
- "testYear": false
}, - "sequenceNumberApproved": 6
}, - "journalRunStatus": {
- "key": 4,
- "value": "Journaal gereed"
}, - "requestTime": "2018-05-08T15:16:49+02:00",
- "processingFinishedTime": "2018-05-08T15:16:49+02:00",
- "requestedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "removeTime": "2018-05-08T15:16:49+02:00",
- "removedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "methodOfCreation": {
- "key": 2,
- "value": "Individueel"
}
}
}
Change the status of a journal run
Activity name : PatchJournalRunByJournalRunId
Update the status of a journal run
- Action 'markAsSuccessfullyExported'; will change the status of the journal run to 'exported'. Please note this action will not perform an actual export, but simply allows the user the manage status to match their actualities.
- 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.
path Parameters
journalrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Change the status of a journal run
action | string Enum: "MarkAsProcessed" "MarkAsProcessingFailed" The action to perform on the journal run
|
object <metadata> The application that downloaded and processed the results | |
message | string or null <= 255 characters Message to be displayed to the loket.nl user |
Responses
Request samples
- Payload
{- "action": "MarkAsProcessed",
- "application": {
- "key": 2
}, - "message": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Initiate journal run (journaliseren)
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.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 202
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "sequenceNumber": 8,
- "payrollRun": {
- "payrollRunId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31",
- "testYear": false
}, - "sequenceNumberApproved": 6
}, - "journalRunStatus": {
- "key": 4,
- "value": "Journaal gereed"
}, - "requestTime": "2018-05-08T15:16:49+02:00",
- "processingFinishedTime": "2018-05-08T15:16:49+02:00",
- "requestedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "removeTime": "2018-05-08T15:16:49+02:00",
- "removedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "methodOfCreation": {
- "key": 2,
- "value": "Individueel"
}
}
}
Undo journal run (verwijderen journaalrun)
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
.
path Parameters
journalrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Recalculate journal for a payroll run
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."
path Parameters
payrollrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List export attempts for a journal run
Activity name : GetJournalRunExportAuditTrailByJournalRunId
Returns the export audit trail for a journal run
path Parameters
journalrunId required | string <uuid> The unique identifier of the payroll run |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "sequenceNumber": 8,
- "exportedOn": "2018-05-08T15:16:49+02:00",
- "exportedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "exportedTo": {
- "key": 2,
- "value": "Finance Plus"
}, - "methodOfExporting": {
- "key": 2,
- "value": "Download"
}, - "exportStatus": {
- "key": 4,
- "value": "Downloaded"
}, - "returendErrorMessage": "Could not find cost center Sales"
}
]
}
Errors of a journal run
Activity name : GetJournalRunErrorsByJournalRunId
Errors that occured while processing the journalrun can be obtained via this endpoint.
path Parameters
journalrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "error": {
- "key": 4,
- "value": "Geen verdeling gevonden voor de component, kostenplaats, kostendrager combinatie"
}, - "PayrollEmployeeNumber": 202,
- "generalLedgerAccount": {
- "key": 4,
- "code": "4002020",
- "description": "Cars"
}, - "costCenter": {
- "key": 2,
- "code": "SAL073",
- "description": "Sales Den Bosch"
}, - "costUnit": {
- "key": 2,
- "code": "01",
- "description": "Cars"
}, - "payrollComponent": {
- "key": 286,
- "description": "KINDEROPV.BEL"
}
}
]
}
Send the journal run
Activity name : PostSendJournalRunExportByJournalRunId
Send a journal run to a journal application. Use the defaults and metadata to acquire the journal application settings. The defaults endpoint contains values for all required fields.
There are two metadata endpoints:
/journalruns/{journalrunId}/send/metadata
/journalruns/{journalrunId}/send/metadata/accountId/{accountId}
path Parameters
journalrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Send the journal run to an external application
date | string <date> Date |
journalNumber | integer or null <int32> |
period | integer or null <int32> the period to which the journal should be added. |
financialYear | integer or null <int32> |
description | string or null |
object or null The administration in the journalapplication to which the journal will be added. | |
object or null The subadministration in the journalapplication to which the journal will be added. | |
journalCode | string or null |
includeCostCenter | boolean or null Indicates whether cost centers are included in the journal. |
includeCostUnit | boolean or null Indicates whether cost units are included in the journal. |
object or null The account to connect to the journal application. | |
accountKey | string or null |
deviatingJournalSeries | string or null |
linkCostCenterToGroup | string or null <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The Group to which the CostCenter will be linked. |
linkCostUnitToGroup | string or null <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The Group to which the CostUnit will be linked. |
suspenseAccount | string or null [ 1 .. 20 ] characters The "number" for the suspense account (is a string) |
Responses
Request samples
- Payload
{- "date": "2022-01-01",
- "journalNumber": 2,
- "period": 2,
- "financialYear": 2023,
- "description": "Opmerking 1",
- "administration": {
- "id": 223
}, - "subAdministration": {
- "Id": 223
}, - "journalCode": "2",
- "includeCostCenter": true,
- "includeCostUnit": false,
- "account": {
- "id": 2
}, - "accountKey": "User1",
- "deviatingJournalSeries": "Afwijking1",
- "linkCostCenterToGroup": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "linkCostUnitToGroup": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "suspenseAccount": "SAL-4000"
}
Response samples
- 202
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "date": "2022-01-01",
- "journalNumber": 2,
- "period": 2,
- "financialYear": 2023,
- "description": "Opmerking 1",
- "administration": {
- "id": 223,
- "value": "Administration A"
}, - "subAdministration": {
- "Id": 223,
- "Name": "Administration A"
}, - "user": "User1",
- "journalCode": "2",
- "includeCostCenter": true,
- "includeCostUnit": false,
- "account": {
- "id": 2,
- "value": "Account Jan"
}, - "accountKey": "User1",
- "deviatingJournalSeries": "Afwijking1",
- "linkCostCenterToGroup": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "linkCostUnitToGroup": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "suspenseAccount": "SAL-4000"
}
}
Download the journal run
Activity name : PostDownloadJournalRunExportByJournalRunId
Download a journal run to a journal application. Use the defaults and metadata to acquire the journal application settings.
path Parameters
journalrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Download the journal run to an external application
date | string <date> Date |
includeCostCenter | boolean Indicates whether cost centers are included in the journal. |
includeCostUnit | boolean Indicates whether cost units are included in the journal. |
suspenseAccount | string or null [ 1 .. 20 ] characters The "number" for the suspense account (is a string) |
Responses
Request samples
- Payload
{- "date": "2022-01-01",
- "includeCostCenter": true,
- "includeCostUnit": false,
- "suspenseAccount": "SAL-4000"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "date": "2022-01-01",
- "includeCostCenter": true,
- "includeCostUnit": false,
- "suspenseAccount": "SAL-4000"
}
}
Get journal results for a journal run
Activity name : GetJournalRunResultsByJournalRunId
Returns the journal run results for the journal run. Journal runs with journalRunStatus = 0,1,2,3 dont have results and this endpoint will return an error if called for a journal run with that status.
path Parameters
journalrunId required | string <uuid> The unique identifier of the payroll run |
query Parameters
consolidate | string Default: "BasedOnLedgerAccountConfiguration" Enum: "BasedOnLedgerAccountConfiguration" "Always" "Never" Dictates how the output is consolidated |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "generalLedgerAccount": {
- "key": 4,
- "code": "4002020",
- "description": "Cars"
}, - "costCenter": {
- "key": 2,
- "code": "SAL073",
- "description": "Sales Den Bosch"
}, - "costUnit": {
- "key": 2,
- "code": "01",
- "description": "Cars"
}, - "payrollComponent": {
- "key": 286,
- "description": "KINDEROPV.BEL"
}, - "debetAmount": 500.87,
- "creditAmount": 0
}
]
}
Get journal report for a journal run
Activity name : GetJournalRunReportByJournalRunId
Returns the journal run results for the journal run in a pdf report.
path Parameters
journalrunId required | string <uuid> The unique identifier of the payroll run |
query Parameters
consolidate | string Default: "BasedOnLedgerAccountConfiguration" Enum: "BasedOnLedgerAccountConfiguration" "Always" "Never" Dictates how the output is consolidated |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Get journal run overview for a journal run
Activity name : GetRunOverviewByJournalRunId
Returns the journal run overview in csv for the journal run. Journal runs with journalRunStatus = 0,1,2,3 dont have results and this endpoint will return an error if called for a journal run with that status.
path Parameters
journalrunId required | string <uuid> The unique identifier of the payroll run |
query Parameters
reportJournalNumber required | integer <int32> Example: reportJournalNumber=123 Dagboeknummer. |
reportVoucherNumber required | integer <int32> Example: reportVoucherNumber=456 Boekstuknummer. |
reportDescription | string Example: reportDescription=123 Omschrijving to be shown on the overview. |
reportYear required | integer <int32> Example: reportYear=2018 A valid year to be shown on the report. |
reportPeriodNumber required | integer <int32> Example: reportPeriodNumber=01 A valid period number to be shown on the report. |
reportDate required | string <date> Example: reportDate=2018-01-01 A valid booking date to be shown on the report. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Get journal run overview per employment for a journal run
Activity name : GetRunOverviewPerEmploymentByJournalRunId
Returns the journal run overview in csv for the journal run. Journal runs with journalRunStatus = 0,1,2,3 dont have results and this endpoint will return an error if called for a journal run with that status.
path Parameters
journalrunId required | string <uuid> The unique identifier of the payroll run |
query Parameters
reportJournalNumber required | integer <int32> Example: reportJournalNumber=123 Dagboeknummer. |
reportVoucherNumber required | integer <int32> Example: reportVoucherNumber=456 Boekstuknummer. |
reportDescription | string Example: reportDescription=123 Omschrijving to be shown on the overview. |
reportYear required | integer <int32> Example: reportYear=2018 A valid year to be shown on the report. |
reportPeriodNumber required | integer <int32> Example: reportPeriodNumber=01 A valid period number to be shown on the report. |
reportDate required | string <date> Example: reportDate=2018-01-01 A valid booking date to be shown on the report. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
List of departments
Activity name : GetDepartmentsByEmployerId
Get a list of all departments for the employer. This is the point where the departments available for use at employment level (organizational entity) are managed.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop Binnendienst",
- "subDepartmentOf": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop Algemeen"
}, - "emailLeaveRequest": "[email protected]"
}
]
}
Create a department for an employer
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
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Department to add to the employer.
code | integer <int32> (code) The visible identifier of the department. |
description | string (schemas-description) <= 50 characters The visible description (i.e. name) of the department. |
object or null <metadata> (subDepartmentOf) 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. | |
emailLeaveRequest | string or null (emailLeaveRequest) <= 255 characters 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. |
Responses
Request samples
- Payload
{- "code": 2,
- "description": "Verkoop Binnendienst",
- "subDepartmentOf": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "emailLeaveRequest": "[email protected]"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop Binnendienst",
- "subDepartmentOf": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop Algemeen"
}, - "emailLeaveRequest": "[email protected]"
}
}
Details of a department
Activity name: GetDepartmentByDepartmentId
Get the details of department
path Parameters
departmentId required | string <uuid> The unique identifier of the department |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop Binnendienst",
- "subDepartmentOf": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop Algemeen"
}, - "emailLeaveRequest": "[email protected]"
}
}
Edit the details of a department
Activity name: PutDepartmentByDepartmentId
Edit the details for a department
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the POST URL.
path Parameters
departmentId required | string <uuid> The unique identifier of the department |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Department to edit.
description | string (schemas-description) <= 50 characters The visible description (i.e. name) of the department. |
object or null <metadata> (subDepartmentOf) 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. | |
emailLeaveRequest | string or null (emailLeaveRequest) <= 255 characters 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. |
Responses
Request samples
- Payload
{- "description": "Verkoop Binnendienst",
- "subDepartmentOf": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "emailLeaveRequest": "[email protected]"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop Binnendienst",
- "subDepartmentOf": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop Algemeen"
}, - "emailLeaveRequest": "[email protected]"
}
}
List of user accessible departments
Activity name : GetUserAccessibleDepartmentsByEmployerId
Get a list of all departments for the employer, which are accesible for the current user.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop Binnendienst",
- "subDepartmentOf": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop Algemeen"
}, - "emailLeaveRequest": "[email protected]"
}
]
}
List of functions
Activity name : GetFunctionsByEmployerId
Get a list of all functions for the employer. This is the point where the functions available for use at employment level (organizational entity) are managed.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Directeur",
- "group": "Var"
}
]
}
Create a function for an employer
Activity name: PostFunctionByEmployerId
Create a function for an employer
Metadata: No metadata
Defaults: No default values
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Function to add to the employer.
description | string <= 50 characters |
group | string or null <= 5 characters |
Responses
Request samples
- Payload
{- "description": "Directeur",
- "group": "Var"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Directeur",
- "group": "Var"
}
}
Details of a function
Activity name: GetFunctionByFunctionId
Get the details of function
path Parameters
functionId required | string <uuid> The unique identifier of the function |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Directeur",
- "group": "Var"
}
}
Edit the details of a function
path Parameters
functionId required | string <uuid> The unique identifier of the function |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Function to edit.
description | string <= 50 characters |
group | string or null <= 5 characters |
Responses
Request samples
- Payload
{- "description": "Directeur",
- "group": "Var"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Directeur",
- "group": "Var"
}
}
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).
List of working hours for an employment
Activity name : GetWorkingHoursByEmploymentId
Get the list of working hours for an employment
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "shift": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "deviatingHoursPerWeek": 32,
- "averageHoursPerWeek": 32,
- "deviatingSvDaysPerPeriod": 20,
- "averageParttimeFactor": 37.5,
- "regularWorkPattern": true,
- "shiftRateSickLeave": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "flexibleHoursContract": {
- "key": 2,
- "value": "Minimum uren contract"
}, - "workPattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}, - "calculateUsingWorkPattern": {
- "leaveHours": true,
- "hoursBrokenPeriod": false,
- "hoursRegularPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "contractCode": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 1022,
- "description": "SLA-PT-met toeslagen ATW (88)"
}, - "aggregatedHoursPerWeek": 24
}
]
}
Create the working hours for an employment
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.
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.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Working hours to add to the employment.
startDate | string <date> Start date of the record. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. |
object <metaData> The shift determines the full-time hours and bonus percentage.
| |
deviatingHoursPerWeek | number or null <double> [ 0.01 .. 99.99 ] ^(\d{1,2})(\.\d{1,2})?$ 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. |
averageHoursPerWeek | number or null <double> [ 0 .. 168 ] ^(\d{1,3})(\.\d{1,2})?$ 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. |
deviatingSvDaysPerPeriod | integer or null <int32> [ 1 .. 23 ] Sv (social insurance) days are normally calculated by hours per shift, this optional field is used to register a deviating value. |
averageParttimeFactor | number or null <double> [ 0.0001 .. 999.9999 ] ^(\d{1,3})(\.\d{1,4})?$ This field is used to register the deviating value of the parttimefactor, purely for administrative purposes. The parttimefactor is normally calculated by workinghours dividing by shifthours multplied by 100. Please note that this field is not used in the actual payroll proces! For the payroll process the number of hours is used. |
regularWorkPattern | boolean When the employee works the same amount of hours per day every week, then the workpattern is regular. |
object <metadata> The shift determines the full-time hours and bonus percentage.
| |
object or null <metadata> The field indicates the type of flexible contract. If not applicable, please set to NULL. | |
object or null 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. | |
object Indications in this objects determine whether specific values should be calculated based on the bi-weekly workPattern (specified in the | |
object or null <metadata> This field is specialy made for convenience stores. The field is the type of contract.
|
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "shift": {
- "shiftNumber": 1
}, - "deviatingHoursPerWeek": 32,
- "averageHoursPerWeek": 32,
- "deviatingSvDaysPerPeriod": 20,
- "averageParttimeFactor": 37.5,
- "regularWorkPattern": true,
- "shiftRateSickLeave": {
- "shiftNumber": 1
}, - "flexibleHoursContract": {
- "key": 2
}, - "workPattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}, - "calculateUsingWorkPattern": {
- "leaveHours": true,
- "hoursBrokenPeriod": false,
- "hoursRegularPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "contractCode": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "shift": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "deviatingHoursPerWeek": 32,
- "averageHoursPerWeek": 32,
- "deviatingSvDaysPerPeriod": 20,
- "averageParttimeFactor": 37.5,
- "regularWorkPattern": true,
- "shiftRateSickLeave": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "flexibleHoursContract": {
- "key": 2,
- "value": "Minimum uren contract"
}, - "workPattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}, - "calculateUsingWorkPattern": {
- "leaveHours": true,
- "hoursBrokenPeriod": false,
- "hoursRegularPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "contractCode": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 1022,
- "description": "SLA-PT-met toeslagen ATW (88)"
}, - "aggregatedHoursPerWeek": 24
}
}
Details of the working hours
Activity name : GetWorkingHoursByWorkingHoursId
Get the details of a working hours record
path Parameters
workinghoursId required | string <uuid> The unique identifier of the work detail |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "shift": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "deviatingHoursPerWeek": 32,
- "averageHoursPerWeek": 32,
- "deviatingSvDaysPerPeriod": 20,
- "averageParttimeFactor": 37.5,
- "regularWorkPattern": true,
- "shiftRateSickLeave": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "flexibleHoursContract": {
- "key": 2,
- "value": "Minimum uren contract"
}, - "workPattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}, - "calculateUsingWorkPattern": {
- "leaveHours": true,
- "hoursBrokenPeriod": false,
- "hoursRegularPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "contractCode": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 1022,
- "description": "SLA-PT-met toeslagen ATW (88)"
}, - "aggregatedHoursPerWeek": 24
}
}
Edit the working hours
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.
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
path Parameters
workinghoursId required | string <uuid> The unique identifier of the work detail |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Working hours to edit.
startDate | string <date> Start date of the record. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. |
object <metaData> The shift determines the full-time hours and bonus percentage.
| |
deviatingHoursPerWeek | number or null <double> [ 0.01 .. 99.99 ] ^(\d{1,2})(\.\d{1,2})?$ 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. |
averageHoursPerWeek | number or null <double> [ 0 .. 168 ] ^(\d{1,3})(\.\d{1,2})?$ 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. |
deviatingSvDaysPerPeriod | integer or null <int32> [ 1 .. 23 ] Sv (social insurance) days are normally calculated by hours per shift, this optional field is used to register a deviating value. |
averageParttimeFactor | number or null <double> [ 0.0001 .. 999.9999 ] ^(\d{1,3})(\.\d{1,4})?$ This field is used to register the deviating value of the parttimefactor, purely for administrative purposes. The parttimefactor is normally calculated by workinghours dividing by shifthours multplied by 100. Please note that this field is not used in the actual payroll proces! For the payroll process the number of hours is used. |
regularWorkPattern | boolean When the employee works the same amount of hours per day every week, then the workpattern is regular. |
object <metadata> The shift determines the full-time hours and bonus percentage.
| |
object or null <metadata> The field indicates the type of flexible contract. If not applicable, please set to NULL. | |
object or null 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. | |
object Indications in this objects determine whether specific values should be calculated based on the bi-weekly workPattern (specified in the | |
object or null <metadata> This field is specialy made for convenience stores. The field is the type of contract.
|
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "shift": {
- "shiftNumber": 1
}, - "deviatingHoursPerWeek": 32,
- "averageHoursPerWeek": 32,
- "deviatingSvDaysPerPeriod": 20,
- "averageParttimeFactor": 37.5,
- "regularWorkPattern": true,
- "shiftRateSickLeave": {
- "shiftNumber": 1
}, - "flexibleHoursContract": {
- "key": 2
}, - "workPattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}, - "calculateUsingWorkPattern": {
- "leaveHours": true,
- "hoursBrokenPeriod": false,
- "hoursRegularPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "contractCode": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "shift": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "deviatingHoursPerWeek": 32,
- "averageHoursPerWeek": 32,
- "deviatingSvDaysPerPeriod": 20,
- "averageParttimeFactor": 37.5,
- "regularWorkPattern": true,
- "shiftRateSickLeave": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "flexibleHoursContract": {
- "key": 2,
- "value": "Minimum uren contract"
}, - "workPattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}, - "calculateUsingWorkPattern": {
- "leaveHours": true,
- "hoursBrokenPeriod": false,
- "hoursRegularPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "contractCode": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 1022,
- "description": "SLA-PT-met toeslagen ATW (88)"
}, - "aggregatedHoursPerWeek": 24
}
}
Delete a specific working hours record
Activity name : DeleteWorkingHoursByWorkingHoursId
Delete an existing working hours record (for an employment)
path Parameters
workinghoursId required | string <uuid> The unique identifier of the work detail |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
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).
List of organizational entities for an employment
Activity name: GetOrganizationalEntitiesByEmploymentId
Get the list of organizational entities for an employment
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Directeur",
- "group": "internal"
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "standardFunction": {
- "key": 1,
- "value": "Administrateur",
- "code": "A21",
- "category": 1
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}, - "placeOfEmployment": "Amsterdam office",
- "internalTelephoneExtensionNumber": "678"
}
]
}
Create an organizational entity for an employment
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.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Organizational entity to add to the employment.
startDate | string <date> The start date of the entity. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. |
object <metadata> The function of the employment.
| |
deviatingFunctionGroup | string or null [ 1 .. 5 ] characters The deviating function group description of the employment. Only applies when a deviating function description is defined. |
deviatingFunctionDescription | string or null [ 1 .. 50 ] characters The deviating function description of the employment. This description deviates from the value of the |
object or null <metadata> The standard (cao)function of the employment.
| |
object <metadata> The department of the employment.
| |
object <metadata> Distribution unit, used in several reports and the "basic wage journal" functionality. Commonly used as a cost center.
| |
placeOfEmployment | string or null [ 1 .. 24 ] characters The standard working location (standplaats) for the employment. |
internalTelephoneExtensionNumber | string or null [ 1 .. 15 ] characters The phone number of the standard working location (standplaats) for the employment. |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "standardFunction": {
- "key": 1
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "placeOfEmployment": "Amsterdam office",
- "internalTelephoneExtensionNumber": "678"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Directeur",
- "group": "internal"
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "standardFunction": {
- "key": 1,
- "value": "Administrateur",
- "code": "A21",
- "category": 1
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}, - "placeOfEmployment": "Amsterdam office",
- "internalTelephoneExtensionNumber": "678"
}
}
Details of an organizational entity
Activity name: GetOrganizationalEntityByOrganizationalEntityId
Get the details of organizational entity
path Parameters
organizationalEntityId required | string <uuid> The unique identifier of the organizational entity |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Directeur",
- "group": "internal"
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "standardFunction": {
- "key": 1,
- "value": "Administrateur",
- "code": "A21",
- "category": 1
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}, - "placeOfEmployment": "Amsterdam office",
- "internalTelephoneExtensionNumber": "678"
}
}
Edit the details of an organizational entity
Activity name: PutOrganizationalEntityByOrganizationalEntityId
Edit the details for an organizational entity
Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
path Parameters
organizationalEntityId required | string <uuid> The unique identifier of the organizational entity |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Organizational entity to edit.
startDate | string <date> The start date of the entity. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. |
object <metadata> The function of the employment.
| |
deviatingFunctionGroup | string or null [ 1 .. 5 ] characters The deviating function group description of the employment. Only applies when a deviating function description is defined. |
deviatingFunctionDescription | string or null [ 1 .. 50 ] characters The deviating function description of the employment. This description deviates from the value of the |
object or null <metadata> The standard (cao)function of the employment.
| |
object <metadata> The department of the employment.
| |
object <metadata> Distribution unit, used in several reports and the "basic wage journal" functionality. Commonly used as a cost center.
| |
placeOfEmployment | string or null [ 1 .. 24 ] characters The standard working location (standplaats) for the employment. |
internalTelephoneExtensionNumber | string or null [ 1 .. 15 ] characters The phone number of the standard working location (standplaats) for the employment. |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "standardFunction": {
- "key": 1
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "placeOfEmployment": "Amsterdam office",
- "internalTelephoneExtensionNumber": "678"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Directeur",
- "group": "internal"
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "standardFunction": {
- "key": 1,
- "value": "Administrateur",
- "code": "A21",
- "category": 1
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}, - "placeOfEmployment": "Amsterdam office",
- "internalTelephoneExtensionNumber": "678"
}
}
Delete a specific organizational entity record
Activity name: DeleteOrganizationalEntityByOrganizationalEntityId
Delete a organizational entity for the employment
path Parameters
organizationalEntityId required | string <uuid> The unique identifier of the organizational entity |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Abp funds for an administration
Activity name : GetAbpFundsByPayrollAdministrationIdAndYear
Get the available abp funds for an administration.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
year required | integer <int32> <= 4 characters Example: 2018 The payroll year |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "key": 1,
- "description": "Aanvullende pensioenregeling"
}
]
}
List of abp funds the employment partakes in
Activity name : GetAbpFundsByEmploymentId
Get a list of the abp funds the employment partakes in.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": null,
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "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
}
]
}
Activate an abp fund for an employment
Activity name : PostAbpFundByEmploymentId
Metadata : Possible options for fields of the type "metadata" can be acquired (GET) by adding /metadata
to the POST URL.
Defaults : Default values for a new object can be acquired by adding `/defaults" to the POST URL.
Activate an abp fund for an employment
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add an abp fund for an employment.
startDate | string <date> The date on which this fund starts. A (linked chain)[./#section/Data/Date-chains] per fund is maintained within this resource. So multiple funds can be active at the same time but one specific fund can never be active multiple times at the same time. |
endDate | string or null <date> The end date of the entity. The date is up to and including. |
object <metadata> | |
object or null Only set a value for the underlying fields if you want to deviate from the values as defined by the selected Deviating is done on either all the fields or none. Note: | |
object or null 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 Setting a fixed contribution is done on either all the fields or none. Note: |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "fund": {
- "key": 1
}, - "deviations": null,
- "fixedContribution": null
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": null,
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "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
}
}
Details of an abp fund
Activity name : GetAbpFundByAbpFundId
Get the details of an abp fund
path Parameters
abpFundId required | string <uuid> The unique identifier of the abp fund |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": null,
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "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
}
}
Edit a abp fund record
Activity name : PutAbpFundByAbpFundId
Metadata : Possible options for fields of the type "metadata" can be acquired (GET) by adding /metadata
to the PUT URL.
path Parameters
abpFundId required | string <uuid> The unique identifier of the abp fund |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
startDate | string <date> The date on which this fund starts. A (linked chain)[./#section/Data/Date-chains] per fund is maintained within this resource. So multiple funds can be active at the same time but one specific fund can never be active multiple times at the same time. |
endDate | string or null <date> The end date of the entity. The date is up to and including. |
object or null Only set a value for the underlying fields if you want to deviate from the values as defined by the selected Deviating is done on either all the fields or none. Note: | |
object or null 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 Setting a fixed contribution is done on either all the fields or none. Note: |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "deviations": null,
- "fixedContribution": null
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": null,
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "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
}
}
Delete a specific abp fund record
Activity name : DeleteAbpFundByAbpFundId
Delete an existing abp fund record.
path Parameters
abpFundId required | string <uuid> The unique identifier of the abp fund |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Employment funds for an administration
Activity name : GetEmploymentFundsByPayrollAdministrationIdAndYear
Get the available employment funds for an administration.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
year required | integer <int32> <= 4 characters Example: 2018 The payroll year |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "key": 1,
- "description": "Aanvullende pensioenregeling"
}
]
}
List of funds the employment partakes in
Activity name : GetEmploymentFundsByEmploymentId
Get a list of the funds the employment partakes in.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": null,
- "resourceVersion": "2023-05-26"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "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"
}
}
]
}
Activate a fund for an employment
Activity name : PostEmploymentFundByEmploymentId
Metadata : Possible options for fields of the type "metadata" can be acquired (GET) by adding /metadata
to the POST URL.
Defaults : Default values for a new object can be acquired by adding `/defaults" to the POST URL.
Activate a fund for an employment
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: required
Add a fund for an employment.
startDate | string <date> (Fund_components-schemas-startDate) The date on which this fund starts. A (linked chain)[./#section/Data/Date-chains] per fund is maintained within this resource. So multiple funds can be active at the same time but one specific fund can never be active multiple times at the same time. |
endDate | string or null <date> (Fund_components-schemas-endDate) The end date of the entity. The date is up to and including. |
object <metadata> (fund) | |
object or null (deviations) Only set a value for the underlying fields if you want to deviate from the values as defined by the selected Deviating is done on either all the fields or none. Note: | |
object or null (fixedContribution) 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 Setting a fixed contribution is done on either all the fields or none. Note: | |
object or null <metadata> (vitalityScheme) |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "fund": {
- "key": 1
}, - "deviations": null,
- "fixedContribution": null,
- "vitalityScheme": {
- "key": 1
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": null,
- "resourceVersion": "2023-05-26"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "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
}
}
Details of an employment fund
Activity name : GetEmploymentFundByEmploymentFundId
Get the details of an employment fund
path Parameters
employmentFundId required | string <uuid> The unique identifier of the employment fund |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": null,
- "resourceVersion": "2023-05-26"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "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
}
}
Edit a employment fund record
Activity name : PutEmploymentFundByEmploymentFundId
Metadata : Possible options for fields of the type "metadata" can be acquired (GET) by adding /metadata
to the PUT URL.
path Parameters
employmentFundId required | string <uuid> The unique identifier of the employment fund |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: required
startDate | string <date> (Fund_components-schemas-startDate) The date on which this fund starts. A (linked chain)[./#section/Data/Date-chains] per fund is maintained within this resource. So multiple funds can be active at the same time but one specific fund can never be active multiple times at the same time. |
endDate | string or null <date> (Fund_components-schemas-endDate) The end date of the entity. The date is up to and including. |
object or null (deviations) Only set a value for the underlying fields if you want to deviate from the values as defined by the selected Deviating is done on either all the fields or none. Note: | |
object or null (fixedContribution) 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 Setting a fixed contribution is done on either all the fields or none. Note: | |
object or null <metadata> (vitalityScheme) |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "deviations": null,
- "fixedContribution": null,
- "vitalityScheme": {
- "key": 1
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": null,
- "resourceVersion": "2023-05-26"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "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
}
}
Delete a specific employment fund record
Activity name : DeleteEmploymentFundByEmploymentFundId
Delete an existing employment fund record.
path Parameters
employmentFundId required | string <uuid> The unique identifier of the employment fund |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Create employment funds for multiple employments
Activity name : PostCollectiveEmploymentFundsByEmployerId
Create new employment fund records for multiple employments of an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Employmentfunds to add.
employmentId | string <uuid> ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9... The unique identifier of an object (GUID/UUID) |
startDate | string <date> The date on which this fund starts. A (linked chain)[./#section/Data/Date-chains] per fund is maintained within this resource. So multiple funds can be active at the same time but one specific fund can never be active multiple times at the same time. |
endDate | string or null <date> The end date of the entity. The date is up to and including. |
object <metadata> | |
object or null Only set a value for the underlying fields if you want to deviate from the values as defined by the selected Deviating is done on either all the fields or none. Note: | |
object or null 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 Setting a fixed contribution is done on either all the fields or none. Note: |
Responses
Request samples
- Payload
[- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "fund": {
- "key": 1
}, - "deviations": {
- "employmentContributionPercentage": 11,
- "totalContributionPercentage": 12.0007
}, - "fixedContribution": {
- "employmentContribution": 1789,
- "totalContribution": 2569
}
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
Set employment funds enddate for multiple employments
Activity name : PatchCollectiveEmploymentFundsByEmployerId
Set the employment fund enddate for multiple employments of an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Employmentfunds to change.
employmentId | string <uuid> ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9... The unique identifier of an object (GUID/UUID) |
endDate | string <date> The end date of the entity. The date is up to and including. |
employmentFundId | string <uuid> ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9... The unique identifier of an object (GUID/UUID) |
Responses
Request samples
- Payload
[- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "endDate": "2018-10-23",
- "employmentFundId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
Create abp funds for multiple employments
Activity name : PostCollectiveAbpFundsByEmployerId
Create new abp fund records for multiple employments of an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Abp funds to add.
employmentId | string <uuid> ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9... The unique identifier of an object (GUID/UUID) |
startDate | string <date> The date on which this fund starts. A (linked chain)[./#section/Data/Date-chains] per fund is maintained within this resource. So multiple funds can be active at the same time but one specific fund can never be active multiple times at the same time. |
endDate | string or null <date> The end date of the entity. The date is up to and including. |
object <metadata> | |
object or null Only set a value for the underlying fields if you want to deviate from the values as defined by the selected Deviating is done on either all the fields or none. Note: | |
object or null 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 Setting a fixed contribution is done on either all the fields or none. Note: |
Responses
Request samples
- Payload
[- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "fund": {
- "key": 1
}, - "deviations": {
- "employmentContributionPercentage": 11,
- "totalContributionPercentage": 12.0007
}, - "fixedContribution": {
- "employmentContribution": 1789,
- "totalContribution": 2569
}
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
Set abp funds enddate for multiple employments
Activity name : PatchCollectiveAbpFundsByEmployerId
Set the abp fund enddate for multiple employments of an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Abp funds to change.
employmentId | string <uuid> ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9... The unique identifier of an object (GUID/UUID) |
endDate | string <date> The end date of the entity. The date is up to and including. |
abpFundId | string <uuid> ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9... The unique identifier of an object (GUID/UUID) |
Responses
Request samples
- Payload
[- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "endDate": "2018-10-23",
- "abpFundId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
Import concept employees via a file
Activity name : PatchImportConceptEmployeesByPayrollAdministrationId
Metadata: No metadata
Currently supported file is the payroll tax return XML (year 2022 or later).
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: multipart/form-datarequired
xml file to be uploaded.
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "successfull": [
- {
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "index": 2,
- "formattedName": "Jong, I",
- "employeeNumber": 156
}
], - "failed": [
- {
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "index": 2,
- "formattedName": "Jong, I",
- "employeeNumber": 156
}
]
}
}
Import employee via a csv file
Activity name : PostEmployeeImportDataByPayrollAdministrationId
Imports a csv file containing employee records.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
year required | integer Example: year=2023 The year of the period the data will be imported in. |
period required | integer Example: period=12 The period the data will be imported in. |
payslipType required | integer Example: payslipType=1 The paysliptype to import the data in. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
csv file to be uploaded.
mimeType | string Value: "text/csv" The type of file to import. Currently only csv is supported |
data | string base64 encoded file. |
Responses
Request samples
- Payload
{- "mimeType": "text/csv",
- "data": "YQ=="
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
List of journal configurations
Activity name: GetJournalConfigurationsByPayrollAdministrationId
Get the list of journal configurations for a specific payroll administration.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "journalProfile": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "key": 2,
- "description": "General ledger supermarkets"
}, - "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "automaticallyInitiateJournalRun": false
}
]
}
Create a new journal configuration
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.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
journal configuration
object <metadata> | |
object <metadata> (startPeriod) | |
object or null <metadata> (endPeriod) | |
automaticallyInitiateJournalRun | boolean Indicates whether a journal run is automaticly started when a payroll run is approved |
Responses
Request samples
- Payload
{- "journalProfile": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "startPeriod": {
- "year": 2017,
- "periodNumber": 1
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1
}, - "automaticallyInitiateJournalRun": false
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "journalProfile": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "key": 2,
- "description": "General ledger supermarkets"
}, - "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "automaticallyInitiateJournalRun": false
}
}
Details of a journal configuration
Activity name: GetJournalConfigurationByJournalConfigurationId
Get the details of a journal configuration
path Parameters
journalConfigurationId required | string <uuid> The unique identifier of a journal configuration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "journalProfile": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "key": 2,
- "description": "General ledger supermarkets"
}, - "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "automaticallyInitiateJournalRun": false
}
}
Edit the details of a journal configuration
Activity name: PutJournalConfigurationByJournalConfigurationId
Edit the details of a journal configuration record
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the POST URL.
path Parameters
journalConfigurationId required | string <uuid> The unique identifier of a journal configuration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
journal configuration
object <metadata> | |
object <metadata> (startPeriod) | |
object or null <metadata> (endPeriod) | |
automaticallyInitiateJournalRun | boolean Indicates whether a journal run is automaticly started when a payroll run is approved |
Responses
Request samples
- Payload
{- "journalProfile": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "startPeriod": {
- "year": 2017,
- "periodNumber": 1
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1
}, - "automaticallyInitiateJournalRun": false
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "journalProfile": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "key": 2,
- "description": "General ledger supermarkets"
}, - "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "automaticallyInitiateJournalRun": false
}
}
Delete a journal configuration
Activity name: DeleteJournalConfigurationByJournalConfigurationId
Delete a journal configuration
path Parameters
journalConfigurationId required | string <uuid> The unique identifier of a journal configuration |
header Parameters
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List journal profiles for the given provider
Activity name : GetJournalProfilesAtProviderLevelByProviderId
Get a list of all journal profiles for the given provider
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "General ledger supermarkets",
- "numberOfActiveAdministrations": 12,
- "numberOfHistoricAdministrations": 42
}
]
}
Create a journal profile for the provider.
Activity name : PostJournalProfileAtProviderLevelByProviderId
Metadata : No metadata. For the list of journalprofiles that can be copied, see the GET endpoint /journalProfiles
Defaults : No defaults
Add a new journal profile for the provider.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a journal profile for a provider.
description | string [ 1 .. 50 ] characters The description of the journal profile. |
journalProfileIdToCopy | string or null <uuid> The unique identifier of the journal profile that should be copied. |
Responses
Request samples
- Payload
{- "description": "General ledger supermarkets",
- "journalProfileIdToCopy": "00000000-0000-0000-0000-000000000001"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "General ledger supermarkets",
- "numberOfActiveAdministrations": 12,
- "numberOfHistoricAdministrations": 42
}
}
Details of a journal profile
Activity name : GetJournalProfileAtProviderLevelByJournalProfileId
Get the details of a journal profile
path Parameters
journalProfileId required | string <uuid> The unique identifier of a cost center |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "General ledger supermarkets",
- "numberOfActiveAdministrations": 12,
- "numberOfHistoricAdministrations": 42
}
}
Edit the details of a journal profile
Activity name : PutJournalProfileAtProviderLevelByJournalProfileId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
Edit the details of a journal profile
path Parameters
journalProfileId required | string <uuid> The unique identifier of a cost center |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Journal profile to edit.
description | string [ 1 .. 50 ] characters The description of the journal profile. |
Responses
Request samples
- Payload
{- "description": "General ledger supermarkets"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "General ledger supermarkets",
- "numberOfActiveAdministrations": 12,
- "numberOfHistoricAdministrations": 42
}
}
Delete a journal profile
Activity name : DeleteJournalProfileAtProviderLevelByJournalProfileId
Delete a journal profile
path Parameters
journalProfileId required | string <uuid> The unique identifier of a cost center |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of ledger accounts for a journal profile of a specific provider.
Activity name: GetLedgerAccountsAtProviderLevelByJournalProfileId
Get the list of ledger accounts for a journal profile of a specific provider.
path Parameters
journalProfileId required | string <uuid> The unique identifier of a journal profile |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "number": "SAL-4000",
- "description": "Salaris",
- "costAccount": true,
- "consolidate": true
}
]
}
Create a new ledger account for a journal profile of a specific provider.
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.
path Parameters
journalProfileId required | string <uuid> The unique identifier of a journal profile |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
LedgerAccount
number | string (number) [ 1 .. 20 ] characters The "number" for a ledger account (is a string) |
description | string (LedgerAccounts_components-schemas-description) [ 1 .. 50 ] characters The description for a ledger account |
costAccount | boolean (costAccount) If set to true it is possible to devide costs for this account between cost centers and units. If set to false it is not possible to devide costs for this account between cost centers and units. |
consolidate | boolean (consolidate) If set to true and multiple payrollcomponents are linked to this account only the sum of all values is booked. If 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. |
Responses
Request samples
- Payload
{- "number": "SAL-4000",
- "description": "Salaris",
- "costAccount": true,
- "consolidate": true
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "number": "SAL-4000",
- "description": "Salaris",
- "costAccount": true,
- "consolidate": true
}
}
Details of a ledger account at provider level
Activity name: GetLedgerAccountAtProviderLevelByLedgerAccountId
Get the details of a ledger account at provider level
path Parameters
ledgerAccountId required | string <uuid> The unique identifier of a ledger account |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "number": "SAL-4000",
- "description": "Salaris",
- "costAccount": true,
- "consolidate": true
}
}
Edit the details of a journal allocation record at the provider level
Activity name: PatchLedgerAccountAtProviderLevelByLedgerAccountId
Edit the details of a ledger account record (grootboekrekening)
- No metadata required
path Parameters
ledgerAccountId required | string <uuid> The unique identifier of a ledger account |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Ledger accounts
number | string (number) [ 1 .. 20 ] characters The "number" for a ledger account (is a string) |
description | string (LedgerAccounts_components-schemas-description) [ 1 .. 50 ] characters The description for a ledger account |
costAccount | boolean (costAccount) If set to true it is possible to devide costs for this account between cost centers and units. If set to false it is not possible to devide costs for this account between cost centers and units. |
consolidate | boolean (consolidate) If set to true and multiple payrollcomponents are linked to this account only the sum of all values is booked. If 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. |
Responses
Request samples
- Payload
{- "number": "SAL-4000",
- "description": "Salaris",
- "costAccount": true,
- "consolidate": true
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "number": "SAL-4000",
- "description": "Salaris",
- "costAccount": true,
- "consolidate": true
}
}
Delete a ledger account on the provider level
Activity name: DeleteLedgerAccountAtProviderLevelByLedgerAccountId
Delete a ledger account on the provider level
path Parameters
ledgerAccountId required | string <uuid> The unique identifier of a ledger account |
header Parameters
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of ledger account to payroll component links at provider level
Activity name: GetLedgerAccountToPayrollComponentLinksAtProviderLevelByJournalProfileId
Get the list of ledger account to payroll component links (verdelingschema) for a journal profile at provider level.
path Parameters
journalProfileId required | string <uuid> The unique identifier of a journal profile |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "ledgerAccount": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "number": "Salaris",
- "description": "Salaris",
- "costAccount": true,
- "consolidate": true
}, - "payrollComponent": {
- "key": 70,
- "description": "Wage",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "balanceSheetSide": {
- "key": 1,
- "value": "Credit"
}
}, - "costCenter": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales"
}, - "costUnit": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "005",
- "description": "Tilburg"
}
}
]
}
Create a new ledger account to payroll component link for a journal profile at provider level
Activity name: PostLedgerAccountToPayrollComponentLinkAtProviderLevelByJournalProfileId
Create a new ledger account to payroll component link for a journal profile at provider level.
path Parameters
journalProfileId required | string <uuid> The unique identifier of a journal profile |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
LedgerAccountToPayrollComponentLink
object <metadata> (ledgerAccount) | |
object <metadata> (components-schemas-payrollComponent) A payroll component is the link to the salary calculation.
| |
object <metadata> (costCenter) | |
object <metadata> (costUnit) |
Responses
Request samples
- Payload
{- "ledgerAccount": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "payrollComponent": {
- "key": 70
}, - "costCenter": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "costUnit": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "ledgerAccount": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "number": "Salaris",
- "description": "Salaris",
- "costAccount": true,
- "consolidate": true
}, - "payrollComponent": {
- "key": 70,
- "description": "Wage",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "balanceSheetSide": {
- "key": 1,
- "value": "Credit"
}
}, - "costCenter": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales"
}, - "costUnit": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "005",
- "description": "Tilburg"
}
}
}
Details of a ledger account to payroll component link at provider level
Activity name: GetLedgerAccountToPayrollComponentLinkAtProviderLevelByLedgerAccountToPayrollComponentLinkId
Get the details of a ledger account to payroll component link at provider level.
path Parameters
ledgerAccountToPayrollComponentLinkId required | string <uuid> The unique identifier of a ledger account to payroll component link |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "ledgerAccount": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "number": "Salaris",
- "description": "Salaris",
- "costAccount": true,
- "consolidate": true
}, - "payrollComponent": {
- "key": 70,
- "description": "Wage",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "balanceSheetSide": {
- "key": 1,
- "value": "Credit"
}
}, - "costCenter": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales"
}, - "costUnit": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "005",
- "description": "Tilburg"
}
}
}
Edit the details of a ledger account to payroll component link record at provider level
Activity name: PatchLedgerAccountToPayrollComponentLinkAtProviderLevelByLedgerAccountToPayrollComponentLinkId
Edit the details of a ledger account to payroll component link record at provider level.
path Parameters
ledgerAccountToPayrollComponentLinkId required | string <uuid> The unique identifier of a ledger account to payroll component link |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Ledger account to payroll component link
object <metadata> (ledgerAccount) | |
object <metadata> (costCenter) | |
object <metadata> (costUnit) |
Responses
Request samples
- Payload
{- "ledgerAccount": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "costCenter": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "costUnit": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "ledgerAccount": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "number": "Salaris",
- "description": "Salaris",
- "costAccount": true,
- "consolidate": true
}, - "payrollComponent": {
- "key": 70,
- "description": "Wage",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "balanceSheetSide": {
- "key": 1,
- "value": "Credit"
}
}, - "costCenter": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales"
}, - "costUnit": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "005",
- "description": "Tilburg"
}
}
}
Delete a ledger account to payroll component link at provider level
Activity name: DeleteLedgerAccountToPayrollComponentLinkAtProviderLevelByLedgerAccountToPayrollComponentLinkId
Delete a ledger account to payroll component link at provider level.
path Parameters
ledgerAccountToPayrollComponentLinkId required | string <uuid> The unique identifier of a ledger account to payroll component link |
header Parameters
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of cost centers at provider level
Activity name: GetCostCentersAtProviderLevelByJournalProfileId
Get the list of cost centers for a journal profile at provider level.
path Parameters
journalProfileId required | string <uuid> The unique identifier of a journal profile |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales",
- "automaticallyLinkToAllCostUnits": false
}
]
}
Create a new cost center for a journal profile at provider level
Activity name: PostCostCenterAtProviderLevelByJournalProfileId
Create a new cost center for a journal profile at provider level.
path Parameters
journalProfileId required | string <uuid> The unique identifier of a journal profile |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
CostCenter
code | string [ 1 .. 20 ] characters The code for a cost center |
description | string [ 1 .. 50 ] characters The description for a cost center |
Responses
Request samples
- Payload
{- "code": "SAL073",
- "description": "Sales"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales",
- "automaticallyLinkToAllCostUnits": false
}
}
Details of a cost center at provider level
Activity name: GetCostCenterAtProviderLevelByCostCenterId
Get the details of a cost center at provider level.
path Parameters
costCenterId required | string <uuid> The unique identifier of a cost center |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales",
- "automaticallyLinkToAllCostUnits": false
}
}
Edit the details of a cost center at provider level
Activity name: PatchCostCenterAtProviderLevelByCostCenterId
Edit the details of a cost center at provider level.
path Parameters
costCenterId required | string <uuid> The unique identifier of a cost center |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
CostCenter
code | string [ 1 .. 20 ] characters The code for a cost center |
description | string [ 1 .. 50 ] characters The description for a cost center |
Responses
Request samples
- Payload
{- "code": "SAL073",
- "description": "Sales"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales",
- "automaticallyLinkToAllCostUnits": false
}
}
Delete a cost center at provider level
Activity name: DeleteCostCenterAtProviderLevelByCostCenterId
Delete a cost center at provider level.
path Parameters
costCenterId required | string <uuid> The unique identifier of a cost center |
header Parameters
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of cost units at provider level
Activity name: GetCostUnitsAtProviderLevelByJournalProfileId
Get the list of cost units for a journal profile at provider level.
path Parameters
journalProfileId required | string <uuid> The unique identifier of a journal profile |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales",
- "automaticallyLinkToAllCostCenters": false
}
]
}
Create a new cost unit for a journal profile at provider level
Activity name: PostCostUnitAtProviderLevelByJournalProfileId
Create a new cost unit for a journal profile at provider level.
path Parameters
journalProfileId required | string <uuid> The unique identifier of a journal profile |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
CostUnit
code | string [ 1 .. 20 ] characters The code for a cost unit |
description | string [ 1 .. 50 ] characters The description for a cost unit |
Responses
Request samples
- Payload
{- "code": "SAL073",
- "description": "Sales"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales",
- "automaticallyLinkToAllCostCenters": false
}
}
Details of a cost unit at provider level
Activity name: GetCostUnitAtProviderLevelByCostUnitId
Get the details of a cost unit at provider level.
path Parameters
costUnitId required | string <uuid> The unique identifier of a cost unit |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales",
- "automaticallyLinkToAllCostCenters": false
}
}
Edit the details of a cost unit at provider level
Activity name: PatchCostUnitAtProviderLevelByCostUnitId
Edit the details of a cost unit at provider level.
path Parameters
costUnitId required | string <uuid> The unique identifier of a cost unit |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
CostUnit
code | string [ 1 .. 20 ] characters The code for a cost unit |
description | string [ 1 .. 50 ] characters The description for a cost unit |
Responses
Request samples
- Payload
{- "code": "SAL073",
- "description": "Sales"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales",
- "automaticallyLinkToAllCostCenters": false
}
}
Delete a cost unit at provider level
Activity name: DeleteCostUnitAtProviderLevelByCostUnitId
Delete a cost unit at provider level.
path Parameters
costUnitId required | string <uuid> The unique identifier of a cost unit |
header Parameters
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Cost centers and cost unit matrix
Activity name: GetCostCenterCostUnitMatrixAtProviderLevelByJournalProfileId
Get the matrix of cost centers and cost unit connections for a journal profile for a specific payroll administration.
path Parameters
journalProfileId required | string <uuid> The unique identifier of a journal profile |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "costCenter": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales"
}, - "costUnit": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "005",
- "description": "Tilburg"
}, - "linked": true,
- "locked": true
}
]
}
Edit the links between cost centers and cost units
Activity name: PatchCostCenterCostUnitMatrixAtProviderLevelByJournalProfileId
Edit the links between cost centers and cost units (koppeling kostenplaats en kostendrager)
path Parameters
journalProfileId required | string <uuid> The unique identifier of a journal profile |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object | |
object | |
linked | boolean If true the given combination of cost center and cost unit are linked. Linked means that the combination can be selected in the "Ledger account to payroll component mapping" and "journal allocation" on employment level. |
Responses
Request samples
- Payload
[- {
- "costCenter": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "costUnit": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "linked": true
}
]
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "costCenter": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales"
}, - "costUnit": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "005",
- "description": "Tilburg"
}, - "linked": true,
- "locked": true
}
}
List of journal profiles
Activity name: GetJournalProfilesByPayrollAdministrationId
Get the list of journal profiles for a payroll administration.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "key": 2,
- "description": "General ledger supermarkets",
- "origin": {
- "key": 1,
- "description": 1
}
}
]
}
Create a new journal profile
Activity name: PostJournalProfileByPayrollAdministrationId
Create a new journal profile.
Metadata : No metadata
Defaults : There is NO /defaults endpoint available for this resource.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
journalProfileId required | string <uuid> The unique identifier of a journal profile |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
CostCenter
description | string [ 1 .. 50 ] characters |
object 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. |
Responses
Request samples
- Payload
{- "description": "General ledger supermarkets",
- "origin": { }
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "key": 2,
- "description": "General ledger supermarkets",
- "origin": {
- "key": 1,
- "description": 1
}
}
}
List of ledger accounts
Activity name: GetLedgerAccountsAtPayrollAdministrationLevelByJournalProfileId
Get the list of ledger accounts for a journal profile for a specific payroll administration.
path Parameters
journalProfileId required | string <uuid> The unique identifier of a journal profile |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "number": "SAL-4000",
- "description": "Salaris",
- "costAccount": true,
- "consolidate": true,
- "origin": {
- "number": 1,
- "description": 1,
- "costAccount": 1,
- "consolidate": 1
}
}
]
}
Create a new ledger account for a journal profile
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.
path Parameters
journalProfileId required | string <uuid> The unique identifier of a journal profile |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
LedgerAccount
number | string (number) [ 1 .. 20 ] characters The "number" for a ledger account (is a string) |
description | string (LedgerAccounts_components-schemas-description) [ 1 .. 50 ] characters The description for a ledger account |
costAccount | boolean (costAccount) If set to true it is possible to devide costs for this account between cost centers and units. If set to false it is not possible to devide costs for this account between cost centers and units. |
consolidate | boolean (consolidate) If set to true and multiple payrollcomponents are linked to this account only the sum of all values is booked. If 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. |
Responses
Request samples
- Payload
{- "number": "SAL-4000",
- "description": "Salaris",
- "costAccount": true,
- "consolidate": true
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "number": "SAL-4000",
- "description": "Salaris",
- "costAccount": true,
- "consolidate": true,
- "origin": {
- "number": 1,
- "description": 1,
- "costAccount": 1,
- "consolidate": 1
}
}
}
Details of a ledger account
Activity name: GetLedgerAccountAtPayrollAdministrationLevelByLedgerAccountId
Get the details of a ledger account
path Parameters
ledgerAccountId required | string <uuid> The unique identifier of a ledger account |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "number": "SAL-4000",
- "description": "Salaris",
- "costAccount": true,
- "consolidate": true,
- "origin": {
- "number": 1,
- "description": 1,
- "costAccount": 1,
- "consolidate": 1
}
}
}
Edit the details of a journal allocation record
Activity name: PatchLedgerAccountAtPayrollAdministrationLevelByLedgerAccountId
Edit the details of a ledger account record (grootboekrekening)
- No metadata required
path Parameters
ledgerAccountId required | string <uuid> The unique identifier of a ledger account |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Ledger accounts
number | string (number) [ 1 .. 20 ] characters The "number" for a ledger account (is a string) |
description | string (LedgerAccounts_components-schemas-description) [ 1 .. 50 ] characters The description for a ledger account |
costAccount | boolean (costAccount) If set to true it is possible to devide costs for this account between cost centers and units. If set to false it is not possible to devide costs for this account between cost centers and units. |
consolidate | boolean (consolidate) If set to true and multiple payrollcomponents are linked to this account only the sum of all values is booked. If 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. |
Responses
Request samples
- Payload
{- "number": "SAL-4000",
- "description": "Salaris",
- "costAccount": true,
- "consolidate": true
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "number": "SAL-4000",
- "description": "Salaris",
- "costAccount": true,
- "consolidate": true,
- "origin": {
- "number": 1,
- "description": 1,
- "costAccount": 1,
- "consolidate": 1
}
}
}
Delete a ledger account
Activity name: DeleteLedgerAccountAtPayrollAdministrationLevelByLedgerAccountId
Delete a ledger account
path Parameters
ledgerAccountId required | string <uuid> The unique identifier of a ledger account |
header Parameters
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of ledger account to payroll component links
Activity name: GetLedgerAccountToPayrollComponentLinksAtPayrollAdministrationLevelByJournalProfileId
Get the list of ledger account to payroll component links (verdelingschema) for a journal profile for a specific payroll administration.
path Parameters
journalProfileId required | string <uuid> The unique identifier of a journal profile |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "ledgerAccount": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "number": "Salaris",
- "description": "Salaris",
- "costAccount": true,
- "consolidate": true
}, - "payrollComponent": {
- "key": 70,
- "description": "Wage",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "balanceSheetSide": {
- "key": 1,
- "value": "Credit"
}
}, - "costCenter": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales"
}, - "costUnit": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "005",
- "description": "Tilburg"
}, - "origin": {
- "ledgerAccount": 1,
- "payrollComponent": 1,
- "costCenter": 1,
- "costUnit": 1
}
}
]
}
Create a new ledger account to payroll component link for a journal profile
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.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
journalProfileId required | string <uuid> The unique identifier of a journal profile |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
LedgerAccountToPayrollComponentLink
object <metadata> (ledgerAccount) | |
object <metadata> (components-schemas-payrollComponent) A payroll component is the link to the salary calculation.
| |
object <metadata> (costCenter) | |
object <metadata> (costUnit) |
Responses
Request samples
- Payload
{- "ledgerAccount": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "payrollComponent": {
- "key": 70
}, - "costCenter": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "costUnit": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "ledgerAccount": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "number": "Salaris",
- "description": "Salaris",
- "costAccount": true,
- "consolidate": true
}, - "payrollComponent": {
- "key": 70,
- "description": "Wage",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "balanceSheetSide": {
- "key": 1,
- "value": "Credit"
}
}, - "costCenter": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales"
}, - "costUnit": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "005",
- "description": "Tilburg"
}, - "origin": 1
}
}
Metadata for ledger account to payroll component links
Activity name: GetLedgerAccountToPayrollComponentLinkMetadataByJournalProfileId
Get the metadata of ledger account to payroll component links (verdelingschema) for a journal profile for a specific payroll administration.
path Parameters
journalProfileId required | string <uuid> The unique identifier of a journal profile |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "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"
}
}
]
}
]
}
Details of a ledger account to payroll component link
Activity name: GetLedgerAccountToPayrollComponentLinkAtPayrollAdministrationLevelByLedgerAccountToPayrollComponentLinkId
Get the details of a ledger account to payroll component link
path Parameters
ledgerAccountToPayrollComponentLinkId required | string <uuid> The unique identifier of a ledger account to payroll component link |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "ledgerAccount": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "number": "Salaris",
- "description": "Salaris",
- "costAccount": true,
- "consolidate": true
}, - "payrollComponent": {
- "key": 70,
- "description": "Wage",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "balanceSheetSide": {
- "key": 1,
- "value": "Credit"
}
}, - "costCenter": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales"
}, - "costUnit": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "005",
- "description": "Tilburg"
}, - "origin": {
- "ledgerAccount": 1,
- "payrollComponent": 1,
- "costCenter": 1,
- "costUnit": 1
}
}
}
Edit the details of a ledger account to payroll component link record
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
path Parameters
ledgerAccountToPayrollComponentLinkId required | string <uuid> The unique identifier of a ledger account to payroll component link |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Ledger account to payroll component link
object <metadata> (ledgerAccount) | |
object <metadata> (costCenter) | |
object <metadata> (costUnit) |
Responses
Request samples
- Payload
{- "ledgerAccount": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "costCenter": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "costUnit": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "ledgerAccount": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "number": "Salaris",
- "description": "Salaris",
- "costAccount": true,
- "consolidate": true
}, - "payrollComponent": {
- "key": 70,
- "description": "Wage",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "balanceSheetSide": {
- "key": 1,
- "value": "Credit"
}
}, - "costCenter": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales"
}, - "costUnit": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "005",
- "description": "Tilburg"
}, - "origin": {
- "ledgerAccount": 1,
- "payrollComponent": 1,
- "costCenter": 1,
- "costUnit": 1
}
}
}
Delete a ledger account to payroll component link
Activity name: DeleteLedgerAccountToPayrollComponentLinkAtPayrollAdministrationLevelByLedgerAccountToPayrollComponentLinkId
Delete a ledger account to payroll component link
path Parameters
ledgerAccountToPayrollComponentLinkId required | string <uuid> The unique identifier of a ledger account to payroll component link |
header Parameters
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of cost centers
Activity name: GetCostCentersAtPayrollAdministrationLevelByJournalProfileId
Get the list of cost centers for a journal profile for a specific payroll administration.
path Parameters
journalProfileId required | string <uuid> The unique identifier of a journal profile |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales",
- "automaticallyLinkToAllCostUnits": false,
- "origin": {
- "code": 1,
- "description": 1,
- "automaticallyLinkToAllCostUnits": 1
}
}
]
}
Create a new cost center for a journal profile
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.
path Parameters
journalProfileId required | string <uuid> The unique identifier of a journal profile |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
CostCenter
code | string [ 1 .. 20 ] characters The code for a cost center |
description | string [ 1 .. 50 ] characters The description for a cost center |
Responses
Request samples
- Payload
{- "code": "SAL073",
- "description": "Sales"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales",
- "automaticallyLinkToAllCostUnits": false,
- "origin": {
- "code": 1,
- "description": 1,
- "automaticallyLinkToAllCostUnits": 1
}
}
}
Details of a cost center
Activity name: GetCostCenterAtPayrollAdministrationLevelByCostCenterId
Get the details of a cost center
path Parameters
costCenterId required | string <uuid> The unique identifier of a cost center |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales",
- "automaticallyLinkToAllCostUnits": false,
- "origin": {
- "code": 1,
- "description": 1,
- "automaticallyLinkToAllCostUnits": 1
}
}
}
Edit the details of a cost center
Activity name: PatchCostCenterAtPayrollAdministrationLevelByCostCenterId
Edit the details of a cost center record (kosten plaats)
- No metadata required
path Parameters
costCenterId required | string <uuid> The unique identifier of a cost center |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Cost center
code | string [ 1 .. 20 ] characters The code for a cost center |
description | string [ 1 .. 50 ] characters The description for a cost center |
Responses
Request samples
- Payload
{- "code": "SAL073",
- "description": "Sales"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales",
- "automaticallyLinkToAllCostUnits": false,
- "origin": {
- "code": 1,
- "description": 1,
- "automaticallyLinkToAllCostUnits": 1
}
}
}
Delete a cost center
Activity name: DeleteCostCenterAtPayrollAdministrationLevelByCostCenterId
Delete a cost center
path Parameters
costCenterId required | string <uuid> The unique identifier of a cost center |
header Parameters
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of cost units
Activity name: GetCostUnitsByJournalProfileId
Get the list of cost units for a journal profile for a specific payroll administration.
path Parameters
journalProfileId required | string <uuid> The unique identifier of a journal profile |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales",
- "automaticallyLinkToAllCostCenters": false,
- "origin": {
- "code": 1,
- "description": 1,
- "automaticallyLinkToAllCostCenters": 1
}
}
]
}
Create a new cost unit for a journal profile
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.
path Parameters
journalProfileId required | string <uuid> The unique identifier of a journal profile |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
CostUnit
code | string [ 1 .. 20 ] characters The code for a cost unit |
description | string [ 1 .. 50 ] characters The description for a cost unit |
Responses
Request samples
- Payload
{- "code": "SAL073",
- "description": "Sales"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales",
- "automaticallyLinkToAllCostCenters": false,
- "origin": {
- "code": 1,
- "description": 1,
- "automaticallyLinkToAllCostCenters": 1
}
}
}
Details of a cost unit
Activity name: GetCostUnitByCostUnitId
Get the details of a cost unit
path Parameters
costUnitId required | string <uuid> The unique identifier of a cost unit |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales",
- "automaticallyLinkToAllCostCenters": false,
- "origin": {
- "code": 1,
- "description": 1,
- "automaticallyLinkToAllCostCenters": 1
}
}
}
Edit the details of a cost unit record
Activity name: PatchCostUnitByCostUnitId
Edit the details of a cost unit record (kosten drager)
- No metadata required
path Parameters
costUnitId required | string <uuid> The unique identifier of a cost unit |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Cost unit
code | string [ 1 .. 20 ] characters The code for a cost unit |
description | string [ 1 .. 50 ] characters The description for a cost unit |
Responses
Request samples
- Payload
{- "code": "SAL073",
- "description": "Sales"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales",
- "automaticallyLinkToAllCostCenters": false,
- "origin": {
- "code": 1,
- "description": 1,
- "automaticallyLinkToAllCostCenters": 1
}
}
}
Delete a cost unit
Activity name: DeleteCostUnitByCostUnitId
Delete a cost unit
path Parameters
costUnitId required | string <uuid> The unique identifier of a cost unit |
header Parameters
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Cost centers and cost unit matrix
Activity name: GetCostCenterCostUnitMatrixAtPayrollAdministrationLevelByJournalProfileId
Get the matrix of cost centers and cost unit connections for a journal profile for a specific payroll administration.
path Parameters
journalProfileId required | string <uuid> The unique identifier of a journal profile |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "costCenter": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales"
}, - "costUnit": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "005",
- "description": "Tilburg"
}, - "linked": true,
- "locked": true
}
]
}
Edit the links between cost centers and cost units
Activity name: PatchCostCenterCostUnitMatrixAtPayrollAdministrationLevelByJournalProfileId
Edit the links between cost centers and cost units (koppeling kostenplaats en kostendrager)
path Parameters
journalProfileId required | string <uuid> The unique identifier of a journal profile |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object | |
object | |
linked | boolean If true the given combination of cost center and cost unit are linked. Linked means that the combination can be selected in the "Ledger account to payroll component mapping" and "journal allocation" on employment level. |
Responses
Request samples
- Payload
[- {
- "costCenter": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "costUnit": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "linked": true
}
]
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "costCenter": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "SAL073",
- "description": "Sales"
}, - "costUnit": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": "005",
- "description": "Tilburg"
}, - "linked": true,
- "locked": true
}
}
Get the journal application for a journal configuration
Activity name: GetJournalApplicationByJournalConfigurationId
Get the journal application for a journal configuration
path Parameters
journalConfigurationId required | string <uuid> The unique identifier of a journal configuration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "journalApplication": {
- "key": 1,
- "value": "Precies Online"
}, - "financialAdministration": {
- "code": "NL-12345",
- "externalValue": "Vesting Den Helder"
}, - "journalCode": "2",
- "account": {
- "key": 2,
- "value": "Account Jan"
}, - "description": "General ledger supermarkets",
- "isAutomatedExportEnabled": false,
- "methodForDeterminingAccountingPeriod": {
- "key": 1,
- "value": "Periode eerste dag verloningsperiode"
}, - "deviatingJournalSeries": "A",
- "linkCostCenterToGroup": {
- "code": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "externalValue": "Vesting Den Helder"
}, - "linkCostUnitToGroup": {
- "code": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "externalValue": "Vesting Den Helder"
}, - "includeCostCenter": true,
- "includeCostUnit": false,
- "payrollPeriodFinancialPeriodMapping": [
- {
- "payrollPeriodNumber": 1,
- "financialPeriodNumber": 11,
- "financialAndPayrollYearRelation": {
- "key": 1,
- "value": "Payroll Year -1"
}
}
], - "reportVoucherNumber": 0,
- "credentials": {
- "username": "User123"
}, - "journalNumber": 0,
- "subAdministration": "General ledger supermarkets salary",
- "allocation": "Salary",
- "suspenseAccount": "SAL-4000"
}
}
Create a new journal application for a journal configuration
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.
path Parameters
journalConfigurationId required | string <uuid> The unique identifier of a journal configuration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object <metadata> (journalApplicationPost) 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. | |
object or null <metadata> (financialAdministration) The financial administration | |
journalCode | string or null (journalCode) <= 255 characters DagboekCode |
object or null <metadata> (account) The account to connect to the financial software. | |
description | string or null (JournalApplication_components-schemas-description) <= 255 characters The description to be send in with the ledger lines |
isAutomatedExportEnabled | boolean or null (isAutomatedExportEnabled) This field indicates whether journalruns will be exported automaticaly or not |
object or null <metadata> (methodForDeterminingAccountingPeriod) This field indicates how the system should determine the (financial)period to book the results on. | |
deviatingJournalSeries | string or null (deviatingJournalSeries) <= 1 characters ^[a-zA-Z]$ Afwijking boekstuk serie |
object or null <metadata> (linkCostCenterToGroup) links the cost center to a group | |
object or null <metadata> (linkCostUnitToGroup) links the cost unit to a group | |
includeCostCenter | boolean or null (includeCostCenter) Indicates whether cost centers are included in the journal export |
includeCostUnit | boolean or null (includeCostUnit) Indicates whether cost units are included in the journal export |
Array of objects or null (payrollPeriodFinancialPeriodMapping) 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. | |
reportVoucherNumber | integer or null <int32> (reportVoucherNumber) boekstuknummer |
object or null (credentials) | |
journalNumber | integer or null <int32> (journalNumber) Dagboek |
subAdministration | string or null (subAdministration) <= 255 characters Sub-Administratie |
apiKey | string or null (apiKey) <= 3072 characters An API key |
allocation | string or null (allocation) <= 255 characters Toewijzing |
suspenseAccount | string or null (suspenseAccount) [ 1 .. 20 ] characters The "number" for the suspense account (is a string) |
Responses
Request samples
- Payload
{- "journalApplication": {
- "key": 1
}, - "financialAdministration": {
- "code": "NL-12345"
}, - "journalCode": "2",
- "account": {
- "key": 2
}, - "description": "General ledger supermarkets",
- "isAutomatedExportEnabled": false,
- "methodForDeterminingAccountingPeriod": {
- "key": 1
}, - "deviatingJournalSeries": "A",
- "linkCostCenterToGroup": {
- "code": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "linkCostUnitToGroup": {
- "code": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "includeCostCenter": true,
- "includeCostUnit": false,
- "payrollPeriodFinancialPeriodMapping": [
- {
- "payrollPeriodNumber": 1,
- "financialPeriodNumber": 11,
- "financialAndPayrollYearRelation": {
- "key": 1
}
}
], - "reportVoucherNumber": 0,
- "credentials": {
- "username": "User123",
- "password": "**********"
}, - "journalNumber": 0,
- "subAdministration": "General ledger supermarkets salary",
- "apiKey": null,
- "allocation": "Salary",
- "suspenseAccount": "SAL-4000"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "journalApplication": {
- "key": 1,
- "value": "Precies Online"
}, - "financialAdministration": {
- "code": "NL-12345",
- "externalValue": "Vesting Den Helder"
}, - "journalCode": "2",
- "account": {
- "key": 2,
- "value": "Account Jan"
}, - "description": "General ledger supermarkets",
- "isAutomatedExportEnabled": false,
- "methodForDeterminingAccountingPeriod": {
- "key": 1,
- "value": "Periode eerste dag verloningsperiode"
}, - "deviatingJournalSeries": "A",
- "linkCostCenterToGroup": {
- "code": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "externalValue": "Vesting Den Helder"
}, - "linkCostUnitToGroup": {
- "code": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "externalValue": "Vesting Den Helder"
}, - "includeCostCenter": true,
- "includeCostUnit": false,
- "payrollPeriodFinancialPeriodMapping": [
- {
- "payrollPeriodNumber": 1,
- "financialPeriodNumber": 11,
- "financialAndPayrollYearRelation": {
- "key": 1,
- "value": "Payroll Year -1"
}
}
], - "reportVoucherNumber": 0,
- "credentials": {
- "username": "User123"
}, - "journalNumber": 0,
- "subAdministration": "General ledger supermarkets salary",
- "allocation": "Salary",
- "suspenseAccount": "SAL-4000"
}
}
Edit the details of a journal application
Activity name: PatchJournalApplicationByJournalConfigurationId
Edit the details of journal application
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the POST URL.
path Parameters
journalConfigurationId required | string <uuid> The unique identifier of a journal configuration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object or null <metadata> (financialAdministration) The financial administration | |
journalCode | string or null (journalCode) <= 255 characters DagboekCode |
object or null <metadata> (account) The account to connect to the financial software. | |
description | string or null (JournalApplication_components-schemas-description) <= 255 characters The description to be send in with the ledger lines |
isAutomatedExportEnabled | boolean or null (isAutomatedExportEnabled) This field indicates whether journalruns will be exported automaticaly or not |
object or null <metadata> (methodForDeterminingAccountingPeriod) This field indicates how the system should determine the (financial)period to book the results on. | |
deviatingJournalSeries | string or null (deviatingJournalSeries) <= 1 characters ^[a-zA-Z]$ Afwijking boekstuk serie |
object or null <metadata> (linkCostCenterToGroup) links the cost center to a group | |
object or null <metadata> (linkCostUnitToGroup) links the cost unit to a group | |
includeCostCenter | boolean or null (includeCostCenter) Indicates whether cost centers are included in the journal export |
includeCostUnit | boolean or null (includeCostUnit) Indicates whether cost units are included in the journal export |
Array of objects or null (payrollPeriodFinancialPeriodMapping) 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. | |
reportVoucherNumber | integer or null <int32> (reportVoucherNumber) boekstuknummer |
object or null (credentials) | |
journalNumber | integer or null <int32> (journalNumber) Dagboek |
subAdministration | string or null (subAdministration) <= 255 characters Sub-Administratie |
apiKey | string or null (apiKey) <= 3072 characters An API key |
allocation | string or null (allocation) <= 255 characters Toewijzing |
suspenseAccount | string or null (suspenseAccount) [ 1 .. 20 ] characters The "number" for the suspense account (is a string) |
Responses
Request samples
- Payload
{- "financialAdministration": {
- "code": "NL-12345"
}, - "journalCode": "2",
- "account": {
- "key": 2
}, - "description": "General ledger supermarkets",
- "isAutomatedExportEnabled": false,
- "methodForDeterminingAccountingPeriod": {
- "key": 1
}, - "deviatingJournalSeries": "A",
- "linkCostCenterToGroup": {
- "code": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "linkCostUnitToGroup": {
- "code": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "includeCostCenter": true,
- "includeCostUnit": false,
- "payrollPeriodFinancialPeriodMapping": [
- {
- "payrollPeriodNumber": 1,
- "financialPeriodNumber": 11,
- "financialAndPayrollYearRelation": {
- "key": 1
}
}
], - "reportVoucherNumber": 0,
- "credentials": {
- "username": "User123",
- "password": "**********"
}, - "journalNumber": 0,
- "subAdministration": "General ledger supermarkets salary",
- "apiKey": null,
- "allocation": "Salary",
- "suspenseAccount": "SAL-4000"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "journalApplication": {
- "key": 1,
- "value": "Precies Online"
}, - "financialAdministration": {
- "code": "NL-12345",
- "externalValue": "Vesting Den Helder"
}, - "journalCode": "2",
- "account": {
- "key": 2,
- "value": "Account Jan"
}, - "description": "General ledger supermarkets",
- "isAutomatedExportEnabled": false,
- "methodForDeterminingAccountingPeriod": {
- "key": 1,
- "value": "Periode eerste dag verloningsperiode"
}, - "deviatingJournalSeries": "A",
- "linkCostCenterToGroup": {
- "code": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "externalValue": "Vesting Den Helder"
}, - "linkCostUnitToGroup": {
- "code": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "externalValue": "Vesting Den Helder"
}, - "includeCostCenter": true,
- "includeCostUnit": false,
- "payrollPeriodFinancialPeriodMapping": [
- {
- "payrollPeriodNumber": 1,
- "financialPeriodNumber": 11,
- "financialAndPayrollYearRelation": {
- "key": 1,
- "value": "Payroll Year -1"
}
}
], - "reportVoucherNumber": 0,
- "credentials": {
- "username": "User123"
}, - "journalNumber": 0,
- "subAdministration": "General ledger supermarkets salary",
- "allocation": "Salary",
- "suspenseAccount": "SAL-4000"
}
}
Delete a journal application
Activity name: DeleteJournalApplicationByJournalConfigurationId
Delete a journal application
path Parameters
journalConfigurationId required | string <uuid> The unique identifier of a journal configuration |
header Parameters
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
NL: Verdeling journaal. Manage of the allocation to different costCenters and costUnits for a given employment
List of journal allocations for an employment
Activity name: GetJournalAllocationsByEmploymentId
Get the list of financial journal allocations (journaliseren module) for an employment.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "journalProfileConfiguration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2017-01-01",
- "periodEndDate": "2017-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2017-01-01",
- "periodEndDate": "2017-01-31"
}, - "journalProfile": {
- "key": 2,
- "value": "General ledger supermarkets"
}
}, - "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "allocationBasedOnActualHours": {
- "costCenter": {
- "key": 2,
- "code": "SAL073",
- "description": "Sales Den Bosch"
}, - "costUnit": {
- "key": 2,
- "code": "01",
- "description": "Cars"
}
}, - "allocationBasedOnFixedWeights": [
- {
- "costCenter": {
- "key": 2,
- "code": "SAL073",
- "description": "Sales Den Bosch"
}, - "costUnit": {
- "key": 2,
- "code": "01",
- "description": "Cars"
}, - "weight": 1
}
]
}
]
}
Create a new journal allocation record for an employment
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.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Journal allocation to add to the employment.
object <metadata> | |
object or null <metadata> | |
object or null 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 Please note that this object MUST be null when | |
Array of objects or null Provide the allocation details within this object when allocation based on weights (=factor) is applicable. Functional effect; if the costCenter and/or costUnit are provided within this object than the journal run calculations will use these fixed weights when performing calculations. Any costCenters and costUnits in the PayrollPeriodData records will be ignored for the calculations in that case. Please note that this object MUST be null when |
Responses
Request samples
- Payload
{- "startPeriod": {
- "year": 2017,
- "periodNumber": 1
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1
}, - "allocationBasedOnActualHours": {
- "costCenter": {
- "key": 2
}, - "costUnit": {
- "key": 2
}
}, - "allocationBasedOnFixedWeights": [
- {
- "costCenter": {
- "key": 2
}, - "costUnit": {
- "key": 2
}, - "weight": 1
}
]
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "journalProfileConfiguration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2017-01-01",
- "periodEndDate": "2017-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2017-01-01",
- "periodEndDate": "2017-01-31"
}, - "journalProfile": {
- "key": 2,
- "value": "General ledger supermarkets"
}
}, - "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "allocationBasedOnActualHours": {
- "costCenter": {
- "key": 2,
- "code": "SAL073",
- "description": "Sales Den Bosch"
}, - "costUnit": {
- "key": 2,
- "code": "01",
- "description": "Cars"
}
}, - "allocationBasedOnFixedWeights": [
- {
- "costCenter": {
- "key": 2,
- "code": "SAL073",
- "description": "Sales Den Bosch"
}, - "costUnit": {
- "key": 2,
- "code": "01",
- "description": "Cars"
}, - "weight": 1
}
]
}
}
Details of a journal allocation
Activity name: GetJournalAllocationByJournalAllocationId
Get the details of a financial journal allocation record (journaliseren module).
path Parameters
journalAllocationId required | string <uuid> The unique identifier of the journal allocation |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "journalProfileConfiguration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2017-01-01",
- "periodEndDate": "2017-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2017-01-01",
- "periodEndDate": "2017-01-31"
}, - "journalProfile": {
- "key": 2,
- "value": "General ledger supermarkets"
}
}, - "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "allocationBasedOnActualHours": {
- "costCenter": {
- "key": 2,
- "code": "SAL073",
- "description": "Sales Den Bosch"
}, - "costUnit": {
- "key": 2,
- "code": "01",
- "description": "Cars"
}
}, - "allocationBasedOnFixedWeights": [
- {
- "costCenter": {
- "key": 2,
- "code": "SAL073",
- "description": "Sales Den Bosch"
}, - "costUnit": {
- "key": 2,
- "code": "01",
- "description": "Cars"
}, - "weight": 1
}
]
}
}
Edit the details of a journal allocation record
Activity name: PutJournalAllocationByJournalAllocationId
Edit the details of a financial journal allocation record (journaliseren module)
- Possible options for fields of the type 'metadata' can be acquired (GET) by adding
/metadata
to the PUT URL. - Possible options dependent on a specific
startPeriod
can be acquired via/metadata/year/{year}/period/{period}
path Parameters
journalAllocationId required | string <uuid> The unique identifier of the journal allocation |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Organizational entity to edit.
object <metadata> | |
object or null <metadata> | |
object or null 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 Please note that this object MUST be null when | |
Array of objects or null Provide the allocation details within this object when allocation based on weights (=factor) is applicable. Functional effect; if the costCenter and/or costUnit are provided within this object than the journal run calculations will use these fixed weights when performing calculations. Any costCenters and costUnits in the PayrollPeriodData records will be ignored for the calculations in that case. Please note that this object MUST be null when |
Responses
Request samples
- Payload
{- "startPeriod": {
- "year": 2017,
- "periodNumber": 1
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1
}, - "allocationBasedOnActualHours": {
- "costCenter": {
- "key": 2
}, - "costUnit": {
- "key": 2
}
}, - "allocationBasedOnFixedWeights": [
- {
- "costCenter": {
- "key": 2
}, - "costUnit": {
- "key": 2
}, - "weight": 1
}
]
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "journalProfileConfiguration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2017-01-01",
- "periodEndDate": "2017-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2017-01-01",
- "periodEndDate": "2017-01-31"
}, - "journalProfile": {
- "key": 2,
- "value": "General ledger supermarkets"
}
}, - "startPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "endPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "allocationBasedOnActualHours": {
- "costCenter": {
- "key": 2,
- "code": "SAL073",
- "description": "Sales Den Bosch"
}, - "costUnit": {
- "key": 2,
- "code": "01",
- "description": "Cars"
}
}, - "allocationBasedOnFixedWeights": [
- {
- "costCenter": {
- "key": 2,
- "code": "SAL073",
- "description": "Sales Den Bosch"
}, - "costUnit": {
- "key": 2,
- "code": "01",
- "description": "Cars"
}, - "weight": 1
}
]
}
}
Delete a specific journal allocation record
Activity name: DeleteJournalAllocationByJournalAllocationId
Delete a journal allocation record
path Parameters
journalAllocationId required | string <uuid> The unique identifier of the journal allocation |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of all the leave entries
Activity name : GetLeaveByEmploymentId
Returns all the leave entries (both addition and subtraction) for the given employment.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "numberOfUnits": 8,
- "unitType": {
- "key": 1,
- "value": "Uren"
}, - "isAccrual": false,
- "startDate": "2017-11-01",
- "endDate": "2017-11-01",
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)",
- "balanceExceedsYear": true
}, - "origin": {
- "leavePolicy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "value": "Default leave Regulations",
- "leaveUnitType": {
- "key": 1,
- "value": "Uren"
}
}, - "meansOfCreation": {
- "key": 1,
- "value": "individual"
}
}, - "comment": "some comment",
- "relatedLeaveRequest": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "relatedLeave": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
]
}
Create a leave record for an employment
Activity name : PostLeaveByEmploymentId
Add a Leave record for an employment
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
numberOfUnits | number <double> [ 0 .. 999.99 ] ^(\d{1,3})(\.\d{1,2})?$ The number of leave units requested |
isAccrual | boolean Indicates whether the request is for accrual of leave.
|
startDate | string <date> The start date of the leave requested |
endDate | string <date> The end date of the leave requested (last day of the leave) |
object <metadata> The type of leave requested by the employee
| |
comment | string or null <= 4000 characters |
Responses
Request samples
- Payload
{- "numberOfUnits": 8,
- "isAccrual": false,
- "startDate": "2017-11-01",
- "endDate": "2017-11-01",
- "leaveType": {
- "key": 1
}, - "comment": "some comment"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "numberOfUnits": 8,
- "unitType": {
- "key": 1,
- "value": "Uren"
}, - "isAccrual": false,
- "startDate": "2017-11-01",
- "endDate": "2017-11-01",
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)",
- "balanceExceedsYear": true
}, - "origin": {
- "leavePolicy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "value": "Default leave Regulations",
- "leaveUnitType": {
- "key": 1,
- "value": "Uren"
}
}, - "meansOfCreation": {
- "key": 1,
- "value": "individual"
}
}, - "comment": "some comment",
- "relatedLeaveRequest": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "relatedLeave": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
}
A single leave entry
Activity name : GetLeaveByLeaveId
Returns one leave entry (either addition or subtraction).
path Parameters
leaveId required | string <uuid> The unique identifier of the leave |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "numberOfUnits": 8,
- "unitType": {
- "key": 1,
- "value": "Uren"
}, - "isAccrual": false,
- "startDate": "2017-11-01",
- "endDate": "2017-11-01",
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)",
- "balanceExceedsYear": true
}, - "origin": {
- "leavePolicy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "value": "Default leave Regulations",
- "leaveUnitType": {
- "key": 1,
- "value": "Uren"
}
}, - "meansOfCreation": {
- "key": 1,
- "value": "individual"
}
}, - "comment": "some comment",
- "relatedLeaveRequest": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "relatedLeave": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
}
Edit the details of a leave
Activity name : PutLeaveByLeaveId
Edit the details of a leave
path Parameters
leaveId required | string <uuid> The unique identifier of the leave |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Leave to edit.
numberOfUnits | number <double> [ 0 .. 999.99 ] ^(\d{1,3})(\.\d{1,2})?$ The number of leave units requested |
isAccrual | boolean Indicates whether the request is for accrual of leave.
|
startDate | string <date> The start date of the leave requested |
endDate | string <date> The end date of the leave requested (last day of the leave) |
object <metadata> The type of leave requested by the employee
| |
comment | string or null <= 4000 characters |
Responses
Request samples
- Payload
{- "numberOfUnits": 8,
- "isAccrual": false,
- "startDate": "2017-11-01",
- "endDate": "2017-11-01",
- "leaveType": {
- "key": 1
}, - "comment": "some comment"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "numberOfUnits": 8,
- "unitType": {
- "key": 1,
- "value": "Uren"
}, - "isAccrual": false,
- "startDate": "2017-11-01",
- "endDate": "2017-11-01",
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)",
- "balanceExceedsYear": true
}, - "origin": {
- "leavePolicy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "value": "Default leave Regulations",
- "leaveUnitType": {
- "key": 1,
- "value": "Uren"
}
}, - "meansOfCreation": {
- "key": 1,
- "value": "individual"
}
}, - "comment": "some comment",
- "relatedLeaveRequest": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "relatedLeave": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
}
Delete a specific leave record
Activity name : DeleteLeaveByLeaveId
Delete an existing Leave record
path Parameters
leaveId required | string <uuid> The unique identifier of the leave |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Get the values for the metadata fields
Activity name : GetLeaveMetadataByEmploymentId
Returns the metadata values for all the metadata fields.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "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"
}
]
}
]
}
Get the default values to be used when POSTing a new record
Activity name : GetLeaveDefaultsByEmploymentId
Returns the default values for all the fields. In case no default is present null
will be returned.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": null,
- "resourceVersion": "2018-01-01"
}, - "messages": [ ],
- "content": {
- "id": null,
- "numberOfUnits": 8,
- "isAccrual": false,
- "startDate": "<today>",
- "endDate": "<today>",
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)",
- "balanceExceedsYear": true
}, - "origin": null,
- "comment": null,
- "relatedLeaveRequest": null,
- "relatedLeave": null
}
}
Get the values for the metadata fields
Activity name : GetLeaveMetadataByLeaveId
Returns the metadata values for all the metadata fields.
path Parameters
leaveId required | string <uuid> The unique identifier of the leave |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "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"
}
]
}
]
}
Get the proposed number of leave hours for an employment
Activity name : GetProposedLeaveHoursByEmploymentId
Returns the numberOfHours (only in hours) calculated based on the employments working- hours/schedual
Note: The function will only work if the employment is either linked to no leave policy or linked to only leave policy(s) that use hours as the unit of leave.
Further more how the leave hours are calculated can be managed in the leave policy with the applyLeaveSchedule
and working hours
resource with the field calculateUsingWorkPattern.leaveHours
The order is as follows. If calculateUsingWorkPattern.leaveHours is true the work patern from workinghours is used otherwise if applyLeaveSchedule is set to true the leavePattern
is used otherwise the workinghours are used
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
startDate | stringdate Example: startDate=2022-08-01 The start date of the leave period |
endDate | stringdate Example: endDate=2022-08-07 The end date of the leave period |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "proposedLeaveHours": 8,
- "methodOfCalculation": "Ploeguren",
- "additionalInformation": "Additional information on the calculation."
}
}
Get the proposed number of leave hours for all employments of an employer
Activity name : GetProposedLeaveHoursByEmployerId
Returns the numberOfHours (only in hours) calculated based on the employments working- hours/schedual
Note: The function will only work if the employment is either linked to no leave policy or linked to only leave policy(s) that use hours as the unit of leave.
Further more how the leave hours are calculated can be managed in the leave policy with the applyLeaveSchedule
and working hours
resource with the field calculateUsingWorkPattern.leaveHours
The order is as follows. If calculateUsingWorkPattern.leaveHours is true the work patern from workinghours is used otherwise if applyLeaveSchedule is set to true the leavePattern
is used otherwise the workinghours are used
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
startDate | stringdate Example: startDate=2022-08-01 The start date of the leave period |
endDate | stringdate Example: endDate=2022-08-07 The end date of the leave period |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "proposedLeaveHours": 8,
- "methodOfCalculation": "Ploeguren",
- "additionalInformation": "Additional information on the calculation."
}
]
}
Download the leave overview for an employment and year
Activity name : GetLeaveOverviewByEmploymentIdandYear Download the leave overview for a year in a single PDF
Metadata : Possible options for year
can be acquired (GET) the following URL /providers/employers/employees/employments/{employmentId}/leave/overview/metadata.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
year required | integer <int32> <= 4 characters Example: 2018 The payroll year |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
NL: Verlof balans. Leave balances for all leave types known for the employment. The types of leave can be managed ath the employer level
List of yearly leave balances for each leave type.
Activity name : GetLeaveBalancesByEmploymentId
Returns the yearly leave balances for each leave type.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "year": 2019,
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)",
- "balanceExceedsYear": true
}, - "balancePreviousYear": 20,
- "accrual": 30,
- "usageTotal": 10,
- "usageThroughToday": 8,
- "usageAfterToday": 2,
- "usageFirstHalfYear": 2,
- "balance": 40,
- "unitType": {
- "key": 1,
- "value": "Uren"
}, - "expires": 15
}
]
}
The leave balance for all employments
Activity name : GetLeaveBalancesByEmployerId
Returns the yearly leave balances for all employments
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2020-12-31 Set a reference date for the following logic
If not provided, "today" is used |
leaveType | Array of integers Example: leaveType=1,15,99 Select which If not provided, the |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "historicalStartDate": "2012-05-01",
- "endDate": "2018-10-23",
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker"
}, - "nonPayrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "HR only employees",
- "description": "Bakker"
}, - "incomeRelationshipNumber": 12,
- "employee": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen",
- "prefixPartner": "van de",
- "lastNamePartner": "Wiel",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "dateOfBirth": "1995-05-21",
}, - "organizationalEntity": {
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}, - "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Directeur",
- "group": "internal"
}, - "standardFunction": {
- "key": 1,
- "value": "Administrateur",
- "code": "A21",
- "category": 1
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "placeOfEmployment": "Amsterdam office"
}, - "leaveBalance": [
- {
- "year": 2019,
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)",
- "balanceExceedsYear": true
}, - "balancePreviousYear": 20,
- "accrual": 30,
- "usageTotal": 10,
- "usageThroughReferenceDate": 8,
- "usageAfterReferenceDate": 2,
- "usageFirstHalfYear": 2,
- "balance": 40,
- "expires": 15
}
]
}
]
}
The leave balanceworth for all employments
Activity name : GetLeaveBalanceWorthByEmployerId
Returns the yearly leave balances and their worth for all employments
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2020-12-31 Set a reference date for the following logic
If not provided, "today" is used |
leaveType | Array of integers Example: leaveType=1,15,99 Select which If not provided, the |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "historicalStartDate": "2012-05-01",
- "endDate": "2018-10-23",
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker"
}, - "nonPayrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "HR only employees",
- "description": "Bakker"
}, - "incomeRelationshipNumber": 12,
- "employee": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen",
- "prefixPartner": "van de",
- "lastNamePartner": "Wiel",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "dateOfBirth": "1995-05-21",
}, - "organizationalEntity": {
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}, - "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Directeur",
- "group": "internal"
}, - "standardFunction": {
- "key": 1,
- "value": "Administrateur",
- "code": "A21",
- "category": 1
}, - "deviatingFunctionGroup": "9A",
- "deviatingFunctionDescription": "Directeur",
- "placeOfEmployment": "Amsterdam office"
}, - "leaveBalance": [
- {
- "year": 2019,
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)",
- "balanceExceedsYear": true
}, - "balancePreviousYear": 20,
- "accrual": 30,
- "usageTotal": 10,
- "usageThroughReferenceDate": 8,
- "usageAfterReferenceDate": 2,
- "usageFirstHalfYear": 2,
- "balance": 40,
- "expires": 15,
- "worth": 15
}
]
}
]
}
Summed up leave balance total and grouped by
Activity name : GetLeaveBalancesGroupedByEmployerId
Returns the yearly leave balances total per leave type and total per groupBy
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
referenceDate | string <date> Example: referenceDate=2020-12-31 Set a reference date for the following logic
If not provided, "today" is used |
leaveType | Array of integers Example: leaveType=1,15,99 Select which If not provided, the |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
groupBy required | string Enum: "Department" "Function" Select the groupBy |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "totals": [
- {
- "year": 2019,
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)",
- "balanceExceedsYear": true
}, - "balancePreviousYear": 20,
- "accrual": 30,
- "usageTotal": 10,
- "usageThroughReferenceDate": 8,
- "usageAfterReferenceDate": 2,
- "balance": 40
}
], - "groups": [
- {
- "group": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Verkoop Binnendienst"
}, - "year": 2019,
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)",
- "balanceExceedsYear": true
}, - "balancePreviousYear": 20,
- "accrual": 30,
- "usageTotal": 10,
- "usageThroughReferenceDate": 8,
- "usageAfterReferenceDate": 2,
- "balance": 40
}
]
}
}
Get data to create an importfile
Activity name : GetLeaveImportDataByEmployerId
Returns, for the given employer, a set of data that can be used as a base for importing leave through a csv file.
Note that on importing, the columnnames must be in Dutch. (WerkgeverId PersnrVerl Persnr Naam Ingangsdatum Einddatum Soort Factor Eenheden)
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employerNumber": 20720,
- "payrollEmployeeNumber": 202,
- "employeeNumber": 156,
- "formattedName": "Jong, I",
- "startDate": "2023-11-01",
- "endDate": "2023-11-30",
- "leaveTypeKey": 1,
- "isAccrual": 1,
- "numberOfUnits": 0
}
]
}
Import leave via a csv file
Activity name : PostLeaveImportDataByEmployerId
Imports a csv file containing leave records.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
csv file to be uploaded.
mimeType | string Value: "text/csv" The type of file to import. Currently only csv is supported |
data | string base64 encoded file. |
Responses
Request samples
- Payload
{- "mimeType": "text/csv",
- "data": "YQ=="
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
NL: Verlof aanvraag. Leave request for a certain type of leave. The types of leave can be managed at the employer level
List of leave requests for the employees of an employer
Activity name : GetLeaveRequestsByEmployerId
Returns a list of leave requests for the employments of the employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "numberOfUnits": 8,
- "unitType": {
- "key": 1,
- "value": "Uren"
}, - "isAccrual": false,
- "startDate": "2017-11-01",
- "endDate": "2017-11-01",
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)"
}, - "leaveRequestStatus": {
- "key": 9,
- "value": "Geaccepteerd"
}, - "submittedOn": "2018-05-08T15:16:49+02:00",
- "submittedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen",
- "prefixPartner": "van de",
- "lastNamePartner": "Wiel",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "dateOfBirth": "1995-05-21",
}, - "handledTime": "2018-05-08T15:16:49+02:00",
- "handledBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "ABC",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "commentEmployee": "Vakantie naar Spanje",
- "commentHandler": "Fijne vakantie!",
- "currentlyAvailableUnits": 140
}
]
}
Change the status of leave requests
Activity name : PatchLeaveRequestsByLeaveRequestIds
This endpoints changes the status of the list of leave requests provided in the request body to the provided status. The leave requests are processed one by one. The leave requests that had no error's will be commited to the database while those with an error will be skipped. If an error occured the service will return a 400 bad request with a message explaining what error occured for what ID (GUID). The leave requests that where processed successfully will not be returned in te response.
This 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.
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
id required | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier (a GUID/UUID) |
action required | string Enum: "accept" "reject" "reopen" "revoke" The action to perform on the leave request resulting in a change of
|
Responses
Request samples
- Payload
[- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "action": "accept"
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
leave requests by employment
Activity name : GetLeaveRequestsByEmploymentId
Get a list of all leave requests for the given employment
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "numberOfUnits": 8,
- "unitType": {
- "key": 1,
- "value": "Uren"
}, - "isAccrual": false,
- "startDate": "2017-11-01",
- "endDate": "2017-11-01",
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)"
}, - "leaveRequestStatus": {
- "key": 9,
- "value": "Geaccepteerd"
}, - "submittedOn": "2018-05-08T15:16:49+02:00",
- "submittedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen",
- "prefixPartner": "van de",
- "lastNamePartner": "Wiel",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "dateOfBirth": "1995-05-21",
}, - "handledTime": "2018-05-08T15:16:49+02:00",
- "handledBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "ABC",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "commentEmployee": "Vakantie naar Spanje",
- "commentHandler": "Fijne vakantie!",
- "currentlyAvailableUnits": 140
}
]
}
Create a leave request for an employment
Activity name : PostLeaveRequestByEmploymentId
Add a Leave request for an employment. This can only be done by the employee.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
numberOfUnits | number <double> (schemas-numberOfUnits) [ 0 .. 999.99 ] ^(\d{1,3})(\.\d{1,2})?$ The number of leave units requested |
isAccrual | boolean (isAccrual) Indicates whether the request is for accrual of leave.
|
startDate | string <date> (LeaveRequest_components-schemas-startDate) The start date of the leave requested |
endDate | string <date> (LeaveRequest_components-schemas-endDate) The end date of the leave requested (last day of the leave) |
object <metadata> (schemas-leaveType) The type of leave requested by the employee
| |
commentEmployee | string or null (commentEmployeePost) <= 4000 characters The comment left by the employee |
Responses
Request samples
- Payload
{- "numberOfUnits": 8,
- "isAccrual": false,
- "startDate": "2017-11-01",
- "endDate": "2017-11-01",
- "leaveType": {
- "key": 1
}, - "commentEmployee": "Vakantie naar Spanje"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "numberOfUnits": 8,
- "unitType": {
- "key": 1,
- "value": "Uren"
}, - "isAccrual": false,
- "startDate": "2017-11-01",
- "endDate": "2017-11-01",
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)"
}, - "leaveRequestStatus": {
- "key": 9,
- "value": "Geaccepteerd"
}, - "submittedOn": "2018-05-08T15:16:49+02:00",
- "submittedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen",
- "prefixPartner": "van de",
- "lastNamePartner": "Wiel",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "dateOfBirth": "1995-05-21",
}, - "handledTime": "2018-05-08T15:16:49+02:00",
- "handledBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "ABC",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "commentEmployee": "Vakantie naar Spanje",
- "commentHandler": "Fijne vakantie!",
- "currentlyAvailableUnits": 140
}
}
Details of a leave request
Activity name : GetLeaveRequestByLeaveRequestId
Get the details of a single leave request
path Parameters
leaveRequestId required | string <uuid> The unique identifier of the leave request |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "numberOfUnits": 8,
- "unitType": {
- "key": 1,
- "value": "Uren"
}, - "isAccrual": false,
- "startDate": "2017-11-01",
- "endDate": "2017-11-01",
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)"
}, - "leaveRequestStatus": {
- "key": 9,
- "value": "Geaccepteerd"
}, - "submittedOn": "2018-05-08T15:16:49+02:00",
- "submittedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen",
- "prefixPartner": "van de",
- "lastNamePartner": "Wiel",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "dateOfBirth": "1995-05-21",
}, - "handledTime": "2018-05-08T15:16:49+02:00",
- "handledBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "ABC",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "commentEmployee": "Vakantie naar Spanje",
- "commentHandler": "Fijne vakantie!",
- "currentlyAvailableUnits": 140
}
}
Change the details of a leave request
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.
"
path Parameters
leaveRequestId required | string <uuid> The unique identifier of the leave request |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
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.
numberOfUnits | number <double> (schemas-numberOfUnits) [ 0 .. 999.99 ] ^(\d{1,3})(\.\d{1,2})?$ The number of leave units requested |
isAccrual | boolean (isAccrual) Indicates whether the request is for accrual of leave.
|
startDate | string <date> (LeaveRequest_components-schemas-startDate) The start date of the leave requested |
endDate | string <date> (LeaveRequest_components-schemas-endDate) The end date of the leave requested (last day of the leave) |
object <metadata> (schemas-leaveType) The type of leave requested by the employee
| |
commentHandler | string or null (commentHandlerPut) <= 4000 characters The comment left by the person handling the leave request |
Responses
Request samples
- Payload
{- "numberOfUnits": 8,
- "isAccrual": false,
- "startDate": "2017-11-01",
- "endDate": "2017-11-01",
- "leaveType": {
- "key": 1
}, - "commentHandler": "Fijne vakantie!"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "numberOfUnits": 8,
- "unitType": {
- "key": 1,
- "value": "Uren"
}, - "isAccrual": false,
- "startDate": "2017-11-01",
- "endDate": "2017-11-01",
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)"
}, - "leaveRequestStatus": {
- "key": 9,
- "value": "Geaccepteerd"
}, - "submittedOn": "2018-05-08T15:16:49+02:00",
- "submittedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen",
- "prefixPartner": "van de",
- "lastNamePartner": "Wiel",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "dateOfBirth": "1995-05-21",
}, - "handledTime": "2018-05-08T15:16:49+02:00",
- "handledBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "ABC",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "commentEmployee": "Vakantie naar Spanje",
- "commentHandler": "Fijne vakantie!",
- "currentlyAvailableUnits": 140
}
}
List of leave types
Activity name : GetLeaveTypesByEmployerId
Get a list of all leavetypes for the employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)",
- "balanceExceedsYear": true,
- "enabled": true,
- "employeeCanRequestIncrease": true
}, - "deviations": {
- "value": "Verlof",
- "balanceExceedsYear": true,
- "enabled": true,
- "employeeCanRequestIncrease": false
}
}
]
}
Details of a leave type
Activity name: GetLeaveTypeByEmployerIdAndLeaveTypeId
Get the details of a leave type
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
leaveTypeId required | string <uuid> The unique identifier of the leave type |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)",
- "balanceExceedsYear": true,
- "enabled": true,
- "employeeCanRequestIncrease": true
}, - "deviations": {
- "value": "Verlof",
- "balanceExceedsYear": true,
- "enabled": true,
- "employeeCanRequestIncrease": false
}
}
}
Edit the details of a leave type
Activity name: PutLeaveTypeByEmployerIdAndLeaveTypeId
Edit the details for a leave type
Metadata : There is no metadata endpoint for this resource.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
leaveTypeId required | string <uuid> The unique identifier of the leave type |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Leave type to edit.
object or null Optional deviations to the leave type. If set these deviations will overwrite the default values. Note: Two leaveTypes are excluded from deviations "verlof" and "Verlof bovenwettelijk" |
Responses
Request samples
- Payload
{- "deviations": {
- "value": "Verlof",
- "balanceExceedsYear": true,
- "enabled": true,
- "employeeCanRequestIncrease": false
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)",
- "balanceExceedsYear": true,
- "enabled": true,
- "employeeCanRequestIncrease": true
}, - "deviations": {
- "value": "Verlof",
- "balanceExceedsYear": true,
- "enabled": true,
- "employeeCanRequestIncrease": false
}
}
}
List custom holidays for an employer
Activity name : GetCustomHolidaysByEmployerId
Get a list of the custom holidays for an employer.
Note: The custom holidays defined at the employer level can be used at the employee and employment level.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "date": "2021-01-01",
- "description": "Company 100th year anniversary"
}
]
}
Add a custom holiday for an employer
Activity name : PostCustomHolidayByEmployerId
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a custom holiday
date | string <date> The date for the custom holiday. |
description | string <= 50 characters The description for the custom holiday. |
Responses
Request samples
- Payload
{- "date": "2021-01-01",
- "description": "Company 100th year anniversary"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "date": "2021-01-01",
- "description": "Company 100th year anniversary"
}
}
Details of a custom holiday
Activity name : GetCustomHolidayByCustomHolidayId
Get the details of a custom holiday
path Parameters
customHolidayId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "date": "2021-01-01",
- "description": "Company 100th year anniversary"
}
]
}
Edit a custom holiday record
Activity name : PutCustomHolidayByCustomHolidayId
path Parameters
customHolidayId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
date | string <date> The date for the custom holiday. |
description | string <= 50 characters The description for the custom holiday. |
Responses
Request samples
- Payload
{- "date": "2021-01-01",
- "description": "Company 100th year anniversary"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "date": "2021-01-01",
- "description": "Company 100th year anniversary"
}
}
Delete a custom holiday record
Activity name : DeleteCustomHolidayByCustomHolidayId
Delete an existing custom holiday record
path Parameters
customHolidayId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of national holidays
Activity name : GetNationalHolidaysByEmployerId
Get a list of all national holidays for the employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "nationalHoliday": {
- "key": 1,
- "value": "2e kerstdag",
- "enabled": true,
- "dateInCurrentYear": "2021-12-26"
}, - "deviations": {
- "value": "Boxing day",
- "enabled": true
}
}
]
}
Details of a national holiday
Activity name: GetNationalHolidaysByEmployerIdAndNationalHolidayId
Get the details of a national holiday
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
nationalHolidayId required | string <uuid> The unique identifier of the national holiday |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "nationalHoliday": {
- "key": 1,
- "value": "2e kerstdag",
- "enabled": true,
- "dateInCurrentYear": "2021-12-26"
}, - "deviations": {
- "value": "Boxing day",
- "enabled": true
}
}
}
Edit the details of a national holidays
Activity name: PutNationalHolidayByEmployerIdAndNationalHolidayId
Edit the details for a national holiday
Metadata : There is no metadata endpoint for this resource.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
nationalHolidayId required | string <uuid> The unique identifier of the national holiday |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
National holiday to edit.
object or null Optional deviations to the national holiday. If set these deviations will overwrite the default values. |
Responses
Request samples
- Payload
{- "deviations": {
- "value": "Boxing day",
- "enabled": true
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "nationalHoliday": {
- "key": 1,
- "value": "2e kerstdag",
- "enabled": true,
- "dateInCurrentYear": "2021-12-26"
}, - "deviations": {
- "value": "Boxing day",
- "enabled": true
}
}
}
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.
List available hours per employment (for calendar)
Activity name : GetCalendarAvailableHoursByEmployerId
For a calendar, this endpoint returns the availability of an employment expressed as a pattern for both odd and even weeks. Note that multiple patterns can be active in the time period that is requested using the query parameter startDate
and endDate
. While multiple patterns can be returned, on any date only one pattern is active. The patterns do not overlap.
The available hours for a day are determined by the bi-weekly work pattern (as defined in the Working Hours resource) if such a work pattern is present for the employment. If no bi-weekly work pattern is present and the employment is NOT an on-call employment than the number of standard hours (either shiftHours or deviatingHoursPerWeek) is equally divided over the working days within each week (Monday through Friday).
This endpoint only returns objects for which the employment meets the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
startDate required | string <date> A valid date (yyyy-MM-dd). First day of the timebox for which calendar data will be collected. |
endDate required | string <date> A valid date (yyyy-MM-dd). Last day of the timebox for which calendar data will be collected. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employment": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "incomeRelationshipNumber": 12
}, - "employee": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "firstName": "Susan"
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}, - "calendar": [
- {
- "startDate": "2019-01-01",
- "endDate": "2019-01-05",
- "details": { }
}
]
}
]
}
List leave per employment (for calendar)
Activity name : GetCalendarLeaveByEmployerId
This endpoint return the leave calendar items for each employment. Please note: this endpoint only will return calendar items based on leave of the type 'opname'.
This endpoint only returns objects for which the employment meets the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
startDate required | string <date> A valid date (yyyy-MM-dd). First day of the timebox for which calendar data will be collected. |
endDate required | string <date> A valid date (yyyy-MM-dd). Last day of the timebox for which calendar data will be collected. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employment": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "incomeRelationshipNumber": 12
}, - "employee": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "firstName": "Susan"
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}, - "calendar": [
- {
- "startDate": "2019-01-01",
- "endDate": "2019-01-05",
- "details": { }
}
]
}
]
}
List leave requests per employment (for calendar)
Activity name : GetCalendarLeaveRequestsByEmployerId
For a calendar, this endpoint return the leave requests calendar items PER specific employment.
Please note: this endpoint only will return calendar items based on leave request with status 'ingediend'.
This endpoint only returns objects for which the employment meets the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
startDate required | string <date> A valid date (yyyy-MM-dd). First day of the timebox for which calendar data will be collected. |
endDate required | string <date> A valid date (yyyy-MM-dd). Last day of the timebox for which calendar data will be collected. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employment": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "incomeRelationshipNumber": 12
}, - "employee": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "firstName": "Susan"
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}, - "calendar": [
- {
- "startDate": "2019-01-01",
- "endDate": "2019-01-05",
- "details": { }
}
]
}
]
}
List leave requests per employment (for calendar)
Activity name : GetCalendarRevokeLeaveRequestsByEmployerId
For a calendar, this endpoint return the revoke leave requests calendar items PER specific employment.
Please note: this endpoint only will return calendar items based on leave request with status 'geaccepteerd met intrekkingsverzoek.'.
This endpoint only returns objects for which the employment meets the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
startDate required | string <date> A valid date (yyyy-MM-dd). First day of the timebox for which calendar data will be collected. |
endDate required | string <date> A valid date (yyyy-MM-dd). Last day of the timebox for which calendar data will be collected. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employment": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "incomeRelationshipNumber": 12
}, - "employee": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "firstName": "Susan"
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}, - "calendar": [
- {
- "startDate": "2019-01-01",
- "endDate": "2019-01-05",
- "details": { }
}
]
}
]
}
List absences per employment (for calendar)
Activity name : GetCalendarAbsencesByEmployerId
For a calendar, this endpoint return the absence calendar items PER specific employment.
This endpoint only returns objects for which the employment meets the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
startDate required | string <date> A valid date (yyyy-MM-dd). First day of the timebox for which calendar data will be collected. |
endDate required | string <date> A valid date (yyyy-MM-dd). Last day of the timebox for which calendar data will be collected. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employment": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "incomeRelationshipNumber": 12
}, - "employee": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "firstName": "Susan"
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}, - "calendar": [
- {
- "startDate": "2019-01-01",
- "endDate": "2019-01-05",
- "details": { }
}
]
}
]
}
Get the calendar data of the department of the employment
Activity name : GetTeamCalendarByEmploymentId
This endpoint returns, for all the employments for the department of the employment of the {employmentId} in the PATH, per day the availability.
Note that, if no workPattern
is known for an employment saturday and sunday counted as non-workdays
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
startDate required | string <date> A valid date (yyyy-MM-dd). First day of the timebox for which calendar data will be collected. |
endDate required | string <date> A valid date (yyyy-MM-dd). Last day of the timebox for which calendar data will be collected. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employeeName": "Wiel van Bergen",
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "dates": [
- {
- "date": "2018-04-26",
- "leaveStatus": "Approved",
- "nonWorkday": true,
- "noAccess": true
}
], - "leave": [
- {
- "status": "Approved",
- "startDate": "2018-04-26",
- "endDate": "2024-04-29"
}
]
}
]
}
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
List of all the leave policies
Activity name : GetLeavePoliciesByEmployerId
Returns all the leave policies for the given employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Normal leave",
- "leaveUnitType": {
- "key": 1,
- "value": "Uren"
}, - "roundTo": {
- "key": 1,
- "value": "0.01"
}, - "roundingMethod": {
- "key": 1,
- "value": "Logical"
}, - "accrualType": {
- "key": 1,
- "value": "Jaar"
}, - "dayOfTheMonthToPerformAutomaticLeaveCalculationOn": 12,
- "payoutLeaveImmediately": false,
- "leaveEntitlement": {
- "statutory": 160,
- "excessLeaveToStatutory": 40,
- "wtr": 40
}, - "leaveRequest": {
- "applyLeaveSchedule": false,
- "useHolidaysInCalculation": false,
- "leavePattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "additionalLeave": {
- "allocationType": {
- "key": 1,
- "value": "Boek alleen hoogste waarde"
}, - "referenceDate1": {
- "month": {
- "key": 1,
- "value": "Januari"
}, - "day": 40
}, - "referenceDate2": {
- "month": {
- "key": 1,
- "value": "Januari"
}, - "day": 40
}
}
}
]
}
Create a leave policy
Activity name : PostLeavePolicyByEmployerId
Add a leave policy
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
name | string [ 1 .. 50 ] characters The name of the leave policy |
object <metadata> Indicates what the unit type (hours or days) is. Employments linked to this leave policy use this leaveUnitType for their leave. | |
object <metadata> Indicates to how many digits after the decimal point to round the numbers | |
object <metadata> Indicates how to round the numbers | |
object <metadata> Indicates how leave is accrued (yearly, monthly or hourly) | |
dayOfTheMonthToPerformAutomaticLeaveCalculationOn | integer or null <int32> [ 1 .. 31 ] They day of the month on which the automatic accrual of (yearly or monthly) leave is performed. The yearly calculation is repeated every month to encompase any changes made that have affect on the past. If for example 31 is chosen and a specific month does not have that day the logic will pick the first available date of said month. |
payoutLeaveImmediately | boolean If leave |
object or null | |
object | |
object |
Responses
Request samples
- Payload
{- "name": "Normal leave",
- "leaveUnitType": {
- "key": 1
}, - "roundTo": {
- "key": 1
}, - "roundingMethod": {
- "key": 1
}, - "accrualType": {
- "key": 1
}, - "dayOfTheMonthToPerformAutomaticLeaveCalculationOn": 12,
- "payoutLeaveImmediately": false,
- "leaveEntitlement": {
- "statutory": 160,
- "excessLeaveToStatutory": 40,
- "wtr": 40
}, - "leaveRequest": {
- "applyLeaveSchedule": false,
- "useHolidaysInCalculation": false,
- "leavePattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "additionalLeave": {
- "allocationType": {
- "key": 1
}, - "referenceDate1": {
- "month": {
- "key": 1
}, - "day": 40
}, - "referenceDate2": {
- "month": {
- "key": 1
}, - "day": 40
}
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Normal leave",
- "leaveUnitType": {
- "key": 1,
- "value": "Uren"
}, - "roundTo": {
- "key": 1,
- "value": "0.01"
}, - "roundingMethod": {
- "key": 1,
- "value": "Logical"
}, - "accrualType": {
- "key": 1,
- "value": "Jaar"
}, - "dayOfTheMonthToPerformAutomaticLeaveCalculationOn": 12,
- "payoutLeaveImmediately": false,
- "leaveEntitlement": {
- "statutory": 160,
- "excessLeaveToStatutory": 40,
- "wtr": 40
}, - "leaveRequest": {
- "applyLeaveSchedule": false,
- "useHolidaysInCalculation": false,
- "leavePattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "additionalLeave": {
- "allocationType": {
- "key": 1,
- "value": "Boek alleen hoogste waarde"
}, - "referenceDate1": {
- "month": {
- "key": 1,
- "value": "Januari"
}, - "day": 40
}, - "referenceDate2": {
- "month": {
- "key": 1,
- "value": "Januari"
}, - "day": 40
}
}
}
}
Create a leave policy based on an existing leave policy
Activity name : PatchCopyLeavePolicyByEmployerId
Add a leave policy based on an existing leave policy at providerlevel. (Create a copy)
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
sourceLeavePolicyId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of the Leave policy at providerlevel which should be copied. |
name | string or null [ 1 .. 50 ] characters The name of the leave policy |
Responses
Request samples
- Payload
{- "sourceLeavePolicyId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Verlofregeling Metaal CAO"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
A single leave policy
Activity name : GetLeavePolicyByLeavePolicyId
Returns one leave policy
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Normal leave",
- "leaveUnitType": {
- "key": 1,
- "value": "Uren"
}, - "roundTo": {
- "key": 1,
- "value": "0.01"
}, - "roundingMethod": {
- "key": 1,
- "value": "Logical"
}, - "accrualType": {
- "key": 1,
- "value": "Jaar"
}, - "dayOfTheMonthToPerformAutomaticLeaveCalculationOn": 12,
- "payoutLeaveImmediately": false,
- "leaveEntitlement": {
- "statutory": 160,
- "excessLeaveToStatutory": 40,
- "wtr": 40
}, - "leaveRequest": {
- "applyLeaveSchedule": false,
- "useHolidaysInCalculation": false,
- "leavePattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "additionalLeave": {
- "allocationType": {
- "key": 1,
- "value": "Boek alleen hoogste waarde"
}, - "referenceDate1": {
- "month": {
- "key": 1,
- "value": "Januari"
}, - "day": 40
}, - "referenceDate2": {
- "month": {
- "key": 1,
- "value": "Januari"
}, - "day": 40
}
}
}
}
Edit the details of a leave policy
Activity name : PutLeavePolicyByLeavePolicyId
Edit the details of a leave policy
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Leave policy to edit.
name | string [ 1 .. 50 ] characters The name of the leave policy |
object <metadata> Indicates what the unit type (hours or days) is. Employments linked to this leave policy use this leaveUnitType for their leave. | |
object <metadata> Indicates to how many digits after the decimal point to round the numbers | |
object <metadata> Indicates how to round the numbers | |
object <metadata> Indicates how leave is accrued (yearly, monthly or hourly) | |
dayOfTheMonthToPerformAutomaticLeaveCalculationOn | integer or null <int32> [ 1 .. 31 ] They day of the month on which the automatic accrual of (yearly or monthly) leave is performed. The yearly calculation is repeated every month to encompase any changes made that have affect on the past. If for example 31 is chosen and a specific month does not have that day the logic will pick the first available date of said month. |
payoutLeaveImmediately | boolean If leave |
object or null | |
object | |
object |
Responses
Request samples
- Payload
{- "name": "Normal leave",
- "leaveUnitType": {
- "key": 1
}, - "roundTo": {
- "key": 1
}, - "roundingMethod": {
- "key": 1
}, - "accrualType": {
- "key": 1
}, - "dayOfTheMonthToPerformAutomaticLeaveCalculationOn": 12,
- "payoutLeaveImmediately": false,
- "leaveEntitlement": {
- "statutory": 160,
- "excessLeaveToStatutory": 40,
- "wtr": 40
}, - "leaveRequest": {
- "applyLeaveSchedule": false,
- "useHolidaysInCalculation": false,
- "leavePattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "additionalLeave": {
- "allocationType": {
- "key": 1
}, - "referenceDate1": {
- "month": {
- "key": 1
}, - "day": 40
}, - "referenceDate2": {
- "month": {
- "key": 1
}, - "day": 40
}
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Normal leave",
- "leaveUnitType": {
- "key": 1,
- "value": "Uren"
}, - "roundTo": {
- "key": 1,
- "value": "0.01"
}, - "roundingMethod": {
- "key": 1,
- "value": "Logical"
}, - "accrualType": {
- "key": 1,
- "value": "Jaar"
}, - "dayOfTheMonthToPerformAutomaticLeaveCalculationOn": 12,
- "payoutLeaveImmediately": false,
- "leaveEntitlement": {
- "statutory": 160,
- "excessLeaveToStatutory": 40,
- "wtr": 40
}, - "leaveRequest": {
- "applyLeaveSchedule": false,
- "useHolidaysInCalculation": false,
- "leavePattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "additionalLeave": {
- "allocationType": {
- "key": 1,
- "value": "Boek alleen hoogste waarde"
}, - "referenceDate1": {
- "month": {
- "key": 1,
- "value": "Januari"
}, - "day": 40
}, - "referenceDate2": {
- "month": {
- "key": 1,
- "value": "Januari"
}, - "day": 40
}
}
}
}
Delete a leave policy
Activity name : DeleteLeavePolicyByLeavePolicyId
Delete a Leave policy
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Age based leave
Activity name : GetAgeBasedLeaveByLeavePolicyId
Returns the age based leave for the given leave policy.
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 50,
- "numberOfMonths": 11
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
]
}
Create an age based leave record
Activity name : PostAgeBasedLeaveByLeavePolicyId
Add an age based leave
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object | |
object | |
object |
Responses
Request samples
- Payload
{- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 50,
- "numberOfMonths": 11
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 50,
- "numberOfMonths": 11
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
}
An age based leave record
Activity name : GetAgeBasedLeaveByAgeBasedLeaveId
Returns one leave age based leave record
path Parameters
ageBasedLeaveId required | string <uuid> The unique identifier of the age based leave |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 50,
- "numberOfMonths": 11
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
}
Edit the details of an age based leave
Activity name : PutAgeBasedLeaveByAgeBasedLeaveId
Edit the details of an age based leave record
path Parameters
ageBasedLeaveId required | string <uuid> The unique identifier of the age based leave |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
age based leave to edit.
object | |
object | |
object |
Responses
Request samples
- Payload
{- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 50,
- "numberOfMonths": 11
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 50,
- "numberOfMonths": 11
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
}
Delete an age based leave record
Activity name : DeleteAgeBasedLeaveByAgeBasedLeaveId
Delete an age based leave record
path Parameters
ageBasedLeaveId required | string <uuid> The unique identifier of the age based leave |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
years of service based leave
Activity name : GetYearsOfServiceBasedLeaveByLeavePolicyId
Returns the years of service based leave for the given leave policy.
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
]
}
Create a years of service based leave record
Activity name : PostYearsOfServiceBasedLeaveByLeavePolicyId
Add a years of service based leave
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object | |
object | |
object |
Responses
Request samples
- Payload
{- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
}
A years of service based leave record
Activity name : GetYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId
Returns one leave years of service based leave record
path Parameters
yearsOfServiceBasedLeaveId required | string <uuid> The unique identifier of the years of service based leave |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
}
Edit the details of a years of service based leave
Activity name : PutYearsOFServiceBasedLeaveByYearsOfServiceBasedLeaveId
Edit the details of a years of service based leave record
path Parameters
yearsOfServiceBasedLeaveId required | string <uuid> The unique identifier of the years of service based leave |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
years of service based leave to edit.
object | |
object | |
object |
Responses
Request samples
- Payload
{- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
}
Delete an years of service based leave record
Activity name : DeleteYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId
Delete an years of service based leave record
path Parameters
yearsOfServiceBasedLeaveId required | string <uuid> The unique identifier of the years of service based leave |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Wage based leave
Activity name : GetWageBasedLeaveByLeavePolicyId
Returns the wage based leave for the given leave policy.
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "fromWage": 40,
- "upToAndIncludingWage": 40,
- "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
]
}
Create a wage based leave record
Activity name : PostWageBasedLeaveByLeavePolicyId
Add a wage based leave
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
fromWage | number <double> [ 0 .. 99999999999999.98 ] the from wage the employment has to earn to be applicable for the additional leave |
upToAndIncludingWage | number <double> [ 0 .. 99999999999999.98 ] the up to and including wage the employment has to earn to be applicable for the additional leave |
object |
Responses
Request samples
- Payload
{- "fromWage": 40,
- "upToAndIncludingWage": 40,
- "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "fromWage": 40,
- "upToAndIncludingWage": 40,
- "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
}
A wage based leave record
Activity name : GetWageBasedLeaveByAgeBasedLeaveId
Returns one leave wage based leave record
path Parameters
wageBasedLeaveId required | string <uuid> The unique identifier of the wage based leave |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "fromWage": 40,
- "upToAndIncludingWage": 40,
- "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
}
Edit the details of a wage based leave
Activity name : PutWageBasedLeaveByWageBasedLeaveId
Edit the details of a wage based leave record
path Parameters
wageBasedLeaveId required | string <uuid> The unique identifier of the wage based leave |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
wage based leave to edit.
fromWage | number <double> [ 0 .. 99999999999999.98 ] the from wage the employment has to earn to be applicable for the additional leave |
upToAndIncludingWage | number <double> [ 0 .. 99999999999999.98 ] the up to and including wage the employment has to earn to be applicable for the additional leave |
object |
Responses
Request samples
- Payload
{- "fromWage": 40,
- "upToAndIncludingWage": 40,
- "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "fromWage": 40,
- "upToAndIncludingWage": 40,
- "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
}
Delete a wage based leave record
Activity name : DeleteWageBasedLeaveByWageBasedLeaveId
Delete a wage based leave record
path Parameters
wageBasedLeaveId required | string <uuid> The unique identifier of the wage based leave |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Edit the details of a wage based leave
Activity name : PutProviderWageBasedLeaveByWageBasedLeaveId
Edit the details of a wage based leave record
path Parameters
wageBasedLeaveId required | string <uuid> The unique identifier of the wage based leave |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
wage based leave to edit.
fromWage | number <double> [ 0 .. 99999999999999.98 ] the from wage the employment has to earn to be applicable for the additional leave |
upToAndIncludingWage | number <double> [ 0 .. 99999999999999.98 ] the up to and including wage the employment has to earn to be applicable for the additional leave |
object |
Responses
Request samples
- Payload
{- "fromWage": 40,
- "upToAndIncludingWage": 40,
- "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "fromWage": 40,
- "upToAndIncludingWage": 40,
- "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
}
Delete a wage based leave record
Activity name : DeleteProviderWageBasedLeaveByWageBasedLeaveId
Delete a wage based leave record
path Parameters
wageBasedLeaveId required | string <uuid> The unique identifier of the wage based leave |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
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
List of all the leave policies at provider level.
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.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Normal leave",
- "leaveUnitType": {
- "key": 1,
- "value": "Uren"
}, - "roundTo": {
- "key": 1,
- "value": "0.01"
}, - "roundingMethod": {
- "key": 1,
- "value": "Logical"
}, - "accrualType": {
- "key": 1,
- "value": "Jaar"
}, - "dayOfTheMonthToPerformAutomaticLeaveCalculationOn": 12,
- "payoutLeaveImmediately": false,
- "leaveEntitlement": {
- "statutory": 160,
- "excessLeaveToStatutory": 40,
- "wtr": 40
}, - "leaveRequest": {
- "applyLeaveSchedule": false,
- "useHolidaysInCalculation": false,
- "leavePattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "additionalLeave": {
- "allocationType": {
- "key": 1,
- "value": "Boek alleen hoogste waarde"
}, - "referenceDate1": {
- "month": {
- "key": 1,
- "value": "Januari"
}, - "day": 40
}, - "referenceDate2": {
- "month": {
- "key": 1,
- "value": "Januari"
}, - "day": 40
}
}
}
]
}
Create a leave policy
Activity name : PostProviderLeavePolicyByProviderId
Add a leave policy
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
name | string [ 1 .. 50 ] characters The name of the leave policy |
object <metadata> Indicates what the unit type (hours or days) is. Employments linked to this leave policy use this leaveUnitType for their leave. | |
object <metadata> Indicates to how many digits after the decimal point to round the numbers | |
object <metadata> Indicates how to round the numbers | |
object <metadata> Indicates how leave is accrued (yearly, monthly or hourly) | |
dayOfTheMonthToPerformAutomaticLeaveCalculationOn | integer or null <int32> [ 1 .. 31 ] They day of the month on which the automatic accrual of (yearly or monthly) leave is performed. The yearly calculation is repeated every month to encompase any changes made that have affect on the past. If for example 31 is chosen and a specific month does not have that day the logic will pick the first available date of said month. |
payoutLeaveImmediately | boolean If leave |
object or null | |
object | |
object |
Responses
Request samples
- Payload
{- "name": "Normal leave",
- "leaveUnitType": {
- "key": 1
}, - "roundTo": {
- "key": 1
}, - "roundingMethod": {
- "key": 1
}, - "accrualType": {
- "key": 1
}, - "dayOfTheMonthToPerformAutomaticLeaveCalculationOn": 12,
- "payoutLeaveImmediately": false,
- "leaveEntitlement": {
- "statutory": 160,
- "excessLeaveToStatutory": 40,
- "wtr": 40
}, - "leaveRequest": {
- "applyLeaveSchedule": false,
- "useHolidaysInCalculation": false,
- "leavePattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "additionalLeave": {
- "allocationType": {
- "key": 1
}, - "referenceDate1": {
- "month": {
- "key": 1
}, - "day": 40
}, - "referenceDate2": {
- "month": {
- "key": 1
}, - "day": 40
}
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Normal leave",
- "leaveUnitType": {
- "key": 1,
- "value": "Uren"
}, - "roundTo": {
- "key": 1,
- "value": "0.01"
}, - "roundingMethod": {
- "key": 1,
- "value": "Logical"
}, - "accrualType": {
- "key": 1,
- "value": "Jaar"
}, - "dayOfTheMonthToPerformAutomaticLeaveCalculationOn": 12,
- "payoutLeaveImmediately": false,
- "leaveEntitlement": {
- "statutory": 160,
- "excessLeaveToStatutory": 40,
- "wtr": 40
}, - "leaveRequest": {
- "applyLeaveSchedule": false,
- "useHolidaysInCalculation": false,
- "leavePattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "additionalLeave": {
- "allocationType": {
- "key": 1,
- "value": "Boek alleen hoogste waarde"
}, - "referenceDate1": {
- "month": {
- "key": 1,
- "value": "Januari"
}, - "day": 40
}, - "referenceDate2": {
- "month": {
- "key": 1,
- "value": "Januari"
}, - "day": 40
}
}
}
}
A single leave policy
Activity name : GetProviderLeavePolicyByLeavePolicyId
Returns one leave policy
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Normal leave",
- "leaveUnitType": {
- "key": 1,
- "value": "Uren"
}, - "roundTo": {
- "key": 1,
- "value": "0.01"
}, - "roundingMethod": {
- "key": 1,
- "value": "Logical"
}, - "accrualType": {
- "key": 1,
- "value": "Jaar"
}, - "dayOfTheMonthToPerformAutomaticLeaveCalculationOn": 12,
- "payoutLeaveImmediately": false,
- "leaveEntitlement": {
- "statutory": 160,
- "excessLeaveToStatutory": 40,
- "wtr": 40
}, - "leaveRequest": {
- "applyLeaveSchedule": false,
- "useHolidaysInCalculation": false,
- "leavePattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "additionalLeave": {
- "allocationType": {
- "key": 1,
- "value": "Boek alleen hoogste waarde"
}, - "referenceDate1": {
- "month": {
- "key": 1,
- "value": "Januari"
}, - "day": 40
}, - "referenceDate2": {
- "month": {
- "key": 1,
- "value": "Januari"
}, - "day": 40
}
}
}
}
Edit the details of a leave policy
Activity name : PutProviderLeavePolicyByLeavePolicyId
Edit the details of a leave policy
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Leave policy to edit.
name | string [ 1 .. 50 ] characters The name of the leave policy |
object <metadata> Indicates what the unit type (hours or days) is. Employments linked to this leave policy use this leaveUnitType for their leave. | |
object <metadata> Indicates to how many digits after the decimal point to round the numbers | |
object <metadata> Indicates how to round the numbers | |
object <metadata> Indicates how leave is accrued (yearly, monthly or hourly) | |
dayOfTheMonthToPerformAutomaticLeaveCalculationOn | integer or null <int32> [ 1 .. 31 ] They day of the month on which the automatic accrual of (yearly or monthly) leave is performed. The yearly calculation is repeated every month to encompase any changes made that have affect on the past. If for example 31 is chosen and a specific month does not have that day the logic will pick the first available date of said month. |
payoutLeaveImmediately | boolean If leave |
object or null | |
object | |
object |
Responses
Request samples
- Payload
{- "name": "Normal leave",
- "leaveUnitType": {
- "key": 1
}, - "roundTo": {
- "key": 1
}, - "roundingMethod": {
- "key": 1
}, - "accrualType": {
- "key": 1
}, - "dayOfTheMonthToPerformAutomaticLeaveCalculationOn": 12,
- "payoutLeaveImmediately": false,
- "leaveEntitlement": {
- "statutory": 160,
- "excessLeaveToStatutory": 40,
- "wtr": 40
}, - "leaveRequest": {
- "applyLeaveSchedule": false,
- "useHolidaysInCalculation": false,
- "leavePattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "additionalLeave": {
- "allocationType": {
- "key": 1
}, - "referenceDate1": {
- "month": {
- "key": 1
}, - "day": 40
}, - "referenceDate2": {
- "month": {
- "key": 1
}, - "day": 40
}
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Normal leave",
- "leaveUnitType": {
- "key": 1,
- "value": "Uren"
}, - "roundTo": {
- "key": 1,
- "value": "0.01"
}, - "roundingMethod": {
- "key": 1,
- "value": "Logical"
}, - "accrualType": {
- "key": 1,
- "value": "Jaar"
}, - "dayOfTheMonthToPerformAutomaticLeaveCalculationOn": 12,
- "payoutLeaveImmediately": false,
- "leaveEntitlement": {
- "statutory": 160,
- "excessLeaveToStatutory": 40,
- "wtr": 40
}, - "leaveRequest": {
- "applyLeaveSchedule": false,
- "useHolidaysInCalculation": false,
- "leavePattern": {
- "oddWeeks": {
- "monday": 8,
- "tuesday": 8,
- "wednesday": 4,
- "thursday": 7.5,
- "friday": 4,
- "saturday": 0,
- "sunday": 0
}, - "evenWeeks": {
- "monday": 0,
- "tuesday": 8,
- "wednesday": 8,
- "thursday": 8,
- "friday": 2,
- "saturday": 0,
- "sunday": 0
}
}
}, - "additionalLeave": {
- "allocationType": {
- "key": 1,
- "value": "Boek alleen hoogste waarde"
}, - "referenceDate1": {
- "month": {
- "key": 1,
- "value": "Januari"
}, - "day": 40
}, - "referenceDate2": {
- "month": {
- "key": 1,
- "value": "Januari"
}, - "day": 40
}
}
}
}
Delete a leave policy
Activity name : DeleteProviderLeavePolicyByLeavePolicyId
Delete a Leave policy
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Age based leave
Activity name : GetProviderAgeBasedLeaveByLeavePolicyId
Returns the age based leave for the given leave policy at provider level.
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 50,
- "numberOfMonths": 11
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
]
}
Create an age based leave record
Activity name : PostProviderAgeBasedLeaveByLeavePolicyId
Add an age based leave
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object | |
object | |
object |
Responses
Request samples
- Payload
{- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 50,
- "numberOfMonths": 11
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 50,
- "numberOfMonths": 11
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
}
An age based leave record
Activity name : GetProviderAgeBasedLeaveByAgeBasedLeaveId
Returns one leave age based leave record
path Parameters
ageBasedLeaveId required | string <uuid> The unique identifier of the age based leave |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 50,
- "numberOfMonths": 11
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
}
Edit the details of an age based leave
Activity name : PutProviderAgeBasedLeaveByAgeBasedLeaveId
Edit the details of an age based leave record
path Parameters
ageBasedLeaveId required | string <uuid> The unique identifier of the age based leave |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
age based leave to edit.
object | |
object | |
object |
Responses
Request samples
- Payload
{- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 50,
- "numberOfMonths": 11
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 50,
- "numberOfMonths": 11
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
}
Delete an age based leave record
Activity name : DeleteProviderAgeBasedLeaveByAgeBasedLeaveId
Delete an age based leave record
path Parameters
ageBasedLeaveId required | string <uuid> The unique identifier of the age based leave |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
years of service based leave
Activity name : GetProviderYearsOfServiceBasedLeaveByLeavePolicyId
Returns the years of service based leave for the given leave policy at providerlevel.
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
]
}
Create a years of service based leave record
Activity name : PostProviderYearsOfServiceBasedLeaveByLeavePolicyId
Add a years of service based leave
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object | |
object | |
object |
Responses
Request samples
- Payload
{- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
}
A years of service based leave record
Activity name : GetProviderYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId
Returns one leave years of service based leave record
path Parameters
yearsOfServiceBasedLeaveId required | string <uuid> The unique identifier of the years of service based leave |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
}
Edit the details of a years of service based leave
Activity name : PutProviderYearsOFServiceBasedLeaveByYearsOfServiceBasedLeaveId
Edit the details of a years of service based leave record
path Parameters
yearsOfServiceBasedLeaveId required | string <uuid> The unique identifier of the years of service based leave |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
years of service based leave to edit.
object | |
object | |
object |
Responses
Request samples
- Payload
{- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "from": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "upToAndIncluding": {
- "numberOfYears": 40,
- "numberOfMonths": 0
}, - "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
}
Delete an years of service based leave record
Activity name : DeleteProviderYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId
Delete an years of service based leave record
path Parameters
yearsOfServiceBasedLeaveId required | string <uuid> The unique identifier of the years of service based leave |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Wage based leave
Activity name : GetProviderWageBasedLeaveByLeavePolicyId
Returns the wage based leave for the given leave policy at provider level.
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "fromWage": 40,
- "upToAndIncludingWage": 40,
- "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
]
}
Create a wage based leave record
Activity name : PostProviderWageBasedLeaveByLeavePolicyId
Add a wage based leave
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
fromWage | number <double> [ 0 .. 99999999999999.98 ] the from wage the employment has to earn to be applicable for the additional leave |
upToAndIncludingWage | number <double> [ 0 .. 99999999999999.98 ] the up to and including wage the employment has to earn to be applicable for the additional leave |
object |
Responses
Request samples
- Payload
{- "fromWage": 40,
- "upToAndIncludingWage": 40,
- "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "fromWage": 40,
- "upToAndIncludingWage": 40,
- "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
}
A wage based leave record
Activity name : GetProviderWageBasedLeaveByAgeBasedLeaveId
Returns one leave wage based leave record
path Parameters
wageBasedLeaveId required | string <uuid> The unique identifier of the wage based leave |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "fromWage": 40,
- "upToAndIncludingWage": 40,
- "leaveEntitlement": {
- "excessLeaveToStatutory": 40,
- "wtr": 40
}
}
}
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.
Get list of linked employments for the leave policy
Activity name: GetEmploymentsByLeavePolicyId Get the list of employments that are linked for this leave policy. When a leave policy and an employment are linked, that means the employment will be provided with leave based on the policy.
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
query Parameters
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2020-01-01",
- "endDate": "2021-12-31",
- "incomeRelationshipNumber": 1,
- "employee": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen",
- "prefixPartner": "van de",
- "lastNamePartner": "Wiel",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "dateOfBirth": "1995-05-21",
}
}
]
}
Create or delete multiple linked employments for the leave policy
Activity name: PatchEmploymentsByLeavePolicyId This endpoint enables the user to create or delete multiple 'linkages' with one call. This is mostly useful updating a larger number of employments for the given leave policy.
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/jsonrequired
The request body contains an array of objects containing a employment
and an action
field.
id required | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier (GUID/UUID) of the employment |
action required | string Enum: "link" "unlink" The action to perform. |
Responses
Request samples
- Payload
[- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "action": "link"
}
]
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Get list of linked leave policies for the employment
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.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "value": "Default leave Regulation",
- "leaveUnitType": {
- "key": 1,
- "value": "Uren"
}
}
]
}
Link or unlink leave policies for the employment
Activity name: PatchLeavePoliciesByEmploymentId
Metadata : Possible options can be acquired (GET) by adding /metadata
to the POST URL.
This endpoint enables the user to link or unlink multiple 'linkages' with one call.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/jsonrequired
The request body contains an array of objects containing a leavePolicy
and an action
field.
id required | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier (GUID/UUID) of the leave policy |
action required | string Enum: "link" "unlink" The action to perform. |
Responses
Request samples
- Payload
[- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "action": "link"
}
]
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Post leave for multiple employments.
Activity name: PostCollectiveLeaveByEmployerId
Post leave for a set of employments under an employer.
Metadata : There is no metadata endpoint for this resource.
Defaults : Defaults are available at /defaults.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Array of Leave objects
startDate | string <date> The start date for the leave. |
endDate | string <date> The end date for the leave. |
leaveType | integer <int32> The id of the leavetype. |
isAccrual | boolean Indicates whether the leave should be added(true) or subtracted(false). |
numberOfUnits | number <double> <= 999.99 ^(\d{1,6})(.\d{1,2})?$ The amount of leave. |
comments | string or null <= 4000 Any comments on the leave. |
Responses
Request samples
- Payload
[- {
- "startDate": "2022-10-21",
- "endDate": "2022-10-22",
- "leaveType": 1,
- "isAccrual": true,
- "numberOfUnits": 4.5,
- "comments": "This leave is added."
}
]
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Leave accrual for employments of a leave policy
Activity name : GetLeavePolicyAccrualByLeavePolicyId
Returns the accrual for each leave type for all employments within an employer that have accrual for the given leavepolicy.
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
query Parameters
year | integer <int32> <= 4 characters Example: year=2024 The year |
month | integer <int32> <= 2 characters Example: month=7 The month |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "leavePolicyAccrual": [
- {
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)"
}, - "accrual": 30,
- "accrualAgeBasedLeave": 30,
- "accrualWageBasedLeave": 30,
- "accrualYearsOfServiceBasedLeave": 30
}
]
}
]
}
Leave accrual for an employment
Activity name : GetLeavePolicyAccrualByLeavePolicyIdAndEmploymentId
Returns the accrual for each leave type, given a leavepolicy and year
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
year | integer <int32> <= 4 characters Example: year=2024 The year |
month | integer <int32> <= 2 characters Example: month=7 The month |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "leavePolicyAccrual": [
- {
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)"
}, - "accrual": 30,
- "accrualAgeBasedLeave": 30,
- "accrualWageBasedLeave": 30,
- "accrualYearsOfServiceBasedLeave": 30
}
]
}
}
Leave entitlement for employments of a leave policy
Activity name : GetLeavePolicyEntitlementByLeavePolicyId
Returns the entitlement for each leave type.
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
query Parameters
year | integer <int32> <= 4 characters Example: year=2024 The year |
month | integer <int32> <= 2 characters Example: month=7 The month |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "leavePolicyEntitlement": [
- {
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)"
}, - "entitlement": 30,
- "entitlementAgeBasedLeave": 30,
- "entitlementWageBasedLeave": 30,
- "entitlementYearsOfServiceBasedLeave": 30
}
]
}
]
}
Leave entitlement for an employment
Activity name : GetLeavePolicyEntitlementByLeavePolicyIdAndEmploymentId
Returns the entitlement for each leave type, given a leavepolicy and year
path Parameters
leavePolicyId required | string <uuid> The unique identifier of the leave policy |
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
year | integer <int32> <= 4 characters Example: year=2024 The year |
month | integer <int32> <= 2 characters Example: month=7 The month |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "leavePolicyEntitlement": [
- {
- "leaveType": {
- "key": 1,
- "value": "Verlof (bovenwettelijk)"
}, - "entitlement": 30,
- "entitlementAgeBasedLeave": 30,
- "entitlementWageBasedLeave": 30,
- "entitlementYearsOfServiceBasedLeave": 30
}
]
}
}
Apply the entitlement for multiple employments
Activity name : PatchCollectiveLeavePolicyEntitlementByEmployerId
Starts a process that will calculate and apply the leave entitlement for a set of employments, given a leavepolicy and year.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
employmentId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
leavePolicyId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
year | integer The year |
month | integer or null The year |
includeStatutoryLeave | boolean Set to true to calculate and apply statutory leave |
includeWtrLeave | boolean Set to true to calculate and apply wtr leave |
Responses
Request samples
- Payload
[- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "leavePolicyId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "year": 2023,
- "month": 12,
- "includeStatutoryLeave": true,
- "includeWtrLeave": true
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
Apply the entitlement for an employment
Activity name : PatchLeavePolicyEntitlementByEmploymentId
Starts a process that will calculate and apply the leave entitlement for the employment, given a leavepolicy and year.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
leavePolicyId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
year | integer The year |
month | integer or null The year |
includeStatutoryLeave | boolean Set to true to calculate and apply statutory leave |
includeWtrLeave | boolean Set to true to calculate and apply wtr leave |
Responses
Request samples
- Payload
[- {
- "leavePolicyId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "year": 2023,
- "month": 12,
- "includeStatutoryLeave": true,
- "includeWtrLeave": true
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
]
}
Acquire the address for a combination of `postalCode` and `houseNumber`
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
query Parameters
postalCode required | string Example: postalCode=5037AA A valid postal code |
houseNumber required | integer Example: houseNumber=1 A valid house number (without addition) |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "postalCode": "1234AA",
- "houseNumber": 12,
- "street": "Voordijk",
- "city": "Leiden",
- "province": {
- "key": 1,
- "value": "Noord-Holland"
}, - "coordinates": {
- "latitude": 51.62132245,
- "longitude": 5.55417593
}
}
}
Get Data New Business token for an employer
Activity name : GetDataNewBusinessTokenByEmployerId
Get a token for calling the Data New Business (DNB) API. DNB is a part of Van Spaendonck and with its API, DNB provides users data-based insights such as the salary checker.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "dataNewBusinessToken": "tKcYuqJtbo7Q0wBzRzDFN6mnDghfJfvMOLMj0mOj9W1EW0wk9k8bWmRLug-AprELWHqHIc9f7Q6rNQQ6U6MNDGvVkxcnZH62FCebdqPhquBUEI1q24eCiqsT3Vn8eC27sX5phOhgHK9_bP2lLnDbqZoo5Li7bKmpS75S0_U7SO_BLyl6p-5jJHV2ZS0XFzjEkwIYkW3rPq41nDmbpuh1kNOyxa1fRbfmGhVJnGmWsQBxPwwypC30wFPUcNHHIBXlrryAXESR5Kal8gOolC5n09FlBFKW2EnCDyC-Wl2I0j95MZTUXwr-5JqiOQNWsILLE0GVW5EPmfvXo7hIRhpi1nl-XyWgHEl6wah9mW0G2sVXnbD0oBfMbFSBXTTcZpsVo3yTJB",
- "expiresIn": 3600
}
}
Get Data New Business token
Activity name : GetDataNewBusinessToken
Get a token for calling the Data New Business (DNB) API. DNB is a part of Van Spaendonck and with its API, DNB provides users data-based insights such as the salary checker.
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "dataNewBusinessToken": "tKcYuqJtbo7Q0wBzRzDFN6mnDghfJfvMOLMj0mOj9W1EW0wk9k8bWmRLug-AprELWHqHIc9f7Q6rNQQ6U6MNDGvVkxcnZH62FCebdqPhquBUEI1q24eCiqsT3Vn8eC27sX5phOhgHK9_bP2lLnDbqZoo5Li7bKmpS75S0_U7SO_BLyl6p-5jJHV2ZS0XFzjEkwIYkW3rPq41nDmbpuh1kNOyxa1fRbfmGhVJnGmWsQBxPwwypC30wFPUcNHHIBXlrryAXESR5Kal8gOolC5n09FlBFKW2EnCDyC-Wl2I0j95MZTUXwr-5JqiOQNWsILLE0GVW5EPmfvXo7hIRhpi1nl-XyWgHEl6wah9mW0G2sVXnbD0oBfMbFSBXTTcZpsVo3yTJB",
- "expiresIn": 3600
}
}
Get a list of functions
Activity name : GetDataNewBusinessFunctions
Get a list of functions known by Data New Business.
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "functionName": "architect"
}
]
}
The version number of an employer or employment may be used to decrease the number of calls in your sync-based integration.
List of employer last modified version numbers
Activity name : GetEmployerLastModifiedVersionNumbersByUser
What does the 'last modified' version number reflect
The sequence number of an employer is a sequential number that reflects whether any changes have occurred in any of its UNDERLYING employments.
More precisely, it reflects the sequence number after the latest change of any database record that relates to an employment within this employer. What we consider to be 'underlying' employment data is based on a predefined set of tables, and of course given id. This predefined set of tables can be found here
The scope of this predefined set is to represent 'static' employment data (vaste gegevens), and thus excludes payroll period data (variabele gegevens).
When to use
This endpoint is most useful for integrations that regularly synchronize Loket employment data with another system. As there are no webhooks available, in practice these integrations would need to regularly poll all data to see whether there any changes in the employment data. The most elementary approach of getting all employment data every time you sync acquires a LOT of calls, in some cases even millions per day. Even though we can handle quite a lot, this is not always the desired way for both client and server. Hence, this endpoint enables an alternative solution to set up such an integration.
How to use
With every update (including additions and deletions) the version number will increase. I.e. the version number will NEVER decrease over time. (Please note this is not only true within the context of a single employer (or any other entity) but applies to all changes in the database).
Consequently, in practice one would use this endpoint to check if any empLoyer version numbers have increased by applying the filter query parameter to the version field, for example ?filter=version gt 70429274
.
Recommended usage
- Perform your regular synchronization of static employment data
- Store the highest version number, for which you have now processed all changes. (You may use the following parameter to do this
?orderBy=-lastModifiedVersionNumber
) - Next time you want to perform synchronization. Call this endpoint with parameter
?filter=lastModifiedVersionNumber gt {{YourVersionNumber}}
- Only get employment information for employers that are included in that filtered list. (exclude all other employers as you already know there have been no changes since the last synchronization)
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "lastModifiedVersionNumber": 70429274999853
}
]
}
List of employment version numbers
Activity name : GetEmploymentLastModifiedVersionNumbersByEmployerId
This endpoint is similar to the GetEmployerLastModifiedVersionNumbersByUser endpoint described above. Please check out that description for required context.
In addition to the version on employer level, this endpoint allows you to check if this employment has any changes since your last synchronization. Consequently, this endpoint may be used to further decrease the amount of required calls when performing a synchronization.
As can be seen in the set of 'underlying' tables, also changes in Employee information corresponding to the Employment is reflected in the version number.
How to use
Recommended usage
- Perform all recommended steps in the description of the employer version number endpoint
- Use the exact SAME filter parameter to this endpoint. The resulting list will contain only the employment for which changes have occured since your last synchronization.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "lastModifiedVersionNumber": 70429274999853
}
]
}
Acquire the AOW date
Activity name: GetAowDateByDateOfBirth
This endpoint allows the user to acquire the AOW date of an employee.
query Parameters
dateOfBirth required | string <date> The date of birth of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "aowDate": "2062-08-21"
}
}
Acquire company information
Activity name: GetCompanyInformationByChamberOfCommerceNumber
This endpoint allows the user to acquire basic company information for a specific chamber of commerce number.
path Parameters
chamberOfCommerceNumber required | string The unique identifier of the kvk (8 numbers) |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "name": "Bedrijf B.V.",
- "sbi": {
- "key": 12,
- "value": "Agriculture, Forestry and Fishing",
- "sbiCode": "0116"
}, - "legalForm": {
- "key": 1,
- "value": "B.V."
}, - "website": "www.voorbeeldbv.nl",
- "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "postalCode": "1234AA",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "postalCode": "1234 AA",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}, - "poBox": 5000
}
}
}
Search for an address
Activity name : GetSearchAddressByBearerToken
Use fuzzy search to find an address. The response returns the GEO coördinates that can be used to calculate a route.
query Parameters
query required | string non-empty Example: query=Van Spaendonck Tilburg A term by wich the address might be found the more detailed the better the search results |
lat | number <double> [ -90 .. 90 ] Example: lat=51.585996 latitude for the bias in the search results. Results will be ordered in likelyhood to be relevant to the given latitude (and longitude) |
lon | number <double> [ -180 .. 180 ] Example: lon=5.028622 longitude for the bias in the search results. Results will be ordered in likelyhood to be relevant to the given longitude (and latitude) |
top | integer <int32> [ 1 .. 100 ] Example: top=10 the top x number of results that are returned. If not supplied 5 results are returned |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "pointOfInterest": {
- "name": "Van Spaendonck Groep"
}, - "address": {
- "freeformAddress": "Reitseplein 1, 5037 AA Tilburg",
- "countryCode": "NL"
}, - "position": {
- "latitude": 51.585996,
- "longitude": 5.585996
}
}
]
}
Calculates the distance for a given route
Activity name : GetCalculateRouteByBearerToken
Calculates the dinstance (in KM) between the given GEO coördinates. Its possible to provide multiple stops for the calculation.
query Parameters
query required | string Example: query=51.585996,5.028622;51.555833,5.09073;51.585996,5.028622 The route as defined by the geo-coördinates. Use the following formatting -> latitude,longitude;latitude,longitude;latitude,longitude etc Atleast 2 sets of geo-coördinates have to be provided in order for a route to be calculated Please note: latitude must be a value between -90 and 90 where as longitude must be a value between -180 and 180 |
routeType required | string Enum: "fastest" "shortest" Example: routeType=Fastest The method of how the route is calculated. This can influence the distance to travel. Integers can be used instead of the strings 1 --> fastest / snelste 2 --> shortest / kortste |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "routeType": "Fastest",
- "lengthInKilometers": 48.87
}
}
Authorizations for the application
Activity name : GetApplicationAuthorizationsByApplicationId
Get the authorizations of the application. We expose which activities are accessable by the application and which "rechten" and "producten" are required for the user/employer to enable those activities.
path Parameters
applicationId required | string <uuid> The unique identifier of an application |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "activity": "GetEmployersByUserId",
- "displayName": "Lijst werkgevers",
- "requiredEmployerModules": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Personeelsregistratie"
}
], - "requiredUserAuthorizations": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Beheren dienstverbanden",
- "availableForEmployerUser": true
}
], - "allowedRoles": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Provider"
}
]
}
]
}
Download the application logo
Activity name : GetApplicationLogo
This activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.
Caching: This resource changes very infrequently and can be cached for a longer time.
Get the logo of the application. In case no logo is know the service will return a 404.
path Parameters
applicationId required | string <uuid> The unique identifier of an application |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 401
- 403
{- "message": "Authorization has been denied for this request."
}
List of all the applications available to the employer
Activity name: GetAvailableApplicationsByEmployerId
List of all the applications and premium modules available to the employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC international",
- "marketplaceDescription": "ABC international is the worlds leading etc.",
- "marketplaceSummary": "World-leading application for excellent employers",
- "applicationTypes": [
- {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "value": "planning"
}
], - "targetIndustries": [
- {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "value": "string"
}
], - "dateAddedToStore": "2021-12-31",
- "isHighlighted": true,
- "isActivatedForEmployer": true,
- "productType": {
- "key": 1,
- "value": "Koppeling"
}
}
]
}
List of all the users linking the applications and the employer
Activity name: GetLinkedUsersByEmployerIdAndApplicationId
List of all users that are configred to have both access to the employer and have an connection with the application.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
applicationId required | string <uuid> The unique identifier of an application |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "createdOn": "2018-05-08T15:16:49+02:00",
- "lastLogin": "2018-05-08T15:16:49+02:00",
- "isblocked": true,
- "user": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
]
}
Register a users interest for a marketplace entry
Activity name : PostRegisterInterestByEmployerIdAndApplicationId
Register the interest for the given marketplace entry (product) for the given employer
Metadata : No metadata
Defaults : No default values
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
applicationId required | string <uuid> The unique identifier of an application |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2020-03-16required
Application interest
object Allows the user to provider contact information | |
message | string or null <= 4000 characters message for the intereseted user to the provider of the marketplace entity (product) |
Responses
Request samples
- Payload
{- "contactInformation": {
- "name": "G.H. Wells",
- "phoneNumber": "061231456",
- "emailAddress": "[email protected]"
}, - "message": "Could you contact me to discuss the possibilities of the product in my business "
}
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of modules enabled for the employer
Activity name : GetModulesByEmployerId
Get the array of the modules enabled for the specified employer. A module enables a certain functionality for the given employer. These are typically called 'producten' in Loket.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Personeelsregistratie",
- "number": 40
}
]
}
Enable or disable modules for an employer
Activity name: PatchModulesByEmployerId
Metadata : Possible options can be acquired with the GetModulesByProviderId endpoint.
This endpoint enables the user to enable or disable several modules for an employer with one call.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/jsonrequired
The request body contains an array of modules to be enabled or disabled
id | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of the module |
action | string Enum: "enable" "disable" The action to perform. |
Responses
Request samples
- Payload
[- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "action": "enable"
}
]
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of modules enabled for the provider
Activity name : GetModulesByProviderId
Get 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.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Personeelsregistratie",
- "number": 40
}
]
}
List of module sets
Activity name : GetModuleSetsByProviderId
List the available module sets.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "HR Producten",
- "modules": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Beheren dienstverbanden"
}
]
}
]
}
Create a module set for an provider
Activity name : PostModuleSetByProviderId
Create an module set.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
module set to add.
description | string |
Array of objects (schemas-modules) |
Responses
Request samples
- Payload
{- "description": "HR Producten",
- "modules": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
]
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "HR Producten",
- "modules": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Beheren dienstverbanden"
}
]
}
}
Details of a module set
Activity name : GetModuleSetByModuleSetId
Details of an module set.
path Parameters
moduleSetId required | string <uuid> The unique identifier of an module set |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "HR Producten",
- "modules": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Beheren dienstverbanden"
}
]
}
}
Edit the details of an module set
Activity name : PatchModuleSetByModuleSetId
Patch the details of an module set. Modules can be added or deleted with the enable / disable flag.
path Parameters
moduleSetId required | string <uuid> The unique identifier of an module set |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Autorizationset to edit.
description | string |
Array of objects |
Responses
Request samples
- Payload
{- "description": "HR Producten",
- "modules": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "action": "enable"
}
]
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "HR Producten",
- "modules": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Beheren dienstverbanden"
}
]
}
}
Delete a specific module set
Activity name: DeleteModuleSetByModuleSetId
Delete a module set.
path Parameters
moduleSetId required | string <uuid> The unique identifier of an module set |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
NL: Niet salarisverwerkende administratie. Manage a non payroll administration. A non payroll administration doesn't have a payrolling configuration
List of non payroll administrations for an employer
Activity name : GetNonPayrollAdministrationsByEmployerId
Get a list of all non payroll administrations for an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Bakker",
- "startDate": "2016-01-01",
- "endDate": "2020-12-31",
- "fulltimeHours": 40,
- "cao": {
- "key": 184,
- "value": "Agriculture"
}, - "payrollPeriodType": {
- "key": 2,
- "value": "month"
}, - "holidayAllowanceBaseForCalculation": {
- "key": 1,
- "value": "Basisloon"
}, - "yearEndBaseForCalculation": {
- "key": 1,
- "value": "Basisloon"
}, - "holidayAllowancePercentage": 40,
- "yearEndPercentage": 40
}
]
}
Add a non payroll administration
Activity name : PostNonPayrollAdministrationsByEmployerId
Add a non payroll administration.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
NonPayrollAdministration
description | string <= 50 characters Description of the administration |
startDate | string <date> The first day the administration is active. |
endDate | string or null <date> The last day the administration is active. |
fulltimeHours | number <double> [ 0 .. 99.99 ] The weekly working hours. |
object <metadata> The CAO (CLA -> collective labor agrement). | |
object <metadata> Indicates the frequence of the payrolling process. | |
object <metadata> holidayAllowanceBaseForCalculation | |
object <metadata> yearEndBaseForCalculation | |
holidayAllowancePercentage | number <double> [ 0 .. 100 ] The percentage of the holidayAllowance. |
yearEndPercentage | number <double> [ 0 .. 100 ] The percentage of the year end bonus. |
Responses
Request samples
- Payload
{- "description": "Bakker",
- "startDate": "2016-01-01",
- "endDate": "2020-12-31",
- "fulltimeHours": 40,
- "cao": {
- "key": 184
}, - "payrollPeriodType": {
- "key": 2
}, - "holidayAllowanceBaseForCalculation": {
- "key": 1
}, - "yearEndBaseForCalculation": {
- "key": 1
}, - "holidayAllowancePercentage": 40,
- "yearEndPercentage": 40
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Bakker",
- "startDate": "2016-01-01",
- "endDate": "2020-12-31",
- "fulltimeHours": 40,
- "cao": {
- "key": 184,
- "value": "Agriculture"
}, - "payrollPeriodType": {
- "key": 2,
- "value": "month"
}, - "holidayAllowanceBaseForCalculation": {
- "key": 1,
- "value": "Basisloon"
}, - "yearEndBaseForCalculation": {
- "key": 1,
- "value": "Basisloon"
}, - "holidayAllowancePercentage": 40,
- "yearEndPercentage": 40
}
]
}
Details of a non payroll administration
Activity name : GetNonPayrollAdministrationByNonPayrollAdministrationId
Get the details of a single non payroll administration
path Parameters
nonPayrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Bakker",
- "startDate": "2016-01-01",
- "endDate": "2020-12-31",
- "fulltimeHours": 40,
- "cao": {
- "key": 184,
- "value": "Agriculture"
}, - "payrollPeriodType": {
- "key": 2,
- "value": "month"
}, - "holidayAllowanceBaseForCalculation": {
- "key": 1,
- "value": "Basisloon"
}, - "yearEndBaseForCalculation": {
- "key": 1,
- "value": "Basisloon"
}, - "holidayAllowancePercentage": 40,
- "yearEndPercentage": 40
}
}
Edit a non payroll administration
Activity name : PutNonPayrollAdministrationByNonPayrollAdministrationId
Edit a non payroll administration.
path Parameters
nonPayrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
PayrollComponentSet
description | string <= 50 characters Description of the administration |
endDate | string or null <date> The last day the administration is active. |
fulltimeHours | number <double> [ 0 .. 99.99 ] The weekly working hours. |
object <metadata> The CAO (CLA -> collective labor agrement). | |
object <metadata> holidayAllowanceBaseForCalculation | |
object <metadata> yearEndBaseForCalculation | |
holidayAllowancePercentage | number or null <double> [ 0 .. 100 ] The percentage of the holidayAllowance. |
yearEndPercentage | number or null <double> [ 0 .. 100 ] The percentage of the year end bonus. |
Responses
Request samples
- Payload
{- "description": "Bakker",
- "endDate": "2020-12-31",
- "fulltimeHours": 40,
- "cao": {
- "key": 184
}, - "holidayAllowanceBaseForCalculation": {
- "key": 1
}, - "yearEndBaseForCalculation": {
- "key": 1
}, - "holidayAllowancePercentage": 40,
- "yearEndPercentage": 40
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Bakker",
- "startDate": "2016-01-01",
- "endDate": "2020-12-31",
- "fulltimeHours": 40,
- "cao": {
- "key": 184,
- "value": "Agriculture"
}, - "payrollPeriodType": {
- "key": 2,
- "value": "month"
}, - "holidayAllowanceBaseForCalculation": {
- "key": 1,
- "value": "Basisloon"
}, - "yearEndBaseForCalculation": {
- "key": 1,
- "value": "Basisloon"
}, - "holidayAllowancePercentage": 40,
- "yearEndPercentage": 40
}
]
}
Get a list of notes for an employer.
Activity name : GetEmployerNotesByEmployerId
Get a list of notes, available for the user, for the employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
]
}
Add a note for an employer
Activity name : PostEmployerNoteByEmployerId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata
to the POST URL.
Defaults: Default values for a new object can be acquired by adding `/defaults' to the POST URL.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a note
object Indicates who can view this node. | |
subject | string <= 250 characters subject of the note |
note | string or null <= 4000 characters The note it self. Note: This is a free text field so users can add htlm/script etc. |
Responses
Request samples
- Payload
{- "accessibleBy": {
- "key": 1
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
}
Details of an employer note
Activity name : GetEmployerNoteByNoteId
Get the details of a note
path Parameters
noteId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
]
}
Edit an employer note record
Activity name : PutEmployerNoteByNoteId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding / metadata
to the PUT URL.
path Parameters
noteId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object Indicates who can view this node. | |
subject | string <= 250 characters subject of the note |
note | string or null <= 4000 characters The note it self. Note: This is a free text field so users can add htlm/script etc. |
Responses
Request samples
- Payload
{- "accessibleBy": {
- "key": 1
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
}
Delete an employer note record
Activity name : DeleteEmployerNoteByNoteId
Delete an existing note record
path Parameters
noteId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Get a list of notes for an employment.
Activity name : GetEmploymentNotesByEmploymentId
Get a list of notes, available for the user, for the employment.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
]
}
Add a note for an employment
Activity name : PostEmploymentNoteByEmploymentId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata
to the POST URL.
Defaults: Default values for a new object can be acquired by adding `/defaults' to the POST URL.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a note
object Indicates who can view this node. | |
subject | string <= 250 characters subject of the note |
note | string or null <= 4000 characters The note it self. Note: This is a free text field so users can add htlm/script etc. |
Responses
Request samples
- Payload
{- "accessibleBy": {
- "key": 1
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
}
Details of an employment note
Activity name : GetEmploymentNoteByNoteId
Get the details of an employment note
path Parameters
noteId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
]
}
Edit an employment note record
Activity name : PutEmploymentNoteByNoteId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding / metadata
to the PUT URL.
path Parameters
noteId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object Indicates who can view this node. | |
subject | string <= 250 characters subject of the note |
note | string or null <= 4000 characters The note it self. Note: This is a free text field so users can add htlm/script etc. |
Responses
Request samples
- Payload
{- "accessibleBy": {
- "key": 1
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
}
Delete an employment note record
Activity name : DeleteEmploymentNoteByNoteId
Delete an existing note record
path Parameters
noteId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Get a list of employment notes for an employer.
Activity name : GetEmploymentNotesByEmployerId
Get a list of employment notes, available for the user, for all employments of the employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "concerningEmployee": {
- "employeeNumber": 156,
- "formattedName": "Wiel - van Bergen S.L. van de"
}
}
]
}
Get a list of notes for an employee.
Activity name : GetEmployeeNotesByEmployeeId
Get a list of notes, available for the user, for the employee.
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
]
}
Add a note for an employee
Activity name : PostEmployeeNoteByEmployeeId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata
to the POST URL.
Defaults: Default values for a new object can be acquired by adding `/defaults' to the POST URL.
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a note
object Indicates who can view this node. | |
subject | string <= 250 characters subject of the note |
note | string or null <= 4000 characters The note it self. Note: This is a free text field so users can add htlm/script etc. |
Responses
Request samples
- Payload
{- "accessibleBy": {
- "key": 1
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
}
Details of an employee note
Activity name : GetEmployeeNoteByNoteId
Get the details of a note
path Parameters
noteId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
]
}
Edit an employee note record
Activity name : PutEmployeeNoteByNoteId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding / metadata
to the PUT URL.
path Parameters
noteId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object Indicates who can view this node. | |
subject | string <= 250 characters subject of the note |
note | string or null <= 4000 characters The note it self. Note: This is a free text field so users can add htlm/script etc. |
Responses
Request samples
- Payload
{- "accessibleBy": {
- "key": 1
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
}
Delete an employee note record
Activity name : DeleteEmployeeNoteByNoteId
Delete an existing note record
path Parameters
noteId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Get a list of employee notes for an employer.
Activity name : GetEmployeeNotesByEmployerId
Get a list of employee notes, available for the user, for all employees of the employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "concerningEmployee": {
- "employeeNumber": 156,
- "formattedName": "Wiel - van Bergen S.L. van de"
}
}
]
}
Get a list of notes for a payroll run.
Activity name : GetPayrollRunNotesByPayrollRunId
Get a list of notes, available for the user, for the payroll run.
path Parameters
payrollrunId required | string <uuid> The unique identifier of the payroll run |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
]
}
Add a note for a payroll run
Activity name : PostPayrollRunNoteByPayrollRunId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata
to the POST URL.
Defaults: Default values for a new object can be acquired by adding `/defaults' to the POST URL.
path Parameters
payrollrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a note
object Indicates who can view this node. | |
subject | string <= 250 characters subject of the note |
note | string or null <= 4000 characters The note it self. Note: This is a free text field so users can add htlm/script etc. |
Responses
Request samples
- Payload
{- "accessibleBy": {
- "key": 1
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
}
Details of a payroll run note
Activity name : GetPayrollRunNoteByNoteId
Get the details of a note
path Parameters
noteId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
]
}
Edit a payroll run note record
Activity name : PutPayrollRunNoteByNoteId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding / metadata
to the PUT URL.
path Parameters
noteId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object Indicates who can view this node. | |
subject | string <= 250 characters subject of the note |
note | string or null <= 4000 characters The note it self. Note: This is a free text field so users can add htlm/script etc. |
Responses
Request samples
- Payload
{- "accessibleBy": {
- "key": 1
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
}
Delete a payroll run note record
Activity name : DeletePayrollRunNoteByNoteId
Delete an existing note record
path Parameters
noteId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Get a list of payrollrun notes for an payrolladministration.
Activity name : GetPayrollRunNotesByPayrollAdministrationId
Get a list of payrollrun notes, available for the user, for all payrollruns of the payrolladministration.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "concerningPayrollRun": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriod": {
- "year": 2023,
- "periodNumber": 2
}, - "processingFinishedTime": "2018-05-08T15:16:49+02:00",
- "approvalTime": "2018-05-08T15:16:49+02:00",
- "sequenceNumber": 1
}
}
]
}
Get a list of notes for an conceptemployee.
Activity name : GetConceptEmployeeNotesByConceptEmployeeId
Get a list of notes, available for the user, for the conceptemployee.
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
]
}
Add a note for an conceptemployee
Activity name : PostConceptEmployeeNoteByConceptEmployeeId
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.
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a note
object Indicates who can view this node. | |
subject | string <= 250 characters subject of the note |
note | string or null <= 4000 characters The note it self. Note: This is a free text field so users can add htlm/script etc. |
Responses
Request samples
- Payload
{- "accessibleBy": {
- "key": 1
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
}
Details of an conceptemployee note
Activity name : GetConceptEmployeeNoteByNoteId
Get the details of a note
path Parameters
noteId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
]
}
Edit an conceptemployee note record
Activity name : PutConceptEmployeeNoteByNoteId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding / metadata
to the PUT URL.
path Parameters
noteId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object Indicates who can view this node. | |
subject | string <= 250 characters subject of the note |
note | string or null <= 4000 characters The note it self. Note: This is a free text field so users can add htlm/script etc. |
Responses
Request samples
- Payload
{- "accessibleBy": {
- "key": 1
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "createdOn": "2018-01-01",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "accessibleBy": {
- "key": 1,
- "value": "Everyone"
}, - "subject": "Remember to do xyz",
- "note": "Remember to do xyz",
- "lastModifiedOn": "2018-01-01",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
}
Delete an conceptemployee note record
Activity name : DeleteConceptEmployeeNoteByNoteId
Delete an existing note record
path Parameters
noteId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of notification sets
Activity name : GetNotificationSetsByProviderId
List the available notification sets.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Salarisadministrateur",
- "numberOfLinkedEmployerUsers": 435,
- "notifications": [
- {
- "notificationType": {
- "key": 3,
- "value": "Start of employment"
}, - "createNumberOfDaysBeforeEvent": 30,
- "sendMailWhenNotificationIsCreated": false,
- "receiveDepartmentSignalsOnly": false,
- "isEnabled": true
}
]
}
]
}
Create a notification set for an provider
Activity name : PostNotificationSetByProviderId
Create a notification set.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
notification set to add.
description | string <= 50 characters |
Array of objects (schemas-notifications) |
Responses
Request samples
- Payload
{- "description": "Salarisadministrateur",
- "notifications": [
- {
- "notificationType": {
- "key": 3
}, - "createNumberOfDaysBeforeEvent": 30,
- "sendMailWhenNotificationIsCreated": false,
- "receiveDepartmentSignalsOnly": false,
- "isEnabled": true
}
]
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Salarisadministrateur",
- "numberOfLinkedEmployerUsers": 435,
- "notifications": [
- {
- "notificationType": {
- "key": 3,
- "value": "Start of employment"
}, - "createNumberOfDaysBeforeEvent": 30,
- "sendMailWhenNotificationIsCreated": false,
- "receiveDepartmentSignalsOnly": false,
- "isEnabled": true
}
]
}
}
Details of a notification set
Activity name : GetNotificationSetByNotificationSetId
Details of an notification set.
path Parameters
notificationSetId required | string <uuid> The unique identifier of an notification set |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Salarisadministrateur",
- "numberOfLinkedEmployerUsers": 435,
- "notifications": [
- {
- "notificationType": {
- "key": 3,
- "value": "Start of employment"
}, - "createNumberOfDaysBeforeEvent": 30,
- "sendMailWhenNotificationIsCreated": false,
- "receiveDepartmentSignalsOnly": false,
- "isEnabled": true
}
]
}
}
Edit the details of an notification set
Activity name : PatchNotificationSetByNotificationSetId
Patch the details of an notification set. Notifications can be added or deleted with the enable / disable flag.
path Parameters
notificationSetId required | string <uuid> The unique identifier of an notification set |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Autorizationset to edit.
description | string <= 50 characters |
Array of objects (schemas-notifications) |
Responses
Request samples
- Payload
{- "description": "HR Signalen",
- "notifications": [
- {
- "notificationType": {
- "key": 3
}, - "createNumberOfDaysBeforeEvent": 30,
- "sendMailWhenNotificationIsCreated": false,
- "receiveDepartmentSignalsOnly": false,
- "isEnabled": true
}
]
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Salarisadministrateur",
- "numberOfLinkedEmployerUsers": 435,
- "notifications": [
- {
- "notificationType": {
- "key": 3,
- "value": "Start of employment"
}, - "createNumberOfDaysBeforeEvent": 30,
- "sendMailWhenNotificationIsCreated": false,
- "receiveDepartmentSignalsOnly": false,
- "isEnabled": true
}
]
}
}
Delete a specific notification set
Activity name: DeleteNotificationSetByNotificationSetId
Delete a notification set.
path Parameters
notificationSetId required | string <uuid> The unique identifier of an notification set |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List custom notification
Activity name : GetCustomNotificationsByEmploymentId Get a list of the custom notifications of the employment. Note: custom notifications are user defined for a specific employment.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "notificationDate": "2021-01-01",
- "expirationDate": "2021-01-23",
- "notificationText": "Signal renew document",
- "recurrencePattern": {
- "recurrenceNumber": 2,
- "recurrencePeriod": {
- "key": 2,
- "value": "Weeks"
}, - "numberOfRepetitionsAfterFirstNotification": 4
}
}
]
}
Add a custom notification for an employment
Activity name : PostCustomNotificationByEmploymentId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata
to the POST URL.
Defaults: Default values for a new object can be acquired by adding `/defaults' to the POST URL.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a custom notification
notificationDate | string <date> The date on which the first notification occurs. |
expirationDate | string or null <date> The date on which the Notification will expire. |
notificationText | string The description of the signal |
object or null <metadata> Define a pattern for repeating the notification. This pattern is used to create Notifications after the initial notification as defined in the notificationDate. |
Responses
Request samples
- Payload
{- "notificationDate": "2021-01-01",
- "expirationDate": "2021-01-23",
- "notificationText": "Signal renew document",
- "recurrencePattern": {
- "recurrenceNumber": 2,
- "recurrencePeriod": {
- "key": 2
}, - "numberOfRepetitionsAfterFirstNotification": 4
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "notificationDate": "2021-01-01",
- "expirationDate": "2021-01-23",
- "notificationText": "Signal renew document",
- "recurrencePattern": {
- "recurrenceNumber": 2,
- "recurrencePeriod": {
- "key": 2,
- "value": "Weeks"
}, - "numberOfRepetitionsAfterFirstNotification": 4
}
}
}
Details of a custom notification
Activity name : GetCustomNotificationByCustomNotificationId
Get the details of a custom notification
path Parameters
customNotificationId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "notificationDate": "2021-01-01",
- "expirationDate": "2021-01-23",
- "notificationText": "Signal renew document",
- "recurrencePattern": {
- "recurrenceNumber": 2,
- "recurrencePeriod": {
- "key": 2,
- "value": "Weeks"
}, - "numberOfRepetitionsAfterFirstNotification": 4
}
}
]
}
Edit a custom notification record
Activity name : PutCustomNotificationByCustomNotificationId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding / metadata
to the PUT URL.
path Parameters
customNotificationId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
notificationDate | string <date> The date on which the first notification occurs. |
expirationDate | string or null <date> The date on which the Notification will expire. |
notificationText | string The description of the signal |
object or null <metadata> Define a pattern for repeating the notification. This pattern is used to create Notifications after the initial notification as defined in the notificationDate. |
Responses
Request samples
- Payload
{- "notificationDate": "2021-01-01",
- "expirationDate": "2021-01-23",
- "notificationText": "Signal renew document",
- "recurrencePattern": {
- "recurrenceNumber": 2,
- "recurrencePeriod": {
- "key": 2
}, - "numberOfRepetitionsAfterFirstNotification": 4
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "notificationDate": "2021-01-01",
- "expirationDate": "2021-01-23",
- "notificationText": "Signal renew document",
- "recurrencePattern": {
- "recurrenceNumber": 2,
- "recurrencePeriod": {
- "key": 2,
- "value": "Weeks"
}, - "numberOfRepetitionsAfterFirstNotification": 4
}
}
}
Delete a custom notification record
Activity name : DeleteCustomNotificationByCustomNotificationId
Delete an existing custom notification record
path Parameters
customNotificationId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
NL: Signalen. Manage the notifications for a employer. Notifications are most commonly send by the system to inform the user of a certain event.
Get a list of notifications for an employer.
Activity name : GetNotificationsByEmployerId
Get a list of unread notifications for an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "notificationType": {
- "key": 1,
- "value": "Verjaardag"
}, - "notificationTypeClarification": "30 Jaar",
- "isRead": false,
- "notificationDate": "2018-02-05",
- "markedAsReadBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "markedAsReadOn": "2018-02-05T12:29:44+02:00",
- "appliesToEmployee": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen",
- "prefixPartner": "van de",
- "lastNamePartner": "Wiel",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "dateOfBirth": "1995-05-21",
}
}
]
}
Notifications at providerlevel.
Activity name : GetNotificationsByBearerToken
Returns 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.
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
includeRead | boolean Default: false Example: includeRead=true Include the read items |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: responseType=async;text/csv The accept header is used to influence what type of output is returned and in most cases the version of the output The output of the endpoint is provided async or sync. The default option is
|
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerName": "VST Consultancy",
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "notificationType": {
- "key": 1,
- "value": "Verjaardag"
}, - "notificationTypeClarification": "30 Jaar",
- "isRead": false,
- "notificationDate": "2018-02-05",
- "markedAsReadBy": "Jong, I",
- "markedAsReadOn": "2018-02-05T12:29:44+02:00",
- "appliesToEmployee": {
- "formattedName": "Jong, I",
- "employeeNumber": 156
}
}
]
}
Mark one or more notifications as read.
Activity name : PatchNotificationsByEmployerId
Mark notifications as read
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/jsonrequired
array of notifications to be changed
id required | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
action required | string Value: "markAsRead" The action to perform on the notification |
Responses
Request samples
- Payload
[- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "action": "markAsRead"
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Number of unread notifications per employer.
Activity name : GetNotificationsSummaryByBearerToken
Get a list of employers with for each employer the number of unread notifications.
query Parameters
startDate | stringdate Example: startDate=2020-08-01 The start date |
endDate | stringdate Example: endDate=2020-08-31 The end date |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "numberOfUnreadNotifications": 7
}
]
}
Mark multiple notifications as read.
Activity name : PatchNotificationsByBearerToken
Mark notifications as read in a collective process
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/jsonrequired
array of notifications to be changed
id required | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
Responses
Request samples
- Payload
[- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
Get notification by ID.
Activity name : GetNotificationByNotificationId Retrieve a specific notification by its unique identifier. The notification is returned with the employer and employee information.
path Parameters
notificationId required | string <uuid> (id) ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... Example: b14acd0d-75d7-4fc8-8b22-4a3924585cab The unique identifier of a notification |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerName": "VST Consultancy",
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "notificationType": {
- "key": 1,
- "value": "Verjaardag"
}, - "notificationTypeClarification": "30 Jaar",
- "isRead": false,
- "notificationDate": "2018-02-05",
- "markedAsReadBy": "Jong, I",
- "markedAsReadOn": "2018-02-05T12:29:44+02:00",
- "appliesToEmployee": {
- "formattedName": "Jong, I",
- "employeeNumber": 156
}
}
NL: Mededelingen. Manage the announcements for a employer. Announcements are most commonly send by the system to inform the user changes in the CAO.
Get a list of announcements for an employer.
Activity name : GetAnnouncementsByEmployerId Get a list of announcements for an employer. The list contains a isRead parameter.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "isRead": false,
- "isExpired": false,
- "creationDate": "2018-02-05",
- "effectiveDate": "2018-02-05",
- "expirationDate": "2018-02-05",
- "subject": "Schaalverhoging",
- "description": "Schaal X krijgt een verhoging van Y procent."
}
]
}
Announcements at provider level.
Activity name : GetAnnouncementsByBearerToken
Returns an array of announcements for the current user. By default the list includes announcements that are unread and not expired.
An 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.
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
includeRead | boolean Default: false Example: includeRead=true Include the read items |
includeExpired | boolean Default: false Example: includeExpired=true Include the read items |
includeDescription | boolean Default: false Example: includeDescription=true Indicates whether the description should be included in the response. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: responseType=async;text/csv The accept header is used to influence what type of output is returned and in most cases the version of the output The output of the endpoint is provided async or sync. The default option is
|
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerName": "VST Consultancy",
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "isRead": false,
- "isExpired": false,
- "creationDate": "2018-02-05",
- "effectiveDate": "2018-02-05",
- "expirationDate": "2018-02-05",
- "subject": "Schaalverhoging",
- "description": "Schaal X krijgt een verhoging van Y procent."
}
]
}
Mark one or more announcements as read.
Activity name : PatchAnnouncementsByEmployerId Mark announcements as read
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/jsonrequired
array of announcements to be changed
id required | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
action required | string Value: "markAsRead" The action to perform on the announcement |
Responses
Request samples
- Payload
[- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "action": "markAsRead"
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Unread announcements per employer.
Activity name : GetAnnouncementsSummaryByBearerToken Get a list of employers with for each employer the number of unread announcements.
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "numberOfUnreadUnexpiredAnnouncements": 12
}
]
}
Mark multiple announcements as read.
Activity name : PatchAnnouncementsByBearerToken Mark announcements as read in a collective process
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/jsonrequired
array of announcements to be changed
id required | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
Responses
Request samples
- Payload
[- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
Details of a single announcement
Activity name : GetAnnouncementByAnnouncementId
Retrieve a single announcement by its ID for a specific employer.
path Parameters
announcementId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerName": "VST Consultancy",
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "isRead": false,
- "isExpired": false,
- "creationDate": "2018-02-05",
- "effectiveDate": "2018-02-05",
- "expirationDate": "2018-02-05",
- "subject": "Schaalverhoging",
- "description": "Schaal X krijgt een verhoging van Y procent."
}
}
MDV notifications
Activity name : PatchMdvNotificationsByPayrollAdministrationId
Mdv notifications
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employee": {
- "citizenServiceNumber": "042168588",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen",
- "gender": "M",
- "dateOfBirth": "1995-05-21"
}, - "employment": {
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "claExternalParty": 2
}, - "payrollAdministration": {
- "payrollTaxesNumber": "111111110L46"
}
}
]
}
The notification settings for the provider
Activity name : GetNotificationSettingsByProviderId
List the configuration per notification for the provider
path Parameters
providerId required | string <uuid> The unique identifier of an provider |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "notificationType": {
- "key": 3,
- "value": "Start of employment"
}, - "createNumberOfDaysBeforeEvent": 30,
- "isEnabled": true
}
]
}
Manage the Provider notification settings
Activity name : PatchProviderNotificationSettingsByProviderId
Manage the Provider notifications.
Only the changes supplied are processed. Existing records not supplied in the request body will be left unchanged. e.g. If three notifications are enabled and a patch is performed with in the body one new notification with the isEnabled
= true. The result will be 4 enabled notifications.
path Parameters
providerId required | string <uuid> The unique identifier of an provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object or null <metadata> The notification | |
createNumberOfDaysBeforeEvent | integer <int32> [ 0 .. 99 ] The number of days that the notification is created before the event takes place. |
isEnabled | boolean Enable or disable a notification for the provider |
Responses
Request samples
- Payload
[- {
- "notificationType": {
- "key": 3
}, - "createNumberOfDaysBeforeEvent": 30,
- "isEnabled": true
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
NL: Excasso afgesplitst van netto. This entity indicates, if applicable, the bank account(s) (i.e. IBAN's) where a given amount of the net salary for this employment will be paid to.
Normally, the IBAN for the payment of net wage will be set by the PaymentInformation(SEPA) record. However, this entity allows to take a part of the net salary (a fixed amount) and set this to a different IBAN (for that part of the payment). For example, when a person wants to have part of his earnings to his regular banking account and part of his earnings to his savings account.
Get a list of payment information SEPA separate payment records
Activity name : GetPaymentInformationSepaSeparatePaymentByEmploymentId
Get a list of records that indicate, if applicable, the bank account(s) (i.e. IBAN's) where a given amount of the net salary for this employment will be paid to.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "iban": "NL52ABNA0424968264",
- "amount": 32,
- "nameBeneficiary": "Ben Hur",
- "cityBeneficiary": "Rome",
- "description1": "Savings to different account",
- "description2": "from net wage"
}
]
}
Create a new payment information SEPA separate payment record
Activity name : PostPaymentInformationSepaSeparatePaymentByEmploymentId
Create a new payment information SEPA separate payment record for an employment.
Metadata : Not applicable for this resource.
Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: applicationjson;version=2018-01-01required
startDate | string <date> Start date of this record NOTE : at the moment of performing a payroll run it will be checked what record is applicable for splitting from net salary at that date (based on the start- and enddate). |
endDate | string or null <date> The end date of the record |
iban | string [ 1 .. 35 ] characters International Bank Account Number (IBAN). Only IBAN without spaces are accepted. |
amount | number <double> [ 0.01 .. 99999999.99 ] ^(\d{1,8})(\.\d{1,2})?$ The amount to be split from the net salary |
nameBeneficiary | string [ 1 .. 70 ] characters Name of beneficiary |
cityBeneficiary | string or null [ 1 .. 24 ] characters City name of beneficiary |
description1 | string [ 1 .. 32 ] characters Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file. |
description2 | string or null [ 1 .. 32 ] characters Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file. |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "iban": "NL52ABNA0424968264",
- "amount": 32,
- "nameBeneficiary": "Ben Hur",
- "cityBeneficiary": "Rome",
- "description1": "Savings to different account",
- "description2": "from net wage"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "iban": "NL52ABNA0424968264",
- "amount": 32,
- "nameBeneficiary": "Ben Hur",
- "cityBeneficiary": "Rome",
- "description1": "Savings to different account",
- "description2": "from net wage"
}
}
Get the details of a payment information SEPA separate payment record
Activity name : GetPaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId
Get the detail of a payment information SEPA record. For a specific payroll component, the record indicates to which IBAN account number it should be related for the purpose of outgoing payments. This includes, but is not limited to, the payment of wages for an employment. For each payroll component there can only be one outgoing payment record per employment.
path Parameters
paymentInformationSepaSeparatePaymentId required | string <uuid> The unique identifier of the SEPA payment record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "iban": "NL52ABNA0424968264",
- "amount": 32,
- "nameBeneficiary": "Ben Hur",
- "cityBeneficiary": "Rome",
- "description1": "Savings to different account",
- "description2": "from net wage"
}
}
Edit the details of a payment information separate payment record
Activity name : PutPaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId
Edit an existing separate payment-record (for an employment). For each unique payroll component there can only be one payment record per employment.
Metadata : Not applicable for this resource.
path Parameters
paymentInformationSepaSeparatePaymentId required | string <uuid> The unique identifier of the SEPA payment record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
startDate | string <date> Start date of this record NOTE : at the moment of performing a payroll run it will be checked what record is applicable for splitting from net salary at that date (based on the start- and enddate). |
endDate | string or null <date> The end date of the record |
iban | string [ 1 .. 35 ] characters International Bank Account Number (IBAN). Only IBAN without spaces are accepted. |
amount | number <double> [ 0.01 .. 99999999.99 ] ^(\d{1,8})(\.\d{1,2})?$ The amount to be split from the net salary |
nameBeneficiary | string [ 1 .. 70 ] characters Name of beneficiary |
cityBeneficiary | string or null [ 1 .. 24 ] characters City name of beneficiary |
description1 | string [ 1 .. 32 ] characters Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file. |
description2 | string or null [ 1 .. 32 ] characters Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file. |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "iban": "NL52ABNA0424968264",
- "amount": 32,
- "nameBeneficiary": "Ben Hur",
- "cityBeneficiary": "Rome",
- "description1": "Savings to different account",
- "description2": "from net wage"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "iban": "NL52ABNA0424968264",
- "amount": 32,
- "nameBeneficiary": "Ben Hur",
- "cityBeneficiary": "Rome",
- "description1": "Savings to different account",
- "description2": "from net wage"
}
}
Delete a payment information SEPA separate payment record
Activity name : DeletePaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId
Delete an existing SEPA payment-record (for an employment)
path Parameters
paymentInformationSepaSeparatePaymentId required | string <uuid> The unique identifier of the SEPA payment record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
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.
Get a list of payment information non-SEPA
Activity name : GetPaymentInformationNonSepaByEmploymentId
Get a list of payment information for non-SEPA bank accounts for an employment. These are payments to be performed that will NOT be based on an IBAN (which is the standard), so this is mostly useful for foreign payments that are not based within a SEPA-country.
For a specific payroll component, the record indicates to which account payments will be made. This includes, but is not limited to, the payment of wages for an employment.
For each payroll component there can only be one payment Information record per employment.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollComponent": {
- "key": 260,
- "value": "NETTOLOON"
}, - "bankAccountNumber": "0403830171874018",
- "beneficiary": {
- "name": "Ben Hur",
- "city": "Rome",
- "address": "Via Roma 3",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "bank": {
- "bankIdentifierCode": "AUDFDE21",
- "name": "Ben Hur",
- "city": "Rome",
- "address": "Via Roma 3",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}
}
]
}
Create a new payment information non-SEPA record
Activity name : PostPaymentInformationNonSepaByEmploymentId
Create a new payment information non-SEPA record for an employment. For each unique payroll component there can only be one payment information non-SEPA record per employment.
Metadata : Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the URL
Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: applicationjson;version=2018-01-01required
Payment information non-SEPA record to add to the employment
object <metaData> The payroll component for which the outgoing payment records applies. Each payroll component can only be used once per employment.
| |
bankAccountNumber | string [ 1 .. 34 ] characters The bank account number |
object Information regarding the beneficiary coresponding with the bank account number | |
object Information regarding the bank coresponding with the bank account number |
Responses
Request samples
- Payload
{- "payrollComponent": {
- "key": 260
}, - "bankAccountNumber": "0403830171874018",
- "beneficiary": {
- "name": "Ben Hur",
- "city": "Rome",
- "address": "Via Roma 3",
- "country": {
- "key": 1
}
}, - "bank": {
- "bankIdentifierCode": "AUDFDE21",
- "name": "Ben Hur",
- "city": "Rome",
- "address": "Via Roma 3",
- "country": {
- "key": 1
}
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollComponent": {
- "key": 260,
- "value": "NETTOLOON"
}, - "bankAccountNumber": "0403830171874018",
- "beneficiary": {
- "name": "Ben Hur",
- "city": "Rome",
- "address": "Via Roma 3",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "bank": {
- "bankIdentifierCode": "AUDFDE21",
- "name": "Ben Hur",
- "city": "Rome",
- "address": "Via Roma 3",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}
}
}
Get the details of a payment information non-SEPA
Activity name : GetPaymentInformationNonSepaByPaymentInformationNonSepaId
Get the detail of a payment information non-SEPA record. For a specific payroll component, the record indicates to which IBAN account number it should be related for the purpose of outgoing payments. This includes, but is not limited to, the payment of wages for an employment. For each payroll component there can only be one outgoing payment record per employment.
path Parameters
paymentInformationNonSepaId required | string <uuid> The unique identifier of the SEPA payment record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollComponent": {
- "key": 260,
- "value": "NETTOLOON"
}, - "bankAccountNumber": "0403830171874018",
- "beneficiary": {
- "name": "Ben Hur",
- "city": "Rome",
- "address": "Via Roma 3",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "bank": {
- "bankIdentifierCode": "AUDFDE21",
- "name": "Ben Hur",
- "city": "Rome",
- "address": "Via Roma 3",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}
}
}
Change the details of a payment information non-SEPA
Activity name : PutPaymentInformationNonSepaByPaymentInformationNonSepaId
Edit an existing payment information non-SEPA record (for an employment). For each unique payroll component there can only be one payment record per employment.
Metadata : Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the URL
path Parameters
paymentInformationNonSepaId required | string <uuid> The unique identifier of the SEPA payment record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object <metaData> The payroll component for which the outgoing payment records applies. Each payroll component can only be used once per employment.
| |
bankAccountNumber | string [ 1 .. 34 ] characters The bank account number |
object Information regarding the beneficiary coresponding with the bank account number | |
object Information regarding the bank coresponding with the bank account number |
Responses
Request samples
- Payload
{- "payrollComponent": {
- "key": 260
}, - "bankAccountNumber": "0403830171874018",
- "beneficiary": {
- "name": "Ben Hur",
- "city": "Rome",
- "address": "Via Roma 3",
- "country": {
- "key": 1
}
}, - "bank": {
- "bankIdentifierCode": "AUDFDE21",
- "name": "Ben Hur",
- "city": "Rome",
- "address": "Via Roma 3",
- "country": {
- "key": 1
}
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollComponent": {
- "key": 260,
- "value": "NETTOLOON"
}, - "bankAccountNumber": "0403830171874018",
- "beneficiary": {
- "name": "Ben Hur",
- "city": "Rome",
- "address": "Via Roma 3",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}, - "bank": {
- "bankIdentifierCode": "AUDFDE21",
- "name": "Ben Hur",
- "city": "Rome",
- "address": "Via Roma 3",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}
}
}
}
Delete a payment information non-SEPA record
Activity name : DeletePaymentInformationNonSepaByPaymentInformationNonSepaId
Delete a payment information non-SEPA record (for an employment)
path Parameters
paymentInformationNonSepaId required | string <uuid> The unique identifier of the SEPA payment record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
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.
Get a list of attachment of earnings records
Activity name : GetAttachmentOfEarningsByEmploymentId
Get a list of attachment of earnings records
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "descriptionPayslip": "payment to creditor x",
- "creditor": {
- "type": {
- "key": 1,
- "value": "Preferente schuldeiser"
}, - "priority": 0
}, - "totalAmount": {
- "owed": 320,
- "paid": {
- "inApprovedPayrollRuns": 50,
- "inOpenPayrollRun": 0
}
}, - "fixedPaymentPerPayrollPeriod": 50,
- "iban": "NL52ABNA0424968264",
- "beneficiary": {
- "name": "Ben Hur",
- "city": "Rome"
}, - "description1": "Savings to different account",
- "description2": "from net wage"
}
]
}
Create a new attachment of earnings record
Activity name : PostAttachmentOfEarningsByEmploymentId
Create a new attachment of earnings record for an employment.
Metadata : Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the URL
Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: applicationjson;version=2018-01-01required
startDate | string <date> Start date of this record |
endDate | string or null <date> The end date of the record |
descriptionPayslip | string [ 1 .. 14 ] characters This value is shown on the payslip to identify the attachment. |
object Information regarding the creditor | |
object | |
fixedPaymentPerPayrollPeriod | number or null <double> [ 0.01 .. 99999999.99 ] ^(\d{1,8})(\.\d{1,2})?$ Set a fixed sum to be payed every payroll period. Note: If left empty the "available" earnings will be calculated in the payroll run by subtracting the protected earnings threshold (beslagvrijevoet) from the netwage. This method can lead to variable payments per payroll period. |
iban | string [ 1 .. 35 ] characters International Bank Account Number (IBAN). Only IBAN without spaces are accepted. |
object Information regarding the beneficiary coresponding with the bank account number | |
description1 | string [ 1 .. 32 ] characters Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file. |
description2 | string or null [ 1 .. 32 ] characters Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file. |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "descriptionPayslip": "payment to creditor x",
- "creditor": {
- "type": {
- "key": 1
}, - "priority": 0
}, - "totalAmount": {
- "owed": 320
}, - "fixedPaymentPerPayrollPeriod": 50,
- "iban": "NL52ABNA0424968264",
- "beneficiary": {
- "name": "Ben Hur",
- "city": "Rome"
}, - "description1": "Savings to different account",
- "description2": "from net wage"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "descriptionPayslip": "payment to creditor x",
- "creditor": {
- "type": {
- "key": 1,
- "value": "Preferente schuldeiser"
}, - "priority": 0
}, - "totalAmount": {
- "owed": 320,
- "paid": {
- "inApprovedPayrollRuns": 50,
- "inOpenPayrollRun": 0
}
}, - "fixedPaymentPerPayrollPeriod": 50,
- "iban": "NL52ABNA0424968264",
- "beneficiary": {
- "name": "Ben Hur",
- "city": "Rome"
}, - "description1": "Savings to different account",
- "description2": "from net wage"
}
}
Get the details of an attachment of earnings record
Activity name : GetAttachmentOfEarningsByAttachmentOfEarningsId
Get the details of an attachment of earnings record
path Parameters
attachmentOfEarningsId required | string <uuid> The unique identifier of a record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "descriptionPayslip": "payment to creditor x",
- "creditor": {
- "type": {
- "key": 1,
- "value": "Preferente schuldeiser"
}, - "priority": 0
}, - "totalAmount": {
- "owed": 320,
- "paid": {
- "inApprovedPayrollRuns": 50,
- "inOpenPayrollRun": 0
}
}, - "fixedPaymentPerPayrollPeriod": 50,
- "iban": "NL52ABNA0424968264",
- "beneficiary": {
- "name": "Ben Hur",
- "city": "Rome"
}, - "description1": "Savings to different account",
- "description2": "from net wage"
}
}
Edit the details of an attachment of earnings record
Activity name : PutAttachmentOfEarningsByAttachmentOfEarningsId
Update the details of a single attachment of earnings record
Metadata : Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the URL
path Parameters
attachmentOfEarningsId required | string <uuid> The unique identifier of a record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
startDate | string <date> Start date of this record |
endDate | string or null <date> The end date of the record |
descriptionPayslip | string [ 1 .. 14 ] characters This value is shown on the payslip to identify the attachment. |
object Information regarding the creditor | |
object | |
fixedPaymentPerPayrollPeriod | number or null <double> [ 0.01 .. 99999999.99 ] ^(\d{1,8})(\.\d{1,2})?$ Set a fixed sum to be payed every payroll period. Note: If left empty the "available" earnings will be calculated in the payroll run by subtracting the protected earnings threshold (beslagvrijevoet) from the netwage. This method can lead to variable payments per payroll period. |
iban | string [ 1 .. 35 ] characters International Bank Account Number (IBAN). Only IBAN without spaces are accepted. |
object Information regarding the beneficiary coresponding with the bank account number | |
description1 | string [ 1 .. 32 ] characters Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file. |
description2 | string or null [ 1 .. 32 ] characters Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file. |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "descriptionPayslip": "payment to creditor x",
- "creditor": {
- "type": {
- "key": 1
}, - "priority": 0
}, - "totalAmount": {
- "owed": 320
}, - "fixedPaymentPerPayrollPeriod": 50,
- "iban": "NL52ABNA0424968264",
- "beneficiary": {
- "name": "Ben Hur",
- "city": "Rome"
}, - "description1": "Savings to different account",
- "description2": "from net wage"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "descriptionPayslip": "payment to creditor x",
- "creditor": {
- "type": {
- "key": 1,
- "value": "Preferente schuldeiser"
}, - "priority": 0
}, - "totalAmount": {
- "owed": 320,
- "paid": {
- "inApprovedPayrollRuns": 50,
- "inOpenPayrollRun": 0
}
}, - "fixedPaymentPerPayrollPeriod": 50,
- "iban": "NL52ABNA0424968264",
- "beneficiary": {
- "name": "Ben Hur",
- "city": "Rome"
}, - "description1": "Savings to different account",
- "description2": "from net wage"
}
}
Delete an attachment of earnings record
Activity name : DeleteAttachmentOfEarningsByAttachmentOfEarningsId
Delete an existing attachment of earnings record
path Parameters
attachmentOfEarningsId required | string <uuid> The unique identifier of a record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
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.
Get a list of protected earnings records
Activity name : GetProtectedEarningsByEmploymentId
Get a list of protected earnings records
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "threshold": 50
}
]
}
Create a new protected earnings record
Activity name : PostProtectedEarningsByEmploymentId
Create a new protected earnings record for an employment.
Metadata : There is no metadata for this resource
Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: applicationjson;version=2018-01-01required
startDate | string <date> Start date of this record A (broken chain)[./#section/Data/Date-chains] is maintained within this resource. NOTE : at the moment of performing a payroll run it will be checked what record is applicable for protected earning (based on the start- and enddate, not based on the payroll period of the payroll run). |
endDate | string or null <date> The end date of the record |
threshold | number <double> [ 0 .. 99999999.99 ] ^(\d{1,8})(\.\d{1,2})?$ The total amount of net wage that is protected. |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "threshold": 50
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "threshold": 50
}
}
Get the details of an protected earnings record
Activity name : GetProtectedEarningsByProtectedEarningsId
Get the details of an protected earnings record
path Parameters
protectedEarningsId required | string <uuid> The unique identifier of a record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "threshold": 50
}
}
Edit the details of an protected earnings record
Activity name : PutProtectedEarningsByProtectedEarningsId
Update the details of a single protected earnings record
Metadata : There is no metadata for this resource
path Parameters
protectedEarningsId required | string <uuid> The unique identifier of a record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
startDate | string <date> Start date of this record A (broken chain)[./#section/Data/Date-chains] is maintained within this resource. NOTE : at the moment of performing a payroll run it will be checked what record is applicable for protected earning (based on the start- and enddate, not based on the payroll period of the payroll run). |
endDate | string or null <date> The end date of the record |
threshold | number <double> [ 0 .. 99999999.99 ] ^(\d{1,8})(\.\d{1,2})?$ The total amount of net wage that is protected. |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "threshold": 50
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "threshold": 50
}
}
Delete an protected earnings record
Activity name : DeleteProtectedEarningsByProtectedEarningsId
Delete an existing protected earnings record
path Parameters
protectedEarningsId required | string <uuid> The unique identifier of a record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
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.
Get a list of payment information sepa
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.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollComponent": {
- "key": 260,
- "value": "NETTOLOON"
}, - "iban": "NL52ABNA0424968264",
- "bic": "AUDFDE21",
- "visibleOnPayslip": true,
- "nameBeneficiary": "Ben Hur",
- "cityBeneficiary": "Rome",
- "description1": "xx",
- "description2": "x"
}
]
}
create a new payment information sepa record
Activity name : PostPaymentInformationSepaByEmploymentId
Create a new Payment information SEPA record for an employment.
For each unique payroll component there can only be one payment record per employment.
Metadata : Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the URL
Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: required
Payment information sepa record to add to the employment
object <metaData> The payroll component for which the outgoing payment records applies.
| |
iban | string [ 1 .. 35 ] characters International Bank Account Number (IBAN). Only IBAN without spaces are accepted. |
bic | string or null [ 1 .. 11 ] characters BIC /SWIFT code. Only applicable for a non-Dutch IBAN |
visibleOnPayslip | boolean Indicates whether the payment-component is visible on a payslip. |
nameBeneficiary | string or null [ 1 .. 70 ] characters Name of beneficiary. |
cityBeneficiary | string or null [ 1 .. 24 ] characters City name of beneficiary. |
description1 | string or null [ 1 .. 32 ] characters Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file. |
description2 | string or null [ 1 .. 32 ] characters Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file. |
Responses
Request samples
- Payload
{- "payrollComponent": {
- "key": 260
}, - "iban": "NL52ABNA0424968264",
- "bic": "AUDFDE21",
- "visibleOnPayslip": true,
- "nameBeneficiary": "Ben Hur",
- "cityBeneficiary": "Rome",
- "description1": "xx",
- "description2": "x"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollComponent": {
- "key": 260,
- "value": "NETTOLOON"
}, - "iban": "NL52ABNA0424968264",
- "bic": "AUDFDE21",
- "visibleOnPayslip": true,
- "nameBeneficiary": "Ben Hur",
- "cityBeneficiary": "Rome",
- "description1": "xx",
- "description2": "x"
}
}
Get the details of a payment information sepa
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.
path Parameters
paymentInformationSepaId required | string <uuid> The unique identifier of the SEPA payment record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollComponent": {
- "key": 260,
- "value": "NETTOLOON"
}, - "iban": "NL52ABNA0424968264",
- "bic": "AUDFDE21",
- "visibleOnPayslip": true,
- "nameBeneficiary": "Ben Hur",
- "cityBeneficiary": "Rome",
- "description1": "xx",
- "description2": "x"
}
}
change the details of a payment information sepa
Activity name : PutPaymentInformationSepaByPaymentInformationSepaId
Edit an existing SEPA payment-record (for an employment).
For each unique payroll component there can only be one payment record per employment.
Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the URL
path Parameters
paymentInformationSepaId required | string <uuid> The unique identifier of the SEPA payment record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: required
SEPA payment record to edit
object <metaData> The payroll component for which the outgoing payment records applies.
| |
iban | string [ 1 .. 35 ] characters International Bank Account Number (IBAN). Only IBAN without spaces are accepted. |
bic | string or null [ 1 .. 11 ] characters BIC /SWIFT code. Only applicable for a non-Dutch IBAN |
visibleOnPayslip | boolean Indicates whether the payment-component is visible on a payslip. |
nameBeneficiary | string or null [ 1 .. 70 ] characters Name of beneficiary. |
cityBeneficiary | string or null [ 1 .. 24 ] characters City name of beneficiary. |
description1 | string or null [ 1 .. 32 ] characters Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file. |
description2 | string or null [ 1 .. 32 ] characters Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file. |
Responses
Request samples
- Payload
{- "payrollComponent": {
- "key": 260
}, - "iban": "NL52ABNA0424968264",
- "bic": "AUDFDE21",
- "visibleOnPayslip": true,
- "nameBeneficiary": "Ben Hur",
- "cityBeneficiary": "Rome",
- "description1": "xx",
- "description2": "x"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollComponent": {
- "key": 260,
- "value": "NETTOLOON"
}, - "iban": "NL52ABNA0424968264",
- "bic": "AUDFDE21",
- "visibleOnPayslip": true,
- "nameBeneficiary": "Ben Hur",
- "cityBeneficiary": "Rome",
- "description1": "xx",
- "description2": "x"
}
}
Delete a specific SEPA payment-record record
Activity name : DeletePaymentInformationSepaByPaymentInformationSepaId
Delete an existing SEPA payment-record (for an employment)
path Parameters
paymentInformationSepaId required | string <uuid> The unique identifier of the SEPA payment record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of payroll runs for an administration
Activity name : GetPayrollRunsByPayrollAdministrationId
A list of payroll runs for an administration
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriod": {
- "year": 2023,
- "periodNumber": 2
}, - "payrollRunStatus": {
- "key": 9,
- "value": "Verloning goedgekeurd."
}, - "textPaySlip": "string",
- "textPayment": "string",
- "requestTime": "2018-05-08T15:16:49+02:00",
- "processingFinishedTime": "2018-05-08T15:16:49+02:00",
- "approvalTime": "2018-05-08T15:16:49+02:00",
- "sequenceNumber": 1,
- "textTariffPaySlip": "string",
- "availableForEmployeeDate": "2018-05-08",
- "sendEmailToEmployee": true,
- "requestedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "approvedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "sequenceNumberApproved": 0,
- "removeTime": "2018-05-08T15:16:49+02:00",
- "removedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "methodOfCreation": {
- "key": 2,
- "value": "Individueel"
}, - "errorsAndWarnings": {
- "hasErrors": true,
- "hasWarnings": true
}, - "payrollTaxReturnPeriod": {
- "year": 2023,
- "periodNumber": 2
}
}
]
}
Details of a payrollrun
Activity name : GetPayrollRunByPayrollRunId
Get the details of a single payrollrun
path Parameters
payrollrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriod": {
- "year": 2023,
- "periodNumber": 2
}, - "payrollRunStatus": {
- "key": 9,
- "value": "Verloning goedgekeurd."
}, - "textPaySlip": "string",
- "textPayment": "string",
- "requestTime": "2018-05-08T15:16:49+02:00",
- "processingFinishedTime": "2018-05-08T15:16:49+02:00",
- "approvalTime": "2018-05-08T15:16:49+02:00",
- "sequenceNumber": 1,
- "textTariffPaySlip": "string",
- "availableForEmployeeDate": "2018-05-08",
- "sendEmailToEmployee": true,
- "requestedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "approvedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "sequenceNumberApproved": 0,
- "removeTime": "2018-05-08T15:16:49+02:00",
- "removedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "methodOfCreation": {
- "key": 2,
- "value": "Individueel"
}, - "errorsAndWarnings": {
- "hasErrors": true,
- "hasWarnings": true
}, - "payrollTaxReturnPeriod": {
- "year": 2023,
- "periodNumber": 2
}
}
}
Change the availableForEmployee data
Activity name : PatchPayrollRunByPayrollRunId
Allows the user to change the availableForEmployeeDate
and sendEmailToEmployee
fields
path Parameters
payrollrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2020-03-16required
The request body
availableForEmployeeDate | string or null <date> The date on which the pay slips will be available to employees. |
sendEmailToEmployee | boolean or null Indicates whether an email should be sent to the employees when the pay slip is available to them. NULL will be seen as false |
Responses
Request samples
- Payload
{- "availableForEmployeeDate": "2018-05-08",
- "sendEmailToEmployee": true
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriod": {
- "year": 2023,
- "periodNumber": 2
}, - "payrollRunStatus": {
- "key": 9,
- "value": "Verloning goedgekeurd."
}, - "textPaySlip": "string",
- "textPayment": "string",
- "requestTime": "2018-05-08T15:16:49+02:00",
- "processingFinishedTime": "2018-05-08T15:16:49+02:00",
- "approvalTime": "2018-05-08T15:16:49+02:00",
- "sequenceNumber": 1,
- "textTariffPaySlip": "string",
- "availableForEmployeeDate": "2018-05-08",
- "sendEmailToEmployee": true,
- "requestedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "approvedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "sequenceNumberApproved": 0,
- "removeTime": "2018-05-08T15:16:49+02:00",
- "removedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "methodOfCreation": {
- "key": 2,
- "value": "Individueel"
}, - "errorsAndWarnings": {
- "hasErrors": true,
- "hasWarnings": true
}, - "payrollTaxReturnPeriod": {
- "year": 2023,
- "periodNumber": 2
}
}
}
NL: Verloningsrun downloads. Download payroll runs related output (payslip, wage sheets etc)
Download payslips for a payroll run
Activity name : GetPayslipsByPayrollRunId
Availability: This is endpoint is available for the Loket.nl application only. It is not available for external parties
Returns the payslips for a payroll run as a PDF file. By default the payslips are sorted by employeeNumber
.
path Parameters
payrollrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download the default set of downloads for a payroll run
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.
path Parameters
payrollrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download payment overviews for a payroll run
Activity name : GetPaymentOverviewsByPayrollRunId
Returns payment overviews for a payroll run as a PDF file. By default the payment overview 1 is returned.
path Parameters
payrollrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download wage sheets for a payroll run
Activity name : GetWageSheetsByPayrollRunId
Returns the wage sheets for a payroll run as a PDF file or XLSX file. By default the wage sheets contain information on both the employer and the employees.
path Parameters
payrollrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Get a list of SEPA files for a payroll run
Activity name : GetSepaFilesByPayrollRunId
Returns the SEPA file(s) for the specified payroll run.
path Parameters
payrollrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
[- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "SALARISBETALING PERIODE 9"
}
]
Get a list of SEPA hashes for a payroll run
Activity name : GetSepaHashesByPayrollRunId
Returns 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.
path Parameters
payrollrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
[- {
- "sepaFileDescription": "SALARISBETALING PERIODE 9",
- "hash": "cd2feea250047d4477a0276f864e9c223af66a73c305f872c31dc0cdfb709b1f"
}
]
Download a SEPA file
Activity name : GetSepaFileBySepaFileId
Returns the specified SEPA payments file as a XML file.
path Parameters
sepafileId required | string <uuid> Sepa file ID |
query Parameters
paymentType | string Default: "Salary" Enum: "Other" "Salary" Indicates the type of payment for the SEPA file. In case salary is selected the following will be included in the SEPA xml file
|
batchBooking | string Default: "BtchBookgExclude" Enum: "BtchBookgExclude" "BtchBookgTrue" "BtchBookgFalse" Determines whether the Batch Booking <BtchBookg> tag is included in the SEPA file and if it is which value it is set to. By defualt this value is set to Exclude. Possible values for this parameter are:
|
requestedExecutionDate required | string <date> This value is used when creating the (non) sepa file to set the value of <ReqdExctnDt> |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download a total SEPA file
Activity name : GetTotalSepaFileByPayrollRunId
Returns the total SEPA payments file as a XML file. This file contains the payments of all the available SEPA payment files available for the specified payroll run.
path Parameters
payrollrunId required | string <uuid> The unique identifier of the payroll run |
query Parameters
paymentType | string Default: "Salary" Enum: "Other" "Salary" Indicates the type of payment for the SEPA file. In case salary is selected the following will be included in the SEPA xml file
|
batchBooking | string Default: "BtchBookgExclude" Enum: "BtchBookgExclude" "BtchBookgTrue" "BtchBookgFalse" Determines whether the Batch Booking <BtchBookg> tag is included in the SEPA file and if it is which value it is set to. By defualt this value is set to Exclude. Possible values for this parameter are:
|
requestedExecutionDate required | string <date> This value is used when creating the (non) sepa file to set the value of <ReqdExctnDt> |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download run overviews for a payroll run
Activity name : GetRunOverviewsByPayrollRunId
Returns run overviews for a payroll run as a PDF file.
path Parameters
payrollrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download payroll control register for a payroll run
Activity name : GetPayrollControlRegisterByPayrollRunId
Returns payroll control register for a payroll run as a PDF file.
path Parameters
payrollrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download the journal entries by distribution Unit.
Activity name : GetJournalEntriesPerDistributionUnitOverviewsByPayrollRunId
Returns the journal entries by distribution Unit for a payroll run as a PDF file.
path Parameters
payrollrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download errors and warnings for a payroll run
Activity name : GetErrorsAndWarningsByPayrollRunId
Returns an overview of errors and warnings that occurred during the payroll run as a PDF file.
path Parameters
payrollrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download a Non Sepa file
Activity name : GetNonSepaFileByPayrollRunId
Returns the Non Sepa payments file as a XML file. Contains all Non Sepa payments for the specified payroll run.
path Parameters
payrollrunId required | string <uuid> The unique identifier of the payroll run |
query Parameters
paymentReason | string Reason for the payment, eg Salary. Appears in the tag <RmtInf> if provided. |
requestedExecutionDate required | string <date> This value is used when creating the (non) sepa file to set the value of <ReqdExctnDt> |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Get payroll run balance sheet
Activity name : GetPayrollRunBalanceSheetByPayrollRunId
This endpoint returns per payroll components, marked as relevant for the general ledge (balance sheet), the sum of the values.
If for the given payroll period of the payroll run a "journal profile" is configured the endpoint also returns the ledger account and costcenter/costunit linked to the given payroll component in the "journal profile"
path Parameters
payrollrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "payrollComponent": {
- "key": 70,
- "description": "Wage",
- "balanceSheetSide": {
- "key": 1,
- "value": "Credit"
}
}, - "journalAllocation": [
- {
- "generalLedgerAccount": {
- "key": 1,
- "generalLedgerAccountnumber": 4001,
- "value": "Wages"
}, - "costCenter": {
- "key": 1,
- "value": "Sales",
- "code": "SAL"
}, - "costUnit": {
- "key": 1,
- "value": "International",
- "code": "INT"
}
}
], - "value": 40457.01
}
]
}
Get results for a payroll run
Activity name : GetPayrollRunResultsByPayrollRunId
Returns the results for the payroll run
path Parameters
payrollrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriods": [
- {
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31",
- "testYear": false
}, - "payslipTypes": [
- {
- "payslipType": {
- "key": 1,
- "value": "Normaal strook"
}, - "payrollComponentResults": [
- {
- "payrollComponent": {
- "key": null,
- "value": null,
- "category": { },
- "column": { },
- "costsEmployer": { }
}, - "value": 40,
- "valueSpecialTariff": 144
}
]
}
]
}
]
}
]
}
Send an email to inform the salary administrator
Activity name : PostPeriodReadyForPayrollByPayrollAdministrationId
Send an email to inform that the period is ready for payrolling.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Report period ready for payroll
payrollPeriodId | integer <int32> The id for this specific payroll period. |
emailAddressPeriodReadyForPayroll | Array of strings [ 1 .. 10 ] items [ items <= 255 characters ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\... ] The email address(es) of the recipient(s) |
userComment | string or null <= 1000 characters A personal message from the sender. |
Responses
Request samples
- Payload
{- "payrollPeriodId": 202101,
- "userComment": "All mutations are done."
}
Response samples
- 202
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of payslips for an employment
Activity name : GetPayslipsByEmploymentId
Availability: This is endpoint is available for the Loket.nl application only. It is not available for external parties
Get a list of payslips for the specified employment, including the GUID of the corresponding payroll run.
The function of this endpoint is dependent on the role of the user;
- For users with the role of 'werknemer'; The endpoint only returns results for payrollruns that have the status 'approved' AND for which results of the payroll are available for ESS (based on the ESS-date of the payrollrun) .
- For users with any other role (in most cases); the endpoin returns results for approved payrollruns irregardless of the ESS date.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "payrollrunId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31",
- "testYear": false
}, - "numberOfPayslips": 1,
- "approvalTime": "2018-05-08T15:16:49+02:00"
}
]
}
Download payslips for an employment and year
Activity name : GetPayslipsByEmploymentIdAndYear
Availability: This is endpoint is available for the Loket.nl application only. It is not available for external parties
Download the payslips for a payroll year in a single PDF
Metadata : Possible options for year
can be acquired (GET) the following URL /providers/employers/employees/employments/{employmentId}/payslips/metadata.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
year required | integer <int32> <= 4 characters Example: 2018 The payroll year |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Download payslips of an employment for a payrollrun
Activity name : GetPayslipsByEmploymentIdAndPayrollRunId
Availability: This is endpoint is available for the Loket.nl application only. It is not available for external parties
Download the payslips or its underlying payroll results of an employment for the specified payrollrun
Please note: this endpoint has two types of output:
- the payslip(s) as a single PDF-file
- the underlying payroll result data for the payslip(s) in JSON-format
This may be specified by providing the desired format in the Accept
header of your request.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
payrollrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
Get payroll period results of an employment for a year
Activity name : GetPayrollPeriodResultsByEmploymentIdAndYear
Download the payroll results (conform overzicht strook) of an employment per payroll period for the provided year.
Please note the following: There is a major functional difference between acquiring the payslips per payroll run or acquiring payroll results per payroll period(in this case a year). In Loket, for each (approved) run there will be payroll results for that run. Each employment with any results in that payroll run will have (one or more) payslips, these are the payroll results/ payslips for that run. Often these results relate to the payroll period for which that payroll run is performed, but the results may apply to other payroll periods. For example: the payroll run for March may contain results that apply to the months January and/or February. (this may occur within a specific year)
- Requesting payslips/results per RUN will provide you all payroll results from that specific payrollrun regardless of the period it applies to.
- Requesting PERIOD results will provide you all (approved) payroll results for that period regardless of the payroll run it comes from.
De facto the payslips/results per RUN are your actual payslips (loonstrook). The results per period are more useful as an overview per period (overzichtstrook).
One more remark: the response of this endpoint is dependent on the role of the user. If the user has role 'werknemer' than the results shown are only based on those approved payroll runs where the ESS-date is on or before today. For other users the results will contain data from all approved payroll runs regardless of ESS-date.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
year required | integer <int32> <= 4 characters Example: 2018 The payroll year |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriods": [
- {
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31",
- "testYear": false
}, - "payslipTypes": [
- {
- "payslipType": {
- "key": 1,
- "value": "Normaal strook"
}, - "payrollComponentResults": [
- {
- "payrollComponent": {
- "key": 1,
- "value": "Uren gewerkt",
- "category": {
- "key": null,
- "value": null
}, - "column": {
- "key": null,
- "value": null
}, - "costsEmployer": {
- "key": null,
- "value": null
}, - "hoursIndication": true,
- "countAsNormHours": true
}, - "value": 40,
- "valueSpecialTariff": 144
}
]
}
]
}
]
}
}
Download a cummulative payslip for a single payroll period
Activity name : GetPayrollPeriodSummaryByEmploymentIdAndPayrollPeriodId
Download a cummulative payslip for a single payroll period in a single PDF.
e.g. If the employment has to payslips for a single period this endpoint will return one (summary)payslip that is the cummaltion of both the payslips.
Metadata : Possible options for payrollPeriodId
can be acquired (GET) the following URL /providers/employers/employees/employments/{employmentId}/payslips/summary/metadata.
Please note that the returned payroll periods are dependend on the year filter setting for the employer. The options are, return payroll periodes for:
* current payroll year * current and previous payroll year * all payroll years
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
payrollPeriodId required | string <uuid> The unique identifier of an payroll period |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Download wage sheets for an employment
Activity name : GetWageSheetByEmploymentIdAndYear
Download the wagesheet (loonstaat) for a payroll year
Metadata : Possible options for year
can be acquired (GET) the following URL /providers/employers/employees/employments/{employmentId}/wagesheet/metadata.
Returns the wage sheets for an employment
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
year required | integer <int32> <= 4 characters Example: 2018 The payroll year |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Year-end statements for the employment
Activity name : GetYearEndStatementsByEmploymentId
Get a list of year-end statements (i.e. list of years for which year-end statements are available) for an employment
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "year": 2018
}
]
}
Download year-end statement of an employment for a year
Activity name : GetYearEndStatementForYearByEmploymentId
Availability: This is endpoint is available for the Loket.nl application only. It is not available for external parties
Download the year-end statement of an employment for a year.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
year required | integer <int32> <= 4 characters Example: 2018 The payroll year |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Overview of the data used in a payroll simulation
Activity name : GetPayrollSimulatorDataByEmploymentId
Get an overview of the data used in a payroll simulation
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "wage": {
- "currentWage": 2300,
- "type": {
- "key": 2,
- "value": "hourly"
}, - "class": "Basisloon"
}, - "payrollPeriodType": {
- "key": 2,
- "value": "month"
}, - "workingHours": {
- "currentHoursPerWeek": 41,
- "shift": {
- "fullTimeHoursPerWeek": 40
}
}, - "startDateDeviations": "2022-08-01"
}
}
NL: Salarisverwerkende administratie. Manage a payroll administration. A Payroll administration is the link to the payrolling configuration
List of payroll administrations for an employer
Activity name : GetPayrollAdministrationsByEmployerId
Get a list of all payroll administrations for an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC administration",
- "shortName": "ABC adm",
- "administrationNumber": "ABC",
- "clientNumber": 1234,
- "description": "Bakker",
- "startDate": "2016-01-01",
- "endDate": "2020-12-31",
- "cao": {
- "key": 184,
- "value": "Agriculture"
}, - "loonmodel": {
- "key": 184,
- "value": "Foresting monthly payrolling"
}, - "groupClassification": {
- "key": 3,
- "value": "South"
}, - "groupCode": 40,
- "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}, - "province": {
- "key": 1,
- "value": "Noord-Holland"
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}, - "poBox": 5000
}, - "contact": {
- "name": "Henk de Vries",
- "phoneNumber": "013-12345678"
}, - "payrollPeriodType": {
- "key": 2,
- "value": "month"
}, - "payrollTaxesNumber": "111111110L46",
- "claTaxReturnCBSCode": 1896,
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
]
}
Add a payroll administration
Activity name : PostPayrollAdministrationByEmployerId
Add a payroll administration.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Payroll administration
object <metadata> (wageModelPost) The "loonmodel" (this is a loket.nl term) the payroll administration inherits the payrolling configuration from. Deviating from the loonmodel configuration on payrol administration level is possible.
| |
administrationNumber | string or null (administrationNumber) <= 15 characters The administration number is a free field commonly used to register the debtors number. |
groupCode | integer <int32> (groupCode) Number (integer) used for grouping administrations. |
name | string (name) <= 70 characters Name of the administration |
shortName | string or null (shortName) <= 12 characters Shortened name of the administration |
description | string (description) <= 50 characters Description of the administration |
withholdingParty | string or null (withholdingParty) <= 200 characters Deviating name of the administration for the payroll tax return |
object or null <metadata> (groupClassification) The group classification for the payroll administration. This field is used for filtering and grouping within the interface.
| |
payrollYear | integer <int32> (payrollYear) The first year the payroll administration is active. |
isInternalPayrollAdministration | boolean (isInternalPayrollAdministration) Indicates if the payroll administration is used for internal payroll purposes. |
testYear | boolean (testYear) Indicates if the firstPayrollYear for the payroll administration is a test year. |
object (synchronize) | |
object (address) | |
object or null (deviatingPostalAddress) | |
object or null (contact) | |
payrollTaxesNumber | string or null (payrollTaxesNumber) = 12 characters The payroll tax number, loonheffingennummer, is the number that is used for the Loonaangifte for the Belastingdienst. |
object <metadata> (wageTaxTableColor) The wage tax table color of the payroll administration. | |
object <metadata> (premiumGroup) Premium group (premiegroep) of the payroll administration. | |
object <metadata> (premiumGroupUszo) Premium group uszo (premiegroep USZO) of the payroll administration. | |
object <metadata> (methodOfCreationPayrollTaxReturn) The method of creation of the payroll tax return. | |
annualPayrollTaxReturn | boolean (annualPayrollTaxReturn) Indicates if the payroll administration uses an annual payroll tax return. |
object <metadata> (payrollTaxReturnProcessedBy) The application that is responsible for the processing (approve or reject) of the payroll tax return. | |
object <metadata> (aofPremiumType) The AOF premium type of the payroll administration. | |
claTaxReturnCBSCode | integer or null <int32> (claTaxReturnCBSCode) The CBS code of the CLA (NL: CAO nummer), which is used for payroll tax return purposes. If no CLA is applicable than use the value 9999. Please note that this value might be empty (this is not recommended but it's possible). |
iban | string or null (iban) <= 35 characters IBAN |
totalSepaFile | boolean (totalSepaFile) 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. |
object (payslip) | |
object (defaults) |
Responses
Request samples
- Payload
{- "wageModel": { },
- "administrationNumber": "ABC",
- "groupCode": 40,
- "name": "ABC administration",
- "shortName": "ABC adm",
- "description": "Bakker",
- "withholdingParty": "ABC accountants",
- "groupClassification": {
- "key": 3
}, - "payrollYear": 2025,
- "isInternalPayrollAdministration": false,
- "testYear": false,
- "synchronize": {
- "contactInformation": false,
- "nameAndAddress": false
}, - "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1
}, - "postalCode": "1234AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1
}, - "province": {
- "key": 1
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1
}, - "poBox": 5000
}, - "contact": {
- "name": "Henk de Vries",
- "phoneNumber": "013-12345678"
}, - "payrollTaxesNumber": "111111110L46",
- "wageTaxTableColor": {
- "key": 2
}, - "premiumGroup": {
- "key": 1
}, - "premiumGroupUszo": {
- "key": 61
}, - "methodOfCreationPayrollTaxReturn": {
- "key": 3
}, - "annualPayrollTaxReturn": false,
- "payrollTaxReturnProcessedBy": {
- "key": 6
}, - "aofPremiumType": {
- "key": 3
}, - "claTaxReturnCBSCode": 1896,
- "iban": "NL91ABNA0417164300",
- "totalSepaFile": false,
- "payslip": {
- "template": {
- "key": 1
}, - "displaySalutation": false,
- "displaydisplayPayScale": false,
- "displayDepartment": false,
- "addressLocation": {
- "key": 1
}, - "employeeNumberDisplayMethod": {
- "key": 1
}, - "functionDisplayMethod": {
- "key": 1
}, - "hourlyWageDisplayMethod": {
- "key": 1
}, - "employmentStartDateDisplayMethod": {
- "key": 1
}, - "employeeNameDisplayMethod": {
- "key": 1
}
}, - "defaults": {
- "mdvNotification": false,
- "employmentDurationType": {
- "key": 1
}, - "typeOfEmployee": {
- "key": 1
}, - "employmentContractType": {
- "key": 1
}, - "grossWageType": {
- "key": 2
}, - "netWageType": {
- "key": 1
}, - "calculateUsingWorkPattern": {
- "hoursBrokenPeriod": false,
- "hoursRegularPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC administration",
- "shortName": "ABC adm",
- "administrationNumber": "ABC",
- "clientNumber": 1234,
- "description": "Bakker",
- "startDate": "2016-01-01",
- "endDate": "2020-12-31",
- "cao": {
- "key": 184,
- "value": "Agriculture"
}, - "loonmodel": {
- "key": 184,
- "value": "Foresting monthly payrolling"
}, - "groupClassification": {
- "key": 3,
- "value": "South"
}, - "groupCode": 40,
- "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}, - "province": {
- "key": 1,
- "value": "Noord-Holland"
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}, - "poBox": 5000
}, - "contact": {
- "name": "Henk de Vries",
- "phoneNumber": "013-12345678"
}, - "payrollPeriodType": {
- "key": 2,
- "value": "month"
}, - "payrollTaxesNumber": "111111110L46",
- "claTaxReturnCBSCode": 1896,
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
]
}
Details of a payroll administration
Activity name : GetPayrollAdministrationByPayrollAdministrationId
Get the details of a single payroll administration
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC administration",
- "shortName": "ABC adm",
- "administrationNumber": "ABC",
- "clientNumber": 1234,
- "description": "Bakker",
- "startDate": "2016-01-01",
- "endDate": "2020-12-31",
- "cao": {
- "key": 184,
- "value": "Agriculture"
}, - "loonmodel": {
- "key": 184,
- "value": "Foresting monthly payrolling"
}, - "groupClassification": {
- "key": 3,
- "value": "South"
}, - "groupCode": 40,
- "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}, - "province": {
- "key": 1,
- "value": "Noord-Holland"
}
}, - "deviatingPostalAddress": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "furtherIndication": {
- "key": 1,
- "value": "WW"
}, - "postalCode": "1234 AA",
- "location": "Fourth floor or building C",
- "country": {
- "key": 1,
- "value": "Netherlands",
- "isoCode": "NL"
}, - "poBox": 5000
}, - "contact": {
- "name": "Henk de Vries",
- "phoneNumber": "013-12345678"
}, - "payrollPeriodType": {
- "key": 2,
- "value": "month"
}, - "payrollTaxesNumber": "111111110L46",
- "claTaxReturnCBSCode": 1896,
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
List of payroll administrations configurations for an employer
Activity name : GetPayrollAdministrationConfigurationsByEmployerId
Get a list of all payroll administration configurations for an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Bakker",
- "clientNumber": 1234,
- "startDate": "2023-01-01",
- "endDate": "2025-12-31",
- "payrollPeriodType": {
- "key": 2,
- "value": "month"
}, - "holidayAllowanceBaseForCalculation": {
- "key": 1,
- "value": "Basisloon"
}, - "yearEndBaseForCalculation": {
- "key": 1,
- "value": "Basisloon"
}, - "holidayAllowancePercentage": 40,
- "yearEndPercentage": 40,
- "synchronize": {
- "contactInformation": false,
- "nameAndAddress": false
}, - "defaults": {
- "employmentDurationType": {
- "key": 1,
- "value": "Contract of indefinite duration"
}, - "typeOfEmployee": {
- "key": 1,
- "value": "Werknemer"
}, - "employmentContractType": {
- "key": 1,
- "value": "Labor agreement"
}, - "grossWageType": {
- "key": 2,
- "value": "hourly"
}, - "netWageType": {
- "key": 1,
- "value": "hourly"
}, - "mdvNotification": false,
- "calculateUsingWorkPattern": {
- "hoursBrokenPeriod": false,
- "hoursRegularPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "payslipAvailableForEmployeeDay": 20,
- "componentSet": {
- "payrollPeriodDataCollectiveCategory": {
- "key": 0,
- "value": "Uren"
}, - "payrollPeriodDataCollectiveComponentSet": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "Standaard exportset",
- "registrationLevel": "provider"
}, - "payrollPeriodDataIndividual": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "Standaard exportset",
- "registrationLevel": "provider"
}, - "payrollPeriodDataLeave": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "Standaard exportset",
- "registrationLevel": "provider"
}, - "payrollPeriodDataWerkkosten": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "Standaard exportset",
- "registrationLevel": "provider"
}, - "payrollPeriodDataEmployeeSelfService": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "Standaard exportset",
- "registrationLevel": "provider"
}
}
}
}
]
}
Details of a payroll administration configuration
Activity name : GetPayrollAdministrationConfigurationByPayrollAdministrationId
Get the details of a single payroll administration configuration
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Bakker",
- "clientNumber": 1234,
- "startDate": "2023-01-01",
- "endDate": "2025-12-31",
- "payrollPeriodType": {
- "key": 2,
- "value": "month"
}, - "holidayAllowanceBaseForCalculation": {
- "key": 1,
- "value": "Basisloon"
}, - "yearEndBaseForCalculation": {
- "key": 1,
- "value": "Basisloon"
}, - "holidayAllowancePercentage": 40,
- "yearEndPercentage": 40,
- "synchronize": {
- "contactInformation": false,
- "nameAndAddress": false
}, - "defaults": {
- "employmentDurationType": {
- "key": 1,
- "value": "Contract of indefinite duration"
}, - "typeOfEmployee": {
- "key": 1,
- "value": "Werknemer"
}, - "employmentContractType": {
- "key": 1,
- "value": "Labor agreement"
}, - "grossWageType": {
- "key": 2,
- "value": "hourly"
}, - "netWageType": {
- "key": 1,
- "value": "hourly"
}, - "mdvNotification": false,
- "calculateUsingWorkPattern": {
- "hoursBrokenPeriod": false,
- "hoursRegularPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "payslipAvailableForEmployeeDay": 20,
- "componentSet": {
- "payrollPeriodDataCollectiveCategory": {
- "key": 0,
- "value": "Uren"
}, - "payrollPeriodDataCollectiveComponentSet": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "Standaard exportset",
- "registrationLevel": "provider"
}, - "payrollPeriodDataIndividual": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "Standaard exportset",
- "registrationLevel": "provider"
}, - "payrollPeriodDataLeave": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "Standaard exportset",
- "registrationLevel": "provider"
}, - "payrollPeriodDataWerkkosten": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "Standaard exportset",
- "registrationLevel": "provider"
}, - "payrollPeriodDataEmployeeSelfService": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "Standaard exportset",
- "registrationLevel": "provider"
}
}
}
}
}
Edit a payroll administration configuration
Activity name : PutPayrollAdministrationConfigurationByPayrollAdministrationId
Edit a non payroll administration.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
description | string <= 50 characters Description of the administration |
endDate | string or null <date> The last day the administration is active. |
object <metadata> holidayAllowanceBaseForCalculation | |
object <metadata> yearEndBaseForCalculation | |
holidayAllowancePercentage | number <double> [ 0 .. 100 ] The percentage of the holidayAllowance. |
yearEndPercentage | number <double> [ 0 .. 100 ] The percentage of the year end bonus. |
object | |
object |
Responses
Request samples
- Payload
{- "description": "Bakker",
- "endDate": "2025-12-31",
- "holidayAllowanceBaseForCalculation": {
- "key": 1
}, - "yearEndBaseForCalculation": {
- "key": 1
}, - "holidayAllowancePercentage": 40,
- "yearEndPercentage": 40,
- "synchronize": {
- "contactInformation": false,
- "nameAndAddress": false
}, - "defaults": {
- "employmentDurationType": {
- "key": 1
}, - "typeOfEmployee": {
- "key": 1
}, - "employmentContractType": {
- "key": 1
}, - "grossWageType": {
- "key": 2
}, - "netWageType": {
- "key": 1
}, - "mdvNotification": false,
- "calculateUsingWorkPattern": {
- "hoursBrokenPeriod": false,
- "hoursRegularPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "payslipAvailableForEmployeeDay": 20,
- "componentSet": {
- "payrollPeriodDataCollectiveCategory": {
- "key": 0
}, - "payrollPeriodDataCollectiveComponentSet": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "payrollPeriodDataIndividual": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "payrollPeriodDataLeave": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "payrollPeriodDataWerkkosten": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "payrollPeriodDataEmployeeSelfService": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
}
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Bakker",
- "clientNumber": 1234,
- "startDate": "2023-01-01",
- "endDate": "2025-12-31",
- "payrollPeriodType": {
- "key": 2,
- "value": "month"
}, - "holidayAllowanceBaseForCalculation": {
- "key": 1,
- "value": "Basisloon"
}, - "yearEndBaseForCalculation": {
- "key": 1,
- "value": "Basisloon"
}, - "holidayAllowancePercentage": 40,
- "yearEndPercentage": 40,
- "synchronize": {
- "contactInformation": false,
- "nameAndAddress": false
}, - "defaults": {
- "employmentDurationType": {
- "key": 1,
- "value": "Contract of indefinite duration"
}, - "typeOfEmployee": {
- "key": 1,
- "value": "Werknemer"
}, - "employmentContractType": {
- "key": 1,
- "value": "Labor agreement"
}, - "grossWageType": {
- "key": 2,
- "value": "hourly"
}, - "netWageType": {
- "key": 1,
- "value": "hourly"
}, - "mdvNotification": false,
- "calculateUsingWorkPattern": {
- "hoursBrokenPeriod": false,
- "hoursRegularPeriod": false,
- "daysDailyRate": false,
- "deviatingDaysAndHours": false
}, - "payslipAvailableForEmployeeDay": 20,
- "componentSet": {
- "payrollPeriodDataCollectiveCategory": {
- "key": 0,
- "value": "Uren"
}, - "payrollPeriodDataCollectiveComponentSet": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "Standaard exportset",
- "registrationLevel": "provider"
}, - "payrollPeriodDataIndividual": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "Standaard exportset",
- "registrationLevel": "provider"
}, - "payrollPeriodDataLeave": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "Standaard exportset",
- "registrationLevel": "provider"
}, - "payrollPeriodDataWerkkosten": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "Standaard exportset",
- "registrationLevel": "provider"
}, - "payrollPeriodDataEmployeeSelfService": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "Standaard exportset",
- "registrationLevel": "provider"
}
}
}
}
}
NL: Overzichten administratie. Download available reports on payroll administration level
Download annual payroll tax return report
Activity name : GetAnnualPayrollTaxReturnReportByPayrollAdministrationId
Acquire the annual payroll tax return report (jaaroverzicht loongaangiftestaat) on payroll administration level, as generated by the reporting service.
Please note: this endpoint may only be used to acquire a report in the pdf-type format
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
reportYear required | integer Example: reportYear=2023 A valid year for which the information is requested. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download annual wage sheet report
Activity name : GetAnnualWagesheetReportByPayrollAdministrationId
Acquire the annual wage sheet report (verzamelloonstaat) on payroll administration level, as generated by the reporting service.
__Note: __ For the querystring parameters take note of the following logic either reportYear has a value or start and endperiod have a value
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
reportYear | integer Example: reportYear=2023 A valid year for which the information is requested. |
startPeriod | integer >= 0 Example: startPeriod=201901 First period (=from) of the requested timebox. Use the format 'YYYYPP' |
endPeriod | integer >= 0 Example: endPeriod=201912 Last period (=up to and including) of the requested timebox. Use the following 'YYYYPP' |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download annual PAWW declaration report
Activity name : GetAnnualPawwDeclarationReportByPayrollAdministrationId
Download the annual PAWW declaration report for the administration
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
reportYear | integer Example: reportYear=2023 A valid year for which the information is requested. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "groupCode": 40,
- "employerName": "SR2",
- "clientNumber": 1234,
- "administrationNumber": "SR2",
- "payrollTaxesNumber": "111111110L46",
- "year": 2023,
- "period": 3,
- "premiumWage": 15654.17,
- "contribution": 15654.17,
- "numberOfParticipants": 15654.17
}
]
}
Download payroll administration configuration report
Activity name : GetPayrollAdministrationSettingsReportByPayrollAdministrationId
Acquire the payroll administration configuration report (overzicht inrichting salarisverwerking) on payroll administration level for a year, as generated by the reporting service.
Please note: this endpoint may only be used to acquire a report in the pdf-type format
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
reportYear required | integer Example: reportYear=2023 A valid year for which the information is requested. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download accumulations and balances reports
Activity name : GetAccumulationsAndBalancesReportByPayrollAdministrationId
Acquire the reports for either accumulations or balances at the payroll administration level. Currently this endpoint supports following report types to be requested:
baseForCalculationBalancesAtStartOfYear (grondslag begin jaar)
leaveBalancesAtStartOfYear (verlof begin jaar)
leaveAccrualWithinYear (opbouw verlof ulsa)
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
reportType required | string Enum: "baseForCalculationBalancesAtStartOfYear" "leaveBalancesAtStartOfYear" "leaveAccrualWithinYear" Example: reportType=baseForCalculationBalancesAtStartOfYear The type of report that is requested. |
reportYear required | integer Example: reportYear=2023 A valid year for which the information is requested. |
includeEmploymentsThatEndedBeforeStartOfTheYear | boolean If set to true employments with an enddate before the start of the reportYear will be included in the output. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download accumulated basic journal results report
Activity name : GetAccumulatedBasicJournalResultsReportByPayrollAdministrationId
Acquire accumulated basic journal results reports (cumulatief journaal niet-verdicht en verdicht) at the payroll administration level. Currently this endpoint supports following report types to be requested:
Please note: this endpoint may only be used to acquire a report in the pdf-type format
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
reportType required | string Enum: "nonAggregated" "aggregatedPerGeneralLedgerAccount" Example: reportType=nonAggregated The type of report that is requested. |
groupingType required | string Enum: "perPeriod" "perDistributionUnit" "perPeriodPerDistributionUnit" Example: groupingType=perPeriod The type of grouping that is requested. This affects the way the data is presented within the given report. |
startPeriod required | integer >= 0 Example: startPeriod=201901 First period (=from) of the requested timebox. Use the format 'YYYYPP' |
endPeriod required | integer >= 0 Example: endPeriod=201912 Last period (=up to and including) of the requested timebox. Use the following 'YYYYPP' |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download WAB deviations report
Activity name : GetDeviatingPremiumsWabReportByPayrollAdministrationId
The percentage deviation between the contract hours and the actual standard hours to assess whether the low wab premium should be revised to the high wab premium.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
reportYear required | integer Example: reportYear=2023 A valid year for which the information is requested. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download attachment of earnings report
Activity name : GetAttachmentsOfEarningsReportByPayrollAdministrationId
Download the attachment of earnings report for the administration
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
reportYear required | integer Example: reportYear=2023 A valid year for which the information is requested. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download accumulated journalrun results report
Activity name : GetAccumulatedJournalRunResultsReportByPayrollAdministrationId
Acquire accumulated journalrun results report (CSV) at the payroll administration level.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
startPeriod required | integer >= 0 Example: startPeriod=201901 First period (=from) of the requested timebox. Use the format 'YYYYPP' |
endPeriod required | integer >= 0 Example: endPeriod=201912 Last period (=up to and including) of the requested timebox. Use the following 'YYYYPP' |
reportJournalNumber required | integer <int32> Example: reportJournalNumber=123 Dagboeknummer. |
reportVoucherNumber required | integer <int32> Example: reportVoucherNumber=456 Boekstuknummer. |
reportDescription | string Example: reportDescription=123 Omschrijving to be shown on the overview. |
financialYear required | integer <int32> [ 1900 .. 9999 ] Example: financialYear=2023 fiscal year. |
period required | integer <int32> >= 0 Example: period=12 fiscal period. |
date required | string <date> Example: date=2023-01-01 Date |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download annual wage sheet report
Activity name : GetPayrollPeriodDataReportByPayrollAdministrationId
Acquire the payroll period data report (Variabele gegevens per periode) on payroll administration level, as generated by the reporting service.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
payrollPeriodId required | integer >= 0 Example: payrollPeriodId=201901 The payrollperiod the report will return data for. Use the format 'YYYYPP' |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download payroll audit report
Activity name : GetPayrollAuditReportByPayrollAdministrationId
Acquire the payroll audit report (Auditfile Salaris (XAS), formaly known in loket as the XML audit file) on payroll administration level. This report is only for the year 2024 and later. The report is generated in the XAS format as specified by the Belastingdienst.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
reportYear required | integer Example: reportYear=2023 A valid year for which the information is requested. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download payrollresults in columns
Activity name : GetPayrollResultsInColumnsPerPeriodByPayrollAdministrationId
This 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.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
payrollPeriodIdStart required | integer <int32> The unique identifier of the payroll period |
payrollPeriodIdEnd required | integer <int32> The unique identifier of the payroll period |
payrollComponentSetId | string <uuid> A predefined set of payroll components to filter what payroll components are returned |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output The default option is
|
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download FTE payrollresults in columns
Activity name : GetPayrollResultsInColumnsPerPeriodGroupedByPayrollAdministrationId
This 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.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
payrollPeriodIdStart required | integer <int32> The unique identifier of the payroll period |
payrollPeriodIdEnd required | integer <int32> The unique identifier of the payroll period |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output The default option is
|
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
NL: Overzicht met de status -en mogelijke acties voor een periode.
Process Information about a payroll on administration level
Activity name : GetPayrollProcessOverviewByPayrollAdministrationId
Get an overview of the status and possible actions for the specified period, including the preceding and subsequent period. The overview contains information about: payroll runs, payroll tax return and pension.
Metadata : Possible options for the query string parameters can be acquired (GET) via the /metadata
endpoint. The URI for this endpoint is ../providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview/metadata
.
Defaults : Default values for the query string parameters can be acquired via the /defaults
endpoint. The URI for this endpoint is ../providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview/defaults
.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
payrollPeriodIdStart required | integer <int32> Example: payrollPeriodIdStart=202004 The unique identifier of the first payroll period to return |
payrollPeriodIdEnd | integer <int32> Example: payrollPeriodIdEnd=202006 The unique identifier of the last payroll period to return |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "payrollPeriod": {
- "year": 2020,
- "periodNumber": 4,
- "payrollPeriodId": 202004,
- "periodStartDate": "2020-04-01",
- "periodEndDate": "2020-06-30"
}, - "payrollTaxReturnPeriod": {
- "year": 2020,
- "periodNumber": 4,
- "payrollTaxReturnPeriodId": 202001,
- "periodStartDate": "2020-04-01",
- "periodEndDate": "2020-06-30",
- "lastPayrollPeriodId": 202004
}, - "payroll": {
- "payrollStatus": {
- "key": 2,
- "value": "Queued",
- "payrollStatusAdditionalInfo": {
- "key": "2.1",
- "value": "The period has a payrollrun queued."
}
}, - "payrollPossibleActions": {
- "key": 0,
- "value": "None",
- "payrollPossibleActionsAdditionalInfo": {
- "key": "0.7",
- "value": "The period has a payrollrun queued."
}
}, - "typeOfInitiationLastPayrollRun": "regular"
}, - "journal": {
- "journalStatus": {
- "key": 2,
- "value": "Queued",
- "journalStatusAdditionalInfo": {
- "key": "2.1",
- "value": "The period has a journalrun ready for export"
}
}, - "journalPossibleActions": {
- "key": 0,
- "value": "None",
- "journalPossibleActionsAdditionalInfo": {
- "key": "0.7",
- "value": "The period has a journalrun queued."
}
}
}, - "payrollTaxReturn": {
- "payrollTaxReturnStatus": {
- "key": 6,
- "value": "Done",
- "payrollTaxReturnStatusAdditionalInfo": {
- "key": "2",
- "value": "The period has a payrolltaxrun queued."
}
}, - "payrollTaxReturnPossibleActions": {
- "key": 2,
- "value": "Start",
- "payrollTaxReturnPossibleActionsAdditionalInfo": {
- "key": "0.13",
- "value": "There is a queued payrolltaxreturn."
}
}, - "initiateIdealPayment": {
- "key": 0,
- "value": "Ideal Payment is possible"
}
}, - "pensionDeclaration": [
- {
- "pensionDeclarationStatus": {
- "key": 6,
- "value": "Done",
- "pensionDeclarationStatusAdditionalInfo": {
- "key": "2",
- "value": "The period has a pensiondeclaration queued."
}
}, - "pensionDeclarationPossibleActions": {
- "key": 2,
- "value": "Start",
- "pensionDeclarationPossibleActionsAdditionalInfo": {
- "key": "UPAC014",
- "value": "There is a queued pensiondeclaration."
}
}, - "pensionAdministratorType": "UPA",
- "externalParty": {
- "key": 13,
- "value": "PFZW (UPA)"
}
}
], - "pawwDeclaration": {
- "pawwDeclarationStatus": {
- "key": 6,
- "value": "Done",
- "pawwDeclarationStatusAdditionalInfo": {
- "key": "2",
- "value": "The period has a pawwDeclaration queued."
}
}, - "pawwDeclarationPossibleActions": {
- "key": 2,
- "value": "Start",
- "pawwDeclarationPossibleActionsAdditionalInfo": {
- "key": "UPAC014",
- "value": "There is a queued pawwDeclaration."
}
}, - "pensionAdministratorType": "UPA"
}
}
]
}
Payroll status for each administration.
Activity name : GetPayrollStatusByBearerToken
Returns an array of payrollAdministrations. Each object contains information about the payrolladministration and the payroll run status for an payroll period.
path Parameters
payrollPeriodId required | integer <int32> Example: 202201 The unique identifier of the payroll period to return. |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "VST Consultancy",
- "administrationNumber": "134.26.94",
- "description": "VST Consultancy",
- "clientNumber": 465,
- "payrollPeriodType": {
- "key": 2,
- "value": "month"
}, - "hasAutomaticPayroll": true,
- "cao": {
- "key": 115,
- "value": "18 Vishandel"
}, - "loonmodel": {
- "key": 929,
- "value": "Vishandel monthly payrolling"
}, - "groupClassification": {
- "key": 3,
- "value": "South"
}, - "groupCode": 40,
- "shortName": "VST",
- "payrollPeriod": {
- "year": 2020,
- "periodNumber": 4,
- "payrollPeriodId": 202004,
- "periodStartDate": "2020-04-01",
- "periodEndDate": "2020-06-30"
}, - "payroll": {
- "methodOfCreation": {
- "key": 2,
- "value": "Individueel"
}, - "automaticStartDate": "2025-01-18",
- "automaticApproveDate": "2025-01-25",
- "status": {
- "key": 6,
- "value": "geannuleerde loonrun"
}, - "possibleActions": {
- "key": 0,
- "value": "None"
}, - "userRights": {
- "hasStartRight": true,
- "hasCalculateWorkingHoursRight": true,
- "hasCancelRight": true,
- "hasConfirmRight": true
}
}
}
]
}
PayrollTaxreturn status for each wageTaxNumber.
Activity name : GetPayrollTaxReturnStatusByBearerToken
Returns an array of payrollAdministrations. Each object contains information about the payrolladministration and the payrolltaxreturn status for an payroll period.
path Parameters
payrollPeriodId required | integer <int32> Example: 202201 The unique identifier of the payroll period to return. |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "VST Consultancy",
- "administrationNumber": "134.26.94",
- "description": "VST Consultancy",
- "clientNumber": 465,
- "payrollPeriodType": {
- "key": 2,
- "value": "month"
}, - "hasAutomaticPayroll": true,
- "cao": {
- "key": 115,
- "value": "18 Vishandel"
}, - "loonmodel": {
- "key": 929,
- "value": "Vishandel monthly payrolling"
}, - "groupClassification": {
- "key": 3,
- "value": "South"
}, - "groupCode": 40,
- "payrollPeriod": {
- "year": 2020,
- "periodNumber": 4,
- "payrollPeriodId": 202004,
- "periodStartDate": "2020-04-01",
- "periodEndDate": "2020-06-30"
}, - "shortName": "VST",
- "wageTaxNumber": "111111110L00",
- "payrollTaxReturnParty": {
- "key": 1,
- "value": "Loket.nl"
}, - "payrollTaxReturn": {
- "methodOfCreation": {
- "key": 2,
- "value": "Individueel"
}, - "automaticStartDate": "2025-01-18",
- "automaticApproveDate": "2025-01-25",
- "processingFinishedTime": "2021-05-08T15:16:49+02:00",
- "approvalTime": "2021-05-08T15:16:49+02:00",
- "approvedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "status": {
- "key": 6,
- "value": "Approved"
}, - "possibleActions": {
- "key": 0,
- "value": "None"
}, - "userRights": {
- "hasStartRight": true,
- "hasConfirmRight": true
}
}
}
]
}
Pension declaration status for each externalParty.
Activity name : GetPensionDeclarationStatusByBearerToken
Returns 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.
path Parameters
payrollPeriodId required | integer <int32> Example: 202201 The unique identifier of the payroll period to return. |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "VST Consultancy",
- "administrationNumber": "134.26.94",
- "description": "VST Consultancy",
- "clientNumber": 465,
- "payrollPeriodType": {
- "key": 2,
- "value": "month"
}, - "hasAutomaticPayroll": true,
- "cao": {
- "key": 115,
- "value": "18 Vishandel"
}, - "loonmodel": {
- "key": 929,
- "value": "Vishandel monthly payrolling"
}, - "groupClassification": {
- "key": 3,
- "value": "South"
}, - "groupCode": 40,
- "payrollPeriod": {
- "year": 2020,
- "periodNumber": 4,
- "payrollPeriodId": 202004,
- "periodStartDate": "2020-04-01",
- "periodEndDate": "2020-06-30"
}, - "wageTaxNumber": "111111110L00",
- "automaticStartDate": "2025-01-18",
- "automaticApproveDate": "2025-01-25",
- "pensionDeclaration": {
- "customerGroupNumber": 123456,
- "externalParty": {
- "key": 2,
- "value": "PFZW (UPA)"
}, - "pensionAdministratorType": "UPA",
- "methodOfCreation": {
- "key": 2,
- "value": "Individueel"
}, - "status": {
- "key": 6,
- "value": "Approved"
}, - "possibleActions": {
- "key": 0,
- "value": "None"
}, - "userRights": {
- "hasStartRight": true,
- "hasConfirmRight": true
}
}
}
]
}
Year status for each administration
Activity name : GetYearStatusByBearerToken
Returns an array of payrollAdministrations. Each object contains information about the payrolladministration and the year.
path Parameters
year required | integer <int32> Example: 2024 The year. |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "VST Consultancy",
- "administrationNumber": "134.26.94",
- "description": "VST Consultancy",
- "clientNumber": 465,
- "payrollPeriodType": {
- "key": 2,
- "value": "month"
}, - "hasAutomaticPayroll": true,
- "cao": {
- "key": 115,
- "value": "18 Vishandel"
}, - "loonmodel": {
- "key": 929,
- "value": "Vishandel monthly payrolling"
}, - "groupClassification": {
- "key": 3,
- "value": "South"
}, - "groupCode": 40,
- "testYear": false,
- "externalParty": {
- "key": 1,
- "value": "APG-bouw"
}, - "year": {
- "yearId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "status": {
- "key": 0,
- "value": "Active"
}, - "possibleActions": {
- "key": 0,
- "value": "None",
- "additionalInformation": {
- "key": 2,
- "value": "The year already has been closed."
}
}, - "userRights": {
- "hasRequestTranstionRight": true
}
}, - "payroll": {
- "lastPeriodNumberWithApprovedPayrollRun": 8
}
}
]
}
NL: Exportset/componentset. Pre-defined sets of payroll components. Useful when working with large list of components
Available payroll component sets
Activity name : GetAvailablePayrollComponentSetsByPayrollAdministrationId Get the available payroll components sets that are available at this level. A payroll component set defines a set of payroll components to be used as a sjabloon preventing the need for users to constatnly select the same set of payroll components. Payroll component set are commonly used when entering payroll period data (variabele gegevens) either for a single employment or for multiple employments (browser variabele gegevens). They are also used as a filter when exporting payroll run results.
Both at the provider level and payroll administration the user may define sets and which components it includes. This endpoint will return an aggregated view of the applicable sets and its corresponding component based on the defined sets at provider and administration level.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Standaard exportset",
- "payrollComponents": [
- {
- "key": 1,
- "description": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}, - "canBeSupplemented": false
}
], - "type": {
- "key": 1,
- "value": "Loonresultaten"
}, - "isDefinedOnProviderLevel": true,
- "isDefaultForPayrollPeriodData": true,
- "isDefaultForBrowserPayrollPeriodData": false
}
]
}
Payroll component sets
Activity name : GetPayrollComponentSetsByPayrollAdministrationId
Get 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).
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Standaard exportset",
- "payrollComponents": [
- {
- "key": 1,
- "description": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}, - "canBeSupplemented": false
}
], - "type": {
- "key": 1,
- "value": "Loonresultaten"
}
}
]
}
Add an Payroll component set
Activity name : PostPayrollComponentSetByPayrollAdministrationId
Add an payroll component set.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
PayrollComponentSet
description | string <= 50 characters |
Array of objects | |
object <metadata> The type of the componentset. (Loonresultaten, Werkkosten, VerlofOpbouw) |
Responses
Request samples
- Payload
{- "description": "Standaard exportset",
- "payrollComponents": [
- {
- "key": 1
}
], - "type": {
- "key": 1
}
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Standaard exportset",
- "payrollComponents": [
- {
- "key": 1,
- "description": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}, - "canBeSupplemented": false
}
], - "type": {
- "key": 1,
- "value": "Loonresultaten"
}
}
]
}
Details of an payroll component set
Activity name : GetPayrollComponentSetsByPayrollComponentSetId
Get the details of an payroll components sets.
path Parameters
payrollComponentSetId required | string <uuid> The unique identifier of the payroll component set |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Standaard exportset",
- "payrollComponents": [
- {
- "key": 1,
- "description": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}, - "canBeSupplemented": false
}
], - "type": {
- "key": 1,
- "value": "Loonresultaten"
}
}
}
Edit an payroll component set
Activity name : PutPayrollComponentSetByPayrollComponentSetId
Edit an payroll components set.
path Parameters
payrollComponentSetId required | string <uuid> The unique identifier of the payroll component set |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
PayrollComponentSet
description | string <= 50 characters |
Array of objects |
Responses
Request samples
- Payload
{- "description": "Standaard exportset",
- "payrollComponents": [
- {
- "key": 1
}
]
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Standaard exportset",
- "payrollComponents": [
- {
- "key": 1,
- "description": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}, - "canBeSupplemented": false
}
], - "type": {
- "key": 1,
- "value": "Loonresultaten"
}
}
]
}
Delete an Payroll component set
Activity name : DeletePayrollComponentSetByPayrollComponentSetId
Delete an payroll component set.
path Parameters
payrollComponentSetId required | string <uuid> The unique identifier of the payroll component set |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Payroll component sets (provider level)
Activity name : GetPayrollComponentSetsByProviderId
Get 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).
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Standaard exportset",
- "payrollComponents": [
- {
- "key": 1,
- "description": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}, - "canBeSupplemented": false
}
], - "type": {
- "key": 1,
- "value": "Loonresultaten"
}
}
]
}
Add an Payroll component set (provider level)
Activity name : PostPayrollComponentSetByProviderId
Add an payroll component set.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
PayrollComponentSet
description | string <= 50 characters |
Array of objects | |
object <metadata> The type of the componentset. (Loonresultaten, Werkkosten, VerlofOpbouw) |
Responses
Request samples
- Payload
{- "description": "Standaard exportset",
- "payrollComponents": [
- {
- "key": 1
}
], - "type": {
- "key": 1
}
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Standaard exportset",
- "payrollComponents": [
- {
- "key": 1,
- "description": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}, - "canBeSupplemented": false
}
], - "type": {
- "key": 1,
- "value": "Loonresultaten"
}
}
]
}
Details of an payroll component set (provider level)
Activity name : GetProviderPayrollComponentSetByPayrollComponentSetId
Get the details of an payroll components sets.
path Parameters
payrollComponentSetId required | string <uuid> The unique identifier of the payroll component set |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Standaard exportset",
- "payrollComponents": [
- {
- "key": 1,
- "description": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}, - "canBeSupplemented": false
}
], - "type": {
- "key": 1,
- "value": "Loonresultaten"
}
}
}
Edit an payroll component set (provider level)
Activity name : PutProviderPayrollComponentSetByPayrollComponentSetId
Edit an payroll components set.
path Parameters
payrollComponentSetId required | string <uuid> The unique identifier of the payroll component set |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
PayrollComponentSet
description | string <= 50 characters |
Array of objects |
Responses
Request samples
- Payload
{- "description": "Standaard exportset",
- "payrollComponents": [
- {
- "key": 1
}
]
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Standaard exportset",
- "payrollComponents": [
- {
- "key": 1,
- "description": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}, - "canBeSupplemented": false
}
], - "type": {
- "key": 1,
- "value": "Loonresultaten"
}
}
]
}
Delete an Payroll component set (provider level)
Activity name : DeleteProviderPayrollComponentSetByPayrollComponentSetId
Delete an payroll component set.
path Parameters
payrollComponentSetId required | string <uuid> The unique identifier of the payroll component set |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
NL: Jaaropgave. Download the year-end statement(s) for the employments of a payroll administration
Year-end statements for the payroll administration
Activity name : GetYearEndStatementsByPayrollAdministrationId
Get a list of year-end statements (i.e. list of years for which year-end statements are available) for a payrolladministration.
The year-end statements at administration level are effectively a collection of year-end statements for its underlying employments. However it may also be required at the administration level in one call.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "year": 2018
}
]
}
Download year-end statement of a payroll administration for a year
Activity name : GetYearEndStatementForYearByPayrollAdministrationId
Availability: This is endpoint is available for the Loket.nl application only. It is not available for external parties
Download the year-end statements of a payroll administration (of its underlying employment) for a year.
The year-end statements at administration level are effectively a collection of year-end statements for its underlying employments. With this endpoint it may also be required at the administration level in one call.
Please note: this endpoint may only be used to acquire a report in the pdf-type format
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
year required | integer <int32> <= 4 characters Example: 2018 The payroll year |
query Parameters
includeEmployeeSelfService | boolean Example: includeEmployeeSelfService=true 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. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
NL: Browser variabele gegevens. Payroll period data on administration level. (Get periods via payroll periods within the payroll category)
List of payroll period data on payroll administration level
Activity name : GetPayrollPeriodDataByPayrollAdministrationIdAndPayrollPeriodId
Get a list of all payroll period data for all the active employment in the given payroll period for the give payroll administration. Payroll period data relates to a single payroll period.
This endpoint only returns objects for which the employment meets the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
Metadata : Possible options for the query string parameters can be acquired (GET) via the /metadata
endpoint. The URI for this endpoint is ../providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/payrollperioddata/metadata
.
Defaults : Default values for the query string parameters can be acquired via the /defaults
endpoint. The URI for this endpoint is ../providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/payrollperioddata/defaults
.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
payrollPeriodId required | integer <int32> The unique identifier of the payroll period |
query Parameters
payslipType required | integer <int32> Controles which payroll period data is returned either for the normal payslip of the tarif payslip. |
payrollComponentSet | string <uuid> A predefined set of payroll components to filter which payroll components are returned. Note: Either |
payrollComponentCategory | integer <int32> A predefined category of payroll components to filter which payroll components are returned. Note: Either |
payrollComponentId | integer <int32> A payroll components to filter on. Note: Either This parameter will soon become available. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employment": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollId": 2,
- "incomeRelationshipNumber": 12
}, - "employee": {
- "formattedName": "Jong, I",
- "employeeNumber": 156,
- "firstName": "Susan"
}, - "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "shift": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "payslipType": {
- "key": 2,
- "value": "Bijzonder tarief strook"
}, - "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}, - "costCenter": {
- "key": 2,
- "code": "SAL073",
- "description": "Sales Den Bosch"
}, - "costUnit": {
- "key": 2,
- "code": "01",
- "description": "Cars"
}, - "payrollComponents": [
- {
- "payrollComponent": {
- "key": 1,
- "description": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}, - "canBeSupplemented": false
}, - "value": 144,
- "isSupplement": false
}
]
}
]
}
Payroll components
Activity name : GetPayrollComponentsByPayrollAdministrationIdAndYear Get the available payroll components for an administration.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
year required | integer <int32> <= 4 characters Example: 2018 The payroll year |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "key": 1,
- "description": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}, - "canBeSupplemented": false,
- "isCollectiveMutationPossible": false
}
]
}
NL: Automatische processen. Manage the automatic payroll configuration for a given payroll administration
Automatic payroll configuration
Activity name : GetAutomaticPayrollConfigurationByPayrollAdministrationId This endpoint retrieves the automatic payroll configuration for a given payroll administration.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "planDuringWeekend": false,
- "planDuringHoliday": false,
- "planBeforeOrAfterWeekend": "After",
- "planBeforeOrAfterHoliday": "Before",
- "processes": [
- {
- "type": {
- "key": 1,
- "value": "Verlonen"
}, - "isEnabled": false,
- "dayNumber": 2,
- "additionalNumberOfDaysFirstPeriod": 2,
- "additionalNumberOfDaysLastPeriod": 2,
- "processInNextPeriod": false
}
]
}
}
edit the automatic payroll configuration
Activity name : PatchAutomaticPayrollConfigurationByPayrollAdministrationId This endpoint edits the automatic payroll configuration for a given payroll administration.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Automatic payroll configuration
planDuringWeekend | boolean Indicates whether processes can be planned during the weekend. |
planDuringHoliday | boolean Indicates whether processes can be planned during a holiday. |
planBeforeOrAfterWeekend | string or null Enum: "Before" "After" Indicates whether the process should be planned before or after the weekend. |
planBeforeOrAfterHoliday | string or null Enum: "Before" "After" Indicates whether the process should be planned before or after the holiday. |
Array of objects |
Responses
Request samples
- Payload
{- "planDuringWeekend": false,
- "planDuringHoliday": false,
- "planBeforeOrAfterWeekend": "After",
- "planBeforeOrAfterHoliday": "Before",
- "processes": [
- {
- "type": {
- "key": 1
}, - "isEnabled": false,
- "dayNumber": 2,
- "additionalNumberOfDaysFirstPeriod": 2,
- "additionalNumberOfDaysLastPeriod": 2,
- "processInNextPeriod": false
}
]
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "planDuringWeekend": false,
- "planDuringHoliday": false,
- "planBeforeOrAfterWeekend": "After",
- "planBeforeOrAfterHoliday": "Before",
- "processes": [
- {
- "type": {
- "key": 1,
- "value": "Verlonen"
}, - "isEnabled": false,
- "dayNumber": 2,
- "additionalNumberOfDaysFirstPeriod": 2,
- "additionalNumberOfDaysLastPeriod": 2,
- "processInNextPeriod": false
}
]
}
}
NL: Geplande datums automatische processen. Manage the automatic payroll dates for a given payroll administration
Automatic payroll dates
Activity name : GetAutomaticPayrollDatesByYearId This endpoint retrieves the automatic payroll dates for a payroll administration and year. The YearId contains the year and the payroll administration id.
path Parameters
yearId required | string <uuid> The guid of the payroll year |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "type": {
- "key": 1,
- "value": "Verlonen"
}, - "dates": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriod": {
- "year": 0,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "scheduledDate": "2020-01-01",
- "methodOfCreation": {
- "key": 2,
- "value": "Individueel"
}, - "isProcessed": false
}
]
}
]
}
create a new automatic payroll date
Activity name : PostAutomaticPayrollDateByYearId This endpoint creates a new automatic payroll date for a given year.
path Parameters
yearId required | string <uuid> The guid of the payroll year |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Automatic payroll date details
object <metadata> The process. | |
object | |
scheduledDate | string <date> The date on which the process should be executed. |
Responses
Request samples
- Payload
{- "type": {
- "key": 1
}, - "payrollPeriod": {
- "periodNumber": 1
}, - "scheduledDate": "2020-01-01"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "type": {
- "key": 1,
- "value": "Verlonen"
}, - "dates": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriod": {
- "year": 0,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "scheduledDate": "2020-01-01",
- "methodOfCreation": {
- "key": 2,
- "value": "Individueel"
}, - "isProcessed": false
}
]
}
}
edit an automatic payroll date
Activity name : PatchAutomaticPayrollDateByAutomaticPayrollDateId This endpoint edits an automatic payroll date.
path Parameters
automaticPayrollDateId required | string <uuid> Example: b14acd0d-75d7-4fc8-8b22-4a3924585cab The unique identifier of the automatic payroll date. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Automatic payroll configuration
scheduledDate | string or null <date> The date on which the process should be executed. |
Responses
Request samples
- Payload
{- "scheduledDate": "2020-01-01"
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "type": {
- "key": 1,
- "value": "Verlonen"
}, - "dates": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriod": {
- "year": 0,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "scheduledDate": "2020-01-01",
- "methodOfCreation": {
- "key": 2,
- "value": "Individueel"
}, - "isProcessed": false
}
]
}
}
delete an automatic payroll date
Activity name : DeleteAutomaticPayrollDateByAutomaticPayrollDateId This endpoint deletes an automatic payroll date.
path Parameters
automaticPayrollDateId required | string <uuid> Example: b14acd0d-75d7-4fc8-8b22-4a3924585cab The unique identifier of the automatic payroll date. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of all available payroll periods and runs
Activity name : GetPayrollPeriodsByPayrollAdministrationId
Returns a list of all payroll periods available for the given payroll administration
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": 202001,
- "year": 2020,
- "periodNumber": 1,
- "startDate": "2020-01-01",
- "endDate": "2020-01-31",
- "automaticProcessing": {
- "createPayrollRunOn": "2020-01-18",
- "hasAutomaticPayrollRunCreationBeenExecuted": true,
- "approvePayrollRunOn": "2020-01-23",
- "hasAutomaticPayrollRunApprovalBeenExecuted": true
}, - "payrollPeriodType": {
- "key": 2,
- "value": "month"
}, - "testYear": false,
- "payrollRuns": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollRunStatus": {
- "key": 9,
- "value": "Verloning goedgekeurd."
}, - "sequenceNumber": 1,
- "sequenceNumberApproved": 3,
- "journalRuns": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "sequenceNumber": 8,
- "journalRunStatus": {
- "key": 4,
- "value": "Journaal gereed"
}
}
]
}
]
}
]
}
List of all available payroll periods
Activity name : GetPayrollPeriodsMinimizedByPayrollAdministrationId
Returns a list of all payroll periods available for the given payroll administration
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "year": 2020,
- "periodNumber": 1,
- "startDate": "2020-01-01",
- "endDate": "2020-01-31",
- "payrollPeriodType": {
- "key": 2,
- "value": "month"
}, - "testYear": false,
- "hasApprovedPayrollRun": false,
- "hasSuccessfulJournalRun": false
}
]
}
Get payroll results for the given payroll period
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).
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
payrollPeriodId required | integer <int32> The unique identifier of the payroll period |
query Parameters
payrollComponents | Array of integers <int32> [ items <int32 > ] Example: payrollComponents=70,151,12 Can be used to filter what payroll components are returned. Cannot be used in combination with payrollComponentSet. |
payrollComponentSet | string <uuid> A predefined set of payroll components to filter what payroll components are returned |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriods": [
- {
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31",
- "testYear": false
}, - "payslipTypes": [
- {
- "payslipType": {
- "key": 1,
- "value": "Normaal strook"
}, - "payrollComponentResults": [
- {
- "payrollComponent": {
- "key": null,
- "value": null,
- "category": { },
- "column": { },
- "costsEmployer": { }
}, - "value": 40,
- "valueSpecialTariff": 144
}
]
}
]
}
]
}
]
}
Get the results of the given payroll period and the one before
Activity name : GetComparePayrollPeriodsByPayrollAdministrationId
Returns the results of given payroll period and the one before so a comparison can be made. Currently only the components 260, 495, 257 are returned
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
payrollPeriodId required | integer <int32> Example: payrollPeriodId=202001 The unique identifier of the payroll period |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31",
- "testYear": false
}, - "numberOfPayrolledEmployments": 34,
- "payrollComponentResults": [
- {
- "payrollComponent": {
- "key": 1,
- "value": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "column": {
- "key": 6,
- "value": "Sociaalplichtig loon"
}, - "costsEmployer": {
- "key": 1,
- "value": "+"
}
}, - "value": 40,
- "valueSpecialTariff": 144
}
]
}
]
}
basic payrollresults statistics
Activity name : GetPayrollResultStatisticsDataByEmployerId
Returns a compact set of data for payrollresults for a range of components for a range of payroll periods.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
startDate required | stringdate Example: startDate=2020-08-01 The start date |
endDate required | stringdate Example: endDate=2020-08-31 The end date |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "clientNumber": 1234,
- "employeeNumber": 14,
- "incomeRelationshipNumber": 1,
- "formattedName": "Bos B",
- "year": 2024,
- "department": "Procurement",
- "function": "Manager",
- "gross": 2400,
- "net": 1684.51,
- "employerCosts": 2561.47,
- "fte": 2.8
}
]
}
Get the results of the given payroll period and the one before
Activity name : GetPayrollComponentResultsByPayrollAdministrationIdAndPayrollComponent
Returns the results of a specific payrollcomponent for a range of payroll periods so a comparison can be made.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
payrollComponents | Array of integers <int32> [ items <int32 > ] Example: payrollComponents=70,151,12 Can be used to filter what payroll components are returned. Cannot be used in combination with payrollComponentSet. |
payrollPeriodIdStart required | integer <int32> The unique identifier of the payroll period |
payrollPeriodIdEnd required | integer <int32> The unique identifier of the payroll period |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollComponentResults": [
- {
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1
}, - "value": 40,
- "valueSpecialTariff": 144
}
]
}
]
}
Compare payrollresults for two payrollperiods at providerlevel
Activity name : GetComparePayrollPeriodResultsByBearerToken
Returns the results of two given payroll periods and a comparison between them.
query Parameters
payrollPeriodIdToCompare required | integer <int32> Example: payrollPeriodIdToCompare=202503 The unique identifier of the base payroll period |
payrollPeriodIdCompareTo required | integer <int32> Example: payrollPeriodIdCompareTo=202502 The unique identifier of the payroll period to which the base payroll period is compared |
payrollComponentId required | integer <int32> The component id |
tableTariff required | string Enum: "table" "tariff" "tableAndTariff" Indicates whether the table and/or tariff values should be included in the response. |
includeFromDeviationPercentage required | number <double> >= 0 Example: includeFromDeviationPercentage=3.14 Indicates from deviation percentage results should be included in the response. When set to 0, all results are included. |
sort required | string Enum: "employerName" "administrationName" "clientNumber" "administrationNumber" "percentageDifference" Indicates on which field the results should be sorted. Default is on the payroll component. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: responseType=async;text/csv The accept header is used to influence what type of output is returned and in most cases the version of the output The output of the endpoint is provided async. The default option is
|
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "transactionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Payroll results for several periods
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.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
payrollPeriodIdStart required | integer <int32> The unique identifier of the payroll period |
payrollPeriodIdEnd required | integer <int32> The unique identifier of the payroll period |
payrollComponentSetId | string <uuid> A predefined set of payroll components to filter what payroll components are returned |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employer": {
- "employerNumber": 20720,
- "companyName": "Voorbeeld B.V."
}, - "payrollAdministration": {
- "clientNumber": 1234
}, - "employee": {
- "employeeNumber": 156,
- "formattedName": "Wiel - van Bergen S.L. van de",
- "gender": "female",
- "dateOfBirth": "1995-05-21"
}, - "employment": {
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "payrollId": 2,
- "organizationalEntity": {
- "department": {
- "code": 2,
- "description": "Verkoop"
}, - "function": {
- "code": 2,
- "description": "Directeur"
}, - "distributionUnit": {
- "code": 2,
- "description": "Sales"
}
}, - "workinghours": {
- "shift": {
- "fullTimeHoursPerWeek": 40
}, - "deviatingHoursPerWeek": 32
}
}, - "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1
}, - "payrollResults": {
- "payrollComponent": {
- "key": 1,
- "value": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "column": {
- "key": 6
}, - "costsEmployer": {
- "key": 1,
- "value": "+"
}
}, - "value": 40,
- "valueSpecialTariff": 144
}
}
]
}
Payroll results for a payrollrun
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.
path Parameters
payrollrunId required | string <uuid> The unique identifier of the payroll run |
query Parameters
payrollComponentSetId | string <uuid> A predefined set of payroll components to filter what payroll components are returned |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employer": {
- "employerNumber": 20720,
- "companyName": "Voorbeeld B.V."
}, - "payrollAdministration": {
- "clientNumber": 1234
}, - "employee": {
- "employeeNumber": 156,
- "formattedName": "Wiel - van Bergen S.L. van de",
- "gender": "female",
- "dateOfBirth": "1995-05-21"
}, - "employment": {
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "payrollId": 2,
- "organizationalEntity": {
- "department": {
- "code": 2,
- "description": "Verkoop"
}, - "function": {
- "code": 2,
- "description": "Directeur"
}, - "distributionUnit": {
- "code": 2,
- "description": "Sales"
}
}, - "workinghours": {
- "shift": {
- "fullTimeHoursPerWeek": 40
}, - "deviatingHoursPerWeek": 32
}
}, - "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1
}, - "payrollResults": {
- "payrollComponent": {
- "key": 1,
- "value": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "column": {
- "key": 6
}, - "costsEmployer": {
- "key": 1,
- "value": "+"
}
}, - "value": 40,
- "valueSpecialTariff": 144
}
}
]
}
NL: Variabele gegevens. Payroll period data (e.g. hours worked or specific bonus) relates to a single payroll period.
There are also several other payroll related resources that work with start and end dates allowing these resources to span multiple payroll periods. We refer to those resources as payroll data, however THIS endpoint allows the user to determine only the value of specific payroll components for a specific payroll period (variabele gegevens, vs vaste gegevens). The payroll components that may be used as payroll period data (f.e. example component 1 relates to the normal hours worked in that period) are specific for the payroll administration to be used, even though there are some overall generic consistencies.
Import payroll period data for an employer
Activity name : PostPayrollPeriodImportDataByPayrollAdministrationId
import payroll period data records for an employer
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
payrollPeriodId required | integer <int32> The unique identifier of the payroll period |
payslipType required | integer <int32> Controles which payroll period data is returned either for the normal payslip of the tarif payslip. |
processingMethod required | integer <int32> The method of processing data when existing values are found. (overwrite, do not overwrite, add up) |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
csv file to be uploaded.
mimeType | string Value: "text/csv" The type of file to import. Currently only csv is supported |
data | string base64 encoded file. |
Responses
Request samples
- Payload
{- "mimeType": "text/csv",
- "data": "YQ=="
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
Import payroll period data for several employers
Activity name : PostPayrollPeriodImportDataByBearerToken
import payroll period data records for several employees from sereval employers at once.
query Parameters
payrollPeriodId required | integer <int32> The unique identifier of the payroll period |
payslipType required | integer <int32> Controles which payroll period data is returned either for the normal payslip of the tarif payslip. |
processingMethod required | integer <int32> The method of processing data when existing values are found. (overwrite, do not overwrite, add up) |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
csv file to be uploaded.
mimeType | string Value: "text/csv" The type of file to import. Currently only csv is supported |
data | string base64 encoded file. |
Responses
Request samples
- Payload
{- "mimeType": "text/csv",
- "data": "YQ=="
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
Insert or update payroll period data for several employments
This endpoint is the Collective variant of PatchPayrollPeriodDataByEmploymentId
Activity name : PatchCollectivePayrollPeriodDataByEmployerId
This endpoint can be used to patch payroll period data for several employments of an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Payroll period data to add to or update for the employment.
employmentId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
object <metadata> | |
object <metadata> The shift determines the full-time hours and bonus percentage. | |
object <metadata> The type of payslip (as defined by the Dutch tax authorities) | |
payslipText | string or null [ 1 .. 25 ] characters A custom text to be displayed on the payslip. |
object <metadata> Distribution unit (verdelingseenheid), used in several reports and the "basic wage journal" functionality. Commonly used as a cost center. | |
object or null <metadata> The cost center on which the payroll period data for this record will be booked for the ledger. | |
object or null <metadata> The cost unit on which the data for this record will be booked for the ledger | |
Array of objects |
Responses
Request samples
- Payload
[- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1
}, - "shift": {
- "shiftNumber": 1
}, - "payslipType": {
- "key": 2
}, - "payslipText": "Additional payslip for bonus",
- "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "costCenter": {
- "key": 2
}, - "costUnit": {
- "key": 2
}, - "payrollComponents": [
- {
- "payrollComponent": {
- "key": 1
}, - "value": 144,
- "isSupplement": false
}
]
}
]
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
list of payroll period data
Activity name : GetPayrollPeriodDataByEmploymentId
Get a list of all payroll period data for an employment. Payroll period data relates to a single payroll period.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "shift": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "payslipType": {
- "key": 2,
- "value": "Bijzonder tarief strook"
}, - "payslipText": "Additional payslip for bonus",
- "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}, - "costCenter": {
- "key": 2,
- "code": "SAL073",
- "description": "Sales Den Bosch"
}, - "costUnit": {
- "key": 2,
- "code": "01",
- "description": "Cars"
}, - "payrollComponents": [
- {
- "payrollComponent": {
- "key": 1,
- "description": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}, - "canBeSupplemented": false
}, - "value": 144,
- "isSupplement": false
}
]
}
]
}
Create an payroll period data record for an employment
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
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Payroll variables to add to the employment.
object <metadata> | |
object <metadata> The shift determines the full-time hours and bonus percentage.
| |
object <metadata> The type of payslip (as defined by the Dutch tax authorities) | |
payslipText | string or null [ 1 .. 25 ] characters A custom text to be displayed on the payslip. |
object <metadata> Distribution unit, used in several reports and the "basic wage journal" functionality. Commonly used as a cost center.
| |
object or null <metadata> The cost center on which the payroll period data for this record will be booked for the ledger.
| |
object or null <metadata> The cost unit on which the data for this record will be booked for the ledger
| |
Array of objects |
Responses
Request samples
- Payload
{- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1
}, - "shift": {
- "shiftNumber": 1
}, - "payslipType": {
- "key": 2
}, - "payslipText": "Additional payslip for bonus",
- "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "costCenter": {
- "key": 2
}, - "costUnit": {
- "key": 2
}, - "payrollComponents": [
- {
- "payrollComponent": {
- "key": 1
}, - "value": 144,
- "isSupplement": false
}
]
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "shift": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "payslipType": {
- "key": 2,
- "value": "Bijzonder tarief strook"
}, - "payslipText": "Additional payslip for bonus",
- "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}, - "costCenter": {
- "key": 2,
- "code": "SAL073",
- "description": "Sales Den Bosch"
}, - "costUnit": {
- "key": 2,
- "code": "01",
- "description": "Cars"
}, - "payrollComponents": [
- {
- "payrollComponent": {
- "key": 1,
- "description": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}, - "canBeSupplemented": false
}, - "value": 144,
- "isSupplement": false
}
]
}
}
Insert or update payroll period data
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.nl database. This endpoint is provided to make these scenarios easier to implement since no GET call is required to determine whether a POST or PUT call is to be performed to either insert or update payroll period data.
Based on the current state of the database Loket.nl will either insert a new record or update the existing record with the supplied data.
- A new record is created when the combination of
payrollPeriod
,shift
,payslipType
,distributionUnit
,costCenter
andcostUnit
is valid and does not exist for the employment. Next to that, the objects consisting ofpayrollComponent
,value
andattribute
are inserted into the database. - An update is performed when the combination of
payrollPeriod
,shift
,payslipType
,distributionUnit
,costCenter
andcostUnit
does exist for the employment. In that case the specified objects consisting ofpayrollComponent
,value
andattribute
are inserted into the database, overwriting existing values. Existing records with apayrollComponent.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.nl helpdesk portal. Please note that this information is in Dutch and access is required.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Payroll period data to add to or update for the employment.
object <metadata> | |
object <metadata> The shift determines the full-time hours and bonus percentage. | |
object <metadata> The type of payslip (as defined by the Dutch tax authorities) | |
payslipText | string or null [ 1 .. 25 ] characters A custom text to be displayed on the payslip. |
object <metadata> Distribution unit (verdelingseenheid), used in several reports and the "basic wage journal" functionality. Commonly used as a cost center. | |
object or null <metadata> The cost center on which the payroll period data for this record will be booked for the ledger. | |
object or null <metadata> The cost unit on which the data for this record will be booked for the ledger | |
processingMethod | string or null Enum: "overwrite" "doNotOverwrite" "addUp" The processing method determines how components that already have a value are handled. |
Array of objects |
Responses
Request samples
- Payload
{- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1
}, - "shift": {
- "shiftNumber": 1
}, - "payslipType": {
- "key": 2
}, - "payslipText": "Additional payslip for bonus",
- "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "costCenter": {
- "key": 2
}, - "costUnit": {
- "key": 2
}, - "processingMethod": "overwrite",
- "payrollComponents": [
- {
- "payrollComponent": {
- "key": 1
}, - "value": 144,
- "isSupplement": false
}
]
}
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Details of a payroll period data
Activity name : GetPayrollPeriodDataByPayrollPeriodDataId
Get the details of payroll period data
path Parameters
payrollperioddataId required | string <uuid> The unique identifier of the payroll period data |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "shift": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "payslipType": {
- "key": 2,
- "value": "Bijzonder tarief strook"
}, - "payslipText": "Additional payslip for bonus",
- "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}, - "costCenter": {
- "key": 2,
- "code": "SAL073",
- "description": "Sales Den Bosch"
}, - "costUnit": {
- "key": 2,
- "code": "01",
- "description": "Cars"
}, - "payrollComponents": [
- {
- "payrollComponent": {
- "key": 1,
- "description": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}, - "canBeSupplemented": false
}, - "value": 144,
- "isSupplement": false
}
]
}
}
Edit the details of an payroll period data
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
path Parameters
payrollperioddataId required | string <uuid> The unique identifier of the payroll period data |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Payroll period data to edit.
object <metadata> The shift determines the full-time hours and bonus percentage. | |
payslipText | string or null [ 1 .. 25 ] characters A custom text to be displayed on the payslip. |
object <metadata> Distribution unit, used in several reports and the "basic wage journal" functionality. Commonly used as a cost center. | |
object or null <metadata> The cost center on which the payroll period data for this record will be booked for the ledger. | |
object or null <metadata> The cost unit on which the data for this record will be booked for the ledger | |
Array of objects |
Responses
Request samples
- Payload
{- "shift": {
- "shiftNumber": 1
}, - "payslipText": "Additional payslip for bonus",
- "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "costCenter": {
- "key": 2
}, - "costUnit": {
- "key": 2
}, - "payrollComponents": [
- {
- "payrollComponent": {
- "key": 1
}, - "value": 144,
- "isSupplement": false
}
]
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "shift": {
- "shiftNumber": 1,
- "fullTimeHoursPerWeek": 40,
- "bonusPercentage": 12
}, - "payslipType": {
- "key": 2,
- "value": "Bijzonder tarief strook"
}, - "payslipText": "Additional payslip for bonus",
- "distributionUnit": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Sales"
}, - "costCenter": {
- "key": 2,
- "code": "SAL073",
- "description": "Sales Den Bosch"
}, - "costUnit": {
- "key": 2,
- "code": "01",
- "description": "Cars"
}, - "payrollComponents": [
- {
- "payrollComponent": {
- "key": 1,
- "description": "Uren gewerkt",
- "category": {
- "key": 1,
- "value": "Uren"
}, - "deductionOrPayment": {
- "key": 2,
- "value": "Betaling"
}, - "canBeSupplemented": false
}, - "value": 144,
- "isSupplement": false
}
]
}
}
Delete a specific payroll period data record
Activity name: DeletePayrollPeriodDataByPayrollPeriodDataId
Delete a payroll period data record for the employment
path Parameters
payrollperioddataId required | string <uuid> The unique identifier of the payroll period data |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
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
Initialise Payroll Period (automatische processen)
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.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Perform Calculation Payload.
object <metadata> | |
setHoursWorked | boolean Berekenen uren. Sets hours worked-related component(s) in the payroll period data based on the configuration of the employment. |
setBaseForCalculations | boolean Grondslagen activeren. Sets baseForCalculation-related component(s) in the payroll period data based on the configuration of the employment. |
setAnnualBaseForCalculationsBasedOnFunds | boolean Jaargrondslag fondsen bepalen. Sets baseForCalculationsBasedOnFunds-related component(s) in the payroll period data based on the configuration of the employment. |
setLeaveHours | boolean Verlofuren op basis van uren bepalen. Sets leave hours-related component(s) in the payroll period data based on the configuration of the employment. |
Responses
Request samples
- Payload
{- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1
}, - "setHoursWorked": false,
- "setBaseForCalculations": false,
- "setAnnualBaseForCalculationsBasedOnFunds": false,
- "setLeaveHours": false
}
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
NL: Start verloningsrun. This endpoint may be used to start running the actual process of a payroll run. (Verlonen)
Initiate payroll run (verlonen)
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.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Initiate Payroll Run Payload.
object <metadata> | |
textPaySlip | string or null <= 25 characters An optional text provided by an authorized user that will be displayed on the pay slip. |
textPayment | string or null <= 32 characters An optional text provided by an authorized user that will be displayed as a description for the payment. |
textTariffPaySlip | string or null <= 25 characters An additional text to be displayed on the tariff payslip. |
availableForEmployeeDate | string or null <date> The date on which the pay slips will be available to employees. |
sendEmailToEmployee | boolean or null Indicates whether an email should be sent to the employees when the pay slip is available to them. NULL will be seen as false |
object |
Responses
Request samples
- Payload
{- "payrollPeriod": {
- "year": 2023,
- "periodNumber": 2
}, - "textPaySlip": "string",
- "textPayment": "string",
- "textTariffPaySlip": "string",
- "availableForEmployeeDate": "2018-05-08",
- "sendEmailToEmployee": true,
- "initiationParameters": {
- "typeOfInitiation": "regular",
- "emailAddressPayrollRunFinished": "[email protected]"
}
}
Response samples
- 202
- 400
- 401
- 403
{- "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Initiationvalues of a payrollrun
Activity name : GetPayrollrunInitiationvaluesByPayrollAdministrationIdAndPayrollPeriodId
Get the initiation values for initiating a payrollrun for a specific period.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
payrollPeriodId required | string <uuid> The unique identifier of an payroll period |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31",
- "testYear": false
}, - "availableForEmployeeDate": "2021-05-08",
- "sendEmailToEmployee": true,
- "emailAddressPayrollRunStarted": "string",
- "emailAddressPayrollRunFinished": "string",
- "emailAddressPayrollRunApproved": "string"
}
}
Initiate payroll run Collective
Activity name : PostPayrollRunCollectiveByBearerToken This is a controller endpoint to perform an action.
- The endpoint starts multiple payrollruns within one provider.
- Only one payrollrun per payrolladministration can be started.
path Parameters
payrollPeriodId required | integer <int32> Example: 202103 The unique identifier of the payroll period |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Initiate Payroll Run Payload.
payrollAdministrationId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
availableForEmployeeDate | string or null <date> The date on which the pay slips will be available to employees. |
initialisePayrollPeriod | boolean or null Default: true 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. |
Responses
Request samples
- Payload
[- {
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "availableForEmployeeDate": "2018-05-08",
- "initialisePayrollPeriod": true
}
]
Response samples
- 202
- 400
- 401
- 403
{- "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
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.
Change the status of payrollruns
Activity name : PatchPayrollrunsByPayrollRunIds
This action may only be performed successfully of the following requirements are met;
- The payroll run is ready for approval (status 1)
Update the status of one or more payrollruns
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/jsonrequired
The request body contains an array of objects containing a payrollrunId
and a status
field.
id required | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier (GUID/UUID) of the payroll run. |
action required | string Enum: "confirm" "cancel" The action to perform on the payroll run |
Responses
Request samples
- Payload
[- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "action": "confirm"
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Update payroll run status Collective
Activity name : PatchApprovePayrollRunCollectiveByBearerToken This is a controller endpoint to perform an action.
- The endpoint patches multiple payrollruns within one provider.
- Only one payrollrun per payrolladministration can be patched.
- Is endpoint is similar to PatchPayrollRunByPayrollRunIds except for the ids it works with and its progress which can be monitored.
path Parameters
payrollPeriodId required | integer <int32> Example: 202103 The unique identifier of the payroll period |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Update Payroll Run Payload.
payrollAdministrationId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
Responses
Request samples
- Payload
[- {
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
]
Response samples
- 202
- 400
- 401
- 403
{- "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
NL: Verloningsrun verwijderen. In exceptional cases the payroll run could be undone after it already has been approved.
Undo payroll run (verwijderen loonrun)
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
.
path Parameters
payrollrunId required | string <uuid> The unique identifier of the payroll run |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of tax returns for an administration
Activity name : GetPayrollTaxReturnsByPayrollAdministrationId
A list of tax returns for an administration
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollTaxReturnStatus": {
- "key": 3,
- "value": "Loonaangifte aangemaakt"
}, - "period": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "periodAmount": 2000,
- "correctionAmount": 500,
- "totalAmount": 2500,
- "paymentReference": "8111111116529080",
- "messageReference": "VSP001111111110L29000035201302",
- "iban": "NL86INGB0002445588",
- "inTheNameOf": "tnv belastingdienst Apeldoorn",
- "isCorrectionMessagePriorYear": true,
- "wageTaxNumber": "111111110L00",
- "sequenceNumber": 1,
- "methodOfCreation": {
- "key": 2,
- "value": "Individueel"
}, - "requestTime": "2021-05-08T15:16:49+02:00",
- "requestedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "processingFinishedTime": "2021-05-08T15:16:49+02:00",
- "cancelledTime": "2021-05-08T15:16:49+02:00",
- "cancelledBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "taxReturnMessageReference": "Bedrijf B.V.",
- "withholdingParty": "Bedrijf B.V.",
- "messageCreationTime": "2021-05-08T15:16:49+02:00",
- "payrollPeriodType": {
- "key": 1,
- "value": "month"
}, - "payrollTaxReturnType": {
- "key": 1,
- "value": "Periodeaangifte"
}, - "payrollTaxReturnParty": {
- "key": 1,
- "value": "Loket.nl"
}, - "externalIdentification": "AA123",
- "approvalTime": "2021-05-08T15:16:49+02:00",
- "approvedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "sendTime": "2021-05-08T15:16:49+02:00",
- "removalTime": "2021-05-08T15:16:49+02:00",
- "removedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "deadlineForPayment": "2021-12-31",
- "canBeResend": true,
- "initiateIdealPayment": {
- "key": 0,
- "value": "Ideal Payment is possible"
}, - "responseMessages": [
- {
- "dateOfReceipt": "2016-01-19",
- "responseType": {
- "key": 2,
- "value": "Error"
}, - "responseClass": {
- "key": 26,
- "value": "Loonheffingennummer is onjuist"
}
}
]
}
]
}
Change the status of payroll tax returns
Activity name : PatchPayrollTaxReturnsByPayrollTaxReturnIds
This endpoints changes the status of the list of the payroll tax returns provided in the request body based on the provided action.
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/jsonrequired
The request body contains an array of objects containing a PayrolTaxReturnId
and a taxReturnMessageStatus
id required | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
action required | string Enum: "confirm" "cancel" The action to perform on the payroll tax return |
Responses
Request samples
- Payload
[- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "action": "confirm"
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Details of a tax return for an administration
Activity name : GetPayrollTaxReturnByPayrollTaxReturnId
The details of a tax return for an administration
path Parameters
payrolltaxreturnId required | string <uuid> The unique identifier of the payroll tax return |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollTaxReturnStatus": {
- "key": 3,
- "value": "Loonaangifte aangemaakt"
}, - "period": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31"
}, - "periodAmount": 2000,
- "correctionAmount": 500,
- "totalAmount": 2500,
- "paymentReference": "8111111116529080",
- "messageReference": "VSP001111111110L29000035201302",
- "iban": "NL86INGB0002445588",
- "inTheNameOf": "tnv belastingdienst Apeldoorn",
- "isCorrectionMessagePriorYear": true,
- "wageTaxNumber": "111111110L00",
- "sequenceNumber": 1,
- "methodOfCreation": {
- "key": 2,
- "value": "Individueel"
}, - "requestTime": "2021-05-08T15:16:49+02:00",
- "requestedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "processingFinishedTime": "2021-05-08T15:16:49+02:00",
- "cancelledTime": "2021-05-08T15:16:49+02:00",
- "cancelledBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "taxReturnMessageReference": "Bedrijf B.V.",
- "withholdingParty": "Bedrijf B.V.",
- "messageCreationTime": "2021-05-08T15:16:49+02:00",
- "payrollPeriodType": {
- "key": 1,
- "value": "month"
}, - "payrollTaxReturnType": {
- "key": 1,
- "value": "Periodeaangifte"
}, - "payrollTaxReturnParty": {
- "key": 1,
- "value": "Loket.nl"
}, - "externalIdentification": "AA123",
- "approvalTime": "2021-05-08T15:16:49+02:00",
- "approvedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "sendTime": "2021-05-08T15:16:49+02:00",
- "removalTime": "2021-05-08T15:16:49+02:00",
- "removedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "deadlineForPayment": "2021-12-31",
- "canBeResend": true,
- "initiateIdealPayment": {
- "key": 0,
- "value": "Ideal Payment is possible"
}, - "responseMessages": [
- {
- "dateOfReceipt": "2016-01-19",
- "responseType": {
- "key": 2,
- "value": "Error"
}, - "responseClass": {
- "key": 26,
- "value": "Loonheffingennummer is onjuist"
}
}
]
}
}
Pay payroll taxes using IDEAL
Activity name : GetIdealUrlByPayrollTaxReturnId
Get URL which allows the user to pay payroll taxes via IDEAL
path Parameters
payrolltaxreturnId required | string <uuid> The unique identifier of the payroll tax return |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
],
}
Get the status of the IDEAL payment
Activity name : GetIdealPaymentStatusByPayrollTaxReturnId
Get the status of the IDEAL payment
path Parameters
payrolltaxreturnId required | string <uuid> The unique identifier of the payroll tax return |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "status": {
- "code": "acsc",
- "reason": "accepted"
}, - "lastStatusRequest": "2019-08-24T14:15:22Z"
}
}
Update payroll tax return status Collective
Activity name : PatchApprovePayrollTaxReturnCollectiveByBearerToken This is a controller endpoint to perform an action.
- The endpoint patches multiple payroll tax returns within one provider.
- Only one payroll tax return per payrolladministration can be patched.
- This endpoint is similar to PatchPayrollTaxReturnsByPayrollTaxReturnIds except for the ids it works with and its progress which can be monitored.
path Parameters
payrollPeriodId required | integer <int32> Example: 202401 The unique identifier of the payroll period to return. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Update Payroll Run Payload.
payrollAdministrationId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
Responses
Request samples
- Payload
[- {
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
]
Response samples
- 202
- 400
- 401
- 403
{- "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
Add a withdraw an income relationship number to an open payroll tax return
Activity name : PostWithdrawIncomeRelationshipNumberByPayrollAdministrationId
This is a controller endpoint to perform an action.
Metadata : This endpoint is available by simply adding /metadata behind the URI.
Defaults : No defaults endpoint available for this controller endpoint.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Income relationship number to be withdrawn
citizenServiceNumber | string or null (citizenServiceNumber) = 9 characters 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). |
payrollId | integer <int32> 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. |
incomeRelationshipNumber | integer <int32> [ 0 .. 9999 ] 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. |
object <metadata> |
Responses
Request samples
- Payload
{- "citizenServiceNumber": "042168588",
- "payrollId": 2,
- "incomeRelationshipNumber": 12,
- "addWithdrawalTo": {
- "year": 2017,
- "periodNumber": 1
}
}
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Resend payroll tax return (Herzenden loonaangifte)
Activity name : PatchResendPayrollTaxReturnByPayrollTaxReturnId
This 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.nl must be the application that send the payroll tax return to the payroll tax authorities
Metadata : No metadata endpoint available for this controller endpoint.
Defaults : No defaults endpoint available for this controller endpoint.
path Parameters
payrolltaxreturnId required | string <uuid> The unique identifier of the payroll tax return |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download the overview report of a payroll tax return
Activity name : GetOverviewByPayrollTaxReturnId
Download the payroll tax return overiew
path Parameters
payrolltaxreturnId required | string <uuid> The unique identifier of the payroll tax return |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download the message of a payroll tax return
Activity name : GetMessageByPayrollTaxReturnId
Download the message of the payroll tax return (loonaangiftebericht) in xml. Please note that this does NOT refer to the response message, but to the initial message i.e. loonaangiftebericht.
path Parameters
payrolltaxreturnId required | string <uuid> The unique identifier of the payroll tax return |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download the SEPA file for a payroll tax return
Activity name : GetSepaFileByPayrollAdministrationIdAndPayrollTaxReturnId
Get the Sepa file for the payroll tax return
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
payrolltaxreturnId required | string <uuid> The unique identifier of the payroll tax return |
query Parameters
requestedExecutionDate required | string <date> This value is used when creating the sepa file to set the value of <ReqdExctnDt> |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Get a SEPA hash for a payroll tax return
Activity name : GetSepaHashByPayrollTaxReturnId
Returns 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.
path Parameters
payrolltaxreturnId required | string <uuid> The unique identifier of the payroll tax return |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "hash": "cd2feea250047d4477a0276f864e9c223af66a73c305f872c31dc0cdfb709b1f"
}
}
NL: Loonaangifte response message. Payroll tax return response message
Send the response message for the payroll tax return
Activity name : PostSendResponseMessageByPayrollTaxReturnId
Send the response message of the payroll tax return (loonaangifte) that was received from the Belastingdienst, to Loket.nl . This is ONLY applicable for the limited group of parties that send and receive the payroll tax return themselves to the Belastingdienst. For the purposes of having those results visible in Loket the corresponding response message can be send to Loket via this endpoint.
What this endpoint does is the following:
- It will receive the xml response message. For the schema (XSD) of this xml response message we refer to the documentation by the Belastingdienst itself
- A set of input validations will be performed.
- If those steps are 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
- In other words; the result of this action will NOT be immediately visible
path Parameters
payrolltaxreturnId required | string <uuid> The unique identifier of the payroll tax return |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/jsonrequired
The request body contains the xml response message
responseMessageFile | string base64 encoded xml file of the response message |
Responses
Request samples
- Payload
{- "responseMessageFile": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iSVNPLTg4NTktMSI/Pgo8UmVzcG9uc2VtZXNzYWdlIHZlcnNpb249IjIwMDYuMSI+Cgk8SWRlbnRpZmljYXRpb24+CgkJPE1lc3NhZ2VJZD5BLWVmMmJmMTQwMjMxYzExZTA4MWM5MGE5ZTA0MGIxMjM0PC9NZXNzYWdlSWQ+CgkJPFJlZmVyc1RvTWVzc2FnZUlkPlZTUDAwMTAwMTE4MzcyMkwwNDAwMDAwMTIwMTIzNDwvUmVmZXJzVG9NZXNzYWdlSWQ+CgkJPE1lc3NhZ2VJZEJkPmVmMmJmMTQwMjMxYzExZTA4MWM5MGE5ZTA0MGIxMjM0PC9NZXNzYWdlSWRCZD4KCQk8RGF0dW1UaWpkT250dmFuZ3N0PjIwMjAtMDEtMThUMTY6MDY6MzlaPC9EYXR1bVRpamRPbnR2YW5nc3Q+CgkJPFJlc3BvbnNlVHlwZT5hY2tub3dsZWRnZW1lbnQ8L1Jlc3BvbnNlVHlwZT4KCTwvSWRlbnRpZmljYXRpb24+CjwvUmVzcG9uc2VtZXNzYWdlPgo"
}
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
NL: Loonaangifte obv berichtkenmerk. For some external parties it is more practical to perform these actions based on the messageReference as identifier.
Change the status of payroll tax returns
Activity name : PatchPayrollTaxReturnByMessageReference
This endpoints changes the status of the payroll tax returns provided in the path parameters based on the provided action.
Functionally, this endpoint is very similar to PatchPayrollTaxReturnsByPayrollTaxReturnIds endpoint, however this endpoint takes the messageReference (NL: BERICHTKENMERK) as path id. Instead of payrollTaxReturnId (GUID). AND, in contrast, this endpoint is a SINGLE PATCH endpoint which consumes a path id.
path Parameters
messageReference required | string The unique identifier of the payroll tax return |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/jsonrequired
The request body contains an action
action required | string Enum: "confirm" "cancel" The action to perform on the payroll tax return |
Responses
Request samples
- Payload
{- "action": "confirm"
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Send the response message for the payroll tax return
Activity name : PostSendResponseMessageByMessageReference
This endpoint is identical to PostSendResponseMessageByPayrollTaxReturnId endpoint, however this endpoint takes the messageReference (NL: BERICHTKENMERK) as path id. Instead of payrollTaxReturnId (GUID).
path Parameters
messageReference required | string The unique identifier of the payroll tax return |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/jsonrequired
The request body contains the xml response message
responseMessageFile | string base64 encoded xml file of the response message |
Responses
Request samples
- Payload
{- "responseMessageFile": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iSVNPLTg4NTktMSI/Pgo8UmVzcG9uc2VtZXNzYWdlIHZlcnNpb249IjIwMDYuMSI+Cgk8SWRlbnRpZmljYXRpb24+CgkJPE1lc3NhZ2VJZD5BLWVmMmJmMTQwMjMxYzExZTA4MWM5MGE5ZTA0MGIxMjM0PC9NZXNzYWdlSWQ+CgkJPFJlZmVyc1RvTWVzc2FnZUlkPlZTUDAwMTAwMTE4MzcyMkwwNDAwMDAwMTIwMTIzNDwvUmVmZXJzVG9NZXNzYWdlSWQ+CgkJPE1lc3NhZ2VJZEJkPmVmMmJmMTQwMjMxYzExZTA4MWM5MGE5ZTA0MGIxMjM0PC9NZXNzYWdlSWRCZD4KCQk8RGF0dW1UaWpkT250dmFuZ3N0PjIwMjAtMDEtMThUMTY6MDY6MzlaPC9EYXR1bVRpamRPbnR2YW5nc3Q+CgkJPFJlc3BvbnNlVHlwZT5hY2tub3dsZWRnZW1lbnQ8L1Jlc3BvbnNlVHlwZT4KCTwvSWRlbnRpZmljYXRpb24+CjwvUmVzcG9uc2VtZXNzYWdlPgo"
}
Response samples
- 202
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Initiate payroll tax return (aanmaken loonaangifte)
Activity name : PostInitiatePayrollTaxReturnByPayrollAdministrationId
This is a controller endpoint to perform an action.
Metadata :
There is a metadata endpoint that will return process information rather then true metadata.
This endpoint is available by simply adding /metadata behind the URI.
Defaults : Default values for a new object can be acquired (GET) by adding `/defaults' to the POST URL.
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.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: required
Initiate payroll tax return.
notifyOfInitiation | string or null <= 255 characters The email adres to notify when a new payroll tax return is started |
object |
Responses
Request samples
- Payload
{- "payrollPeriod": {
- "year": 2024,
- "periodNumber": 1
}
}
Response samples
- 202
- 400
- 401
- 403
{- "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Initiate payroll tax return for a closed year (aanmaken loonaangifte voorgaand jaar)
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.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
X-ValidateOnly | boolean If set to true only the validations will be performed no changes will be committed. |
Request Body schema: application/json;version=2018-01-01required
Initiate payroll tax return closed year.
notifyOfInitiation | string or null <= 255 characters The emial adres to notify when a new payroll tax return is started |
payrollYear | string |
Responses
Request samples
- Payload
{- "payrollYear": 2022
}
Response samples
- 202
- 400
- 401
- 403
{- "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Initiate an annual payroll tax return
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.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
X-ValidateOnly | boolean If set to true only the validations will be performed no changes will be committed. |
Request Body schema: application/json;version=2018-01-01required
Initiate an annual payroll tax return year.
notifyOfInitiation | string or null <= 255 characters The email adres to notify when a new payroll tax return is started |
Responses
Request samples
- Payload
{- "notifyOfInitiation": "[email protected]"
}
Response samples
- 202
- 400
- 401
- 403
{- "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Initiate payroll tax return Collective
Activity name : PostPayrollTaxReturnCollectiveByBearerToken This is a controller endpoint to perform an action.
- The endpoint starts multiple payroll tax returns within one provider.
- Only one payroll tax return per payrolladministration can be started.
path Parameters
payrollPeriodId required | integer <int32> Example: 202401 The unique identifier of the payroll period to return. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Initiate payroll tax return Payload.
payrollAdministrationId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
Responses
Request samples
- Payload
[- {
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
]
Response samples
- 202
- 400
- 401
- 403
{- "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
NL: Loonaangifte verwijderen. In exceptional cases the payroll tax return could be undone after it already has been approved
Undo payroll tax return (verwijderen loonaangifte)
Activity name : PostUndoPayrollTaxReturnByPayrollTaxReturnId
This is a controller endpoint to perform an action. In 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.
By 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.
This action may only be performed successfully of the following requirements are met;
- The payroll tax return is the very last payroll tax return that has been approved within this payroll administration
- 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.
Metadata : No metadata endpoint available for this controller endpoint.
Defaults : Defaults GET endpoint is available for this controller endpoint at the path .../payrolladministrations/{payrollAdministrationId}/payrolltaxreturns/undo/defaults
.
path Parameters
payrolltaxreturnId required | string <uuid> The unique identifier of the payroll tax return |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of APG pension declarations for an administration
Activity name : GetApgPensionDeclarationsByPayrollAdministrationId
A list of APG pension declarations for an administration
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "messageReference": "190",
- "methodOfCreation": {
- "key": 2,
- "value": "Individueel"
}, - "customerGroupNumber": 0,
- "apgPensionDeclarationStatus": {
- "key": 3,
- "value": "Pensioenaangifte aangemaakt"
}, - "period": {
- "year": 2017,
- "periodNumber": 1,
- "periodId": 202101,
- "periodType": {
- "key": 2,
- "value": "month"
}, - "periodStartDate": "2021-11-01",
- "periodEndDate": "2021-11-30"
}, - "withholdingAgentName": "Ben-Hur BV Via Roma",
- "externalParty": {
- "key": 13,
- "value": "PFZW (APG)"
}, - "requestTime": "2018-05-08T15:16:49+02:00",
- "creationTime": "2018-05-08T15:16:49+02:00",
- "approvalTime": "2018-05-08T15:16:49+02:00",
- "sentTime": "2018-05-08T15:16:49+02:00",
- "removeTime": "2018-05-08T15:16:49+02:00",
- "requestedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "approvedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "removedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "cancelledTime": "2018-05-08T15:16:49+02:00",
- "cancelledBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "responseMessages": [
- {
- "datetimeOfRegistration": "2016-01-19",
- "datetimeOfMessageReceipt": "2016-01-19",
- "description": "Bestand ontvangen"
}
]
}
]
}
Detail APG pension declaration for an administration
Activity name : GetApgPensionDeclarationByApgPensionDeclarationId
Details of APG pension declaration
path Parameters
apgPensionDeclarationId required | string <uuid> The unique identifier of the payroll tax return |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "messageReference": "190",
- "methodOfCreation": {
- "key": 2,
- "value": "Individueel"
}, - "customerGroupNumber": 0,
- "apgPensionDeclarationStatus": {
- "key": 3,
- "value": "Pensioenaangifte aangemaakt"
}, - "period": {
- "year": 2017,
- "periodNumber": 1,
- "periodId": 202101,
- "periodType": {
- "key": 2,
- "value": "month"
}, - "periodStartDate": "2021-11-01",
- "periodEndDate": "2021-11-30"
}, - "withholdingAgentName": "Ben-Hur BV Via Roma",
- "externalParty": {
- "key": 13,
- "value": "PFZW (APG)"
}, - "requestTime": "2018-05-08T15:16:49+02:00",
- "creationTime": "2018-05-08T15:16:49+02:00",
- "approvalTime": "2018-05-08T15:16:49+02:00",
- "sentTime": "2018-05-08T15:16:49+02:00",
- "removeTime": "2018-05-08T15:16:49+02:00",
- "requestedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "approvedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "removedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "cancelledTime": "2018-05-08T15:16:49+02:00",
- "cancelledBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "responseMessages": [
- {
- "datetimeOfRegistration": "2016-01-19",
- "datetimeOfMessageReceipt": "2016-01-19",
- "description": "Bestand ontvangen"
}
]
}
}
Change the status of a apg pension declaration
Activity name : PatchApgPensionDeclarationByApgPensionDeclarationId
This endpoints changes the status of the Apg pensiondeclaration based on the provided action.
path Parameters
apgPensionDeclarationId required | string <uuid> The unique identifier of the payroll tax return |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/jsonrequired
The request body contains the action (cancel / confirm)
action required | string Enum: "confirm" "cancel" The action to perform on the apg pensiondeclaration |
Responses
Request samples
- Payload
{- "action": "confirm"
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download the overview report of an APG pension declaration
Activity name : GetOverviewByApgPensionDeclarationId
Download the APG pension declaration overiew
path Parameters
apgPensionDeclarationId required | string <uuid> The unique identifier of the payroll tax return |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download the message of a of an APG pension declaration
Activity name : GetMessageByApgPensionDeclarationId
Download the message of the APG pension declaration (pensioenaangiftebericht) in xml. Please note that this does NOT refer to the response message, but to the initial message i.e. pensioenaangiftebericht.
path Parameters
apgPensionDeclarationId required | string <uuid> The unique identifier of the payroll tax return |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Initiate a APG pension declaration
Activity name : PostInitiateApgPensionDeclarationByPayrollAdministrationId
Initiate the pension declaration for the next available period for the payrolladministration. Information about the next available periode can be obtained using the defaults endpoint (/defaults)
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Initiate declaration.
object |
Responses
Request samples
- Payload
{- "payrollPeriod": {
- "year": 2024,
- "periodNumber": 1
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Initiate APG pension declaration for a closed year (aanmaken pensioenaangifte voorgaand jaar)
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.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
X-ValidateOnly | boolean If set to true only the validations will be performed no changes will be committed. |
Request Body schema: application/json;version=2018-01-01required
Initiate pension declaration previous year.
payrollYear | string |
Responses
Request samples
- Payload
{- "payrollYear": 2022
}
Response samples
- 202
- 400
- 401
- 403
{- "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Undo APG pension declaration(verwijderen pensioenaangifte)
Activity name : PostUndoApgPensionDeclarationByApgPensionDeclarationId
This is a controller endpoint to perform an action. Previously 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.
By 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.
This action may only be performed successfully if the following requirements are met;
- The APG pension declaration is the very last APG pension declaration that has been approved and sent within this payroll administration
- 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.
Metadata : No metadata endpoint available for this controller endpoint.
Defaults : Defaults GET endpoint is available for this controller endpoint at the path .../payrolladministrations/{payrollAdministrationId}/apgpensiondeclarations/undo/defaults
.
path Parameters
apgPensionDeclarationId required | string <uuid> The unique identifier of the payroll tax return |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of UPA pension declarations
Activity name : GetUpaPensionDeclarationsByPayrollAdministrationId
A list of UPA pension declarations for an administration
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "messageReference": "190",
- "methodOfCreation": {
- "key": 2,
- "value": "Individueel"
}, - "payrollTaxesNumber": "111111110L46",
- "upaPensionDeclarationStatus": {
- "key": 3,
- "value": "Pensioenaangifte aangemaakt"
}, - "period": {
- "year": 2017,
- "periodNumber": 1,
- "periodId": 202101,
- "periodType": {
- "key": 2,
- "value": "month"
}, - "periodStartDate": "2021-11-01",
- "periodEndDate": "2021-11-30"
}, - "withholdingAgentName": "Ben-Hur BV Via Roma",
- "externalParty": {
- "key": 13,
- "value": "PFZW (UPA)"
}, - "sendingPartyNumber": "SWO00077",
- "requestTime": "2018-05-08T15:16:49+02:00",
- "creationTime": "2018-05-08T15:16:49+02:00",
- "approvalTime": "2018-05-08T15:16:49+02:00",
- "cancelledTime": "2018-05-08T15:16:49+02:00",
- "sentTime": "2018-05-08T15:16:49+02:00",
- "removeTime": "2018-05-08T15:16:49+02:00",
- "requestedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "approvedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "cancelledBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "removedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "responseMessages": [
- {
- "datetimeOfRegistration": "2016-01-19",
- "datetimeOfMessageReceipt": "2016-01-19",
- "responseType": {
- "key": 1,
- "value": "Ontvangstbevestiging (ACK)"
}, - "responseStatus": {
- "key": 2,
- "value": "Bericht niet OK (NOK)"
}, - "citizenServiceNumber": "042168588",
- "incomeRelationshipNumber": 12,
- "employeeNumber": 156,
- "code": "NOK",
- "description": "De werkgever heeft geen contract voor de opgegeven regeling. Doe opnieuw aangifte zonder deze regeling.",
- "descriptionFragment": "Het Loonheffingennummer moet bestaan, bekend en in gebruik zijn bij de PUO.",
- "errorType": "F",
- "lineNumber": 14,
- "linePosition": 11
}
]
}
]
}
Initiate a UPA pension declaration
Activity name : PostInitiateUpaPensionDeclarationByPayrollAdministrationId
Initiate the pension declaration for the next available period for the payrolladministration. Information about the next available periode can be obtained using the defaults endpoint (/defaults)
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Initiate declaration.
object |
Responses
Request samples
- Payload
{- "payrollPeriod": {
- "year": 2024,
- "periodNumber": 1
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Initiate UPA pension declaration for a closed year (aanmaken pensioenaangifte voorgaand jaar)
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.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
X-ValidateOnly | boolean If set to true only the validations will be performed no changes will be committed. |
Request Body schema: application/json;version=2018-01-01required
Initiate pension declaration closed year.
payrollYear | string |
Responses
Request samples
- Payload
{- "payrollYear": 2022
}
Response samples
- 202
- 400
- 401
- 403
{- "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Detail UPA pension declaration
Activity name : GetUpaPensionDeclarationByUpaPensionDeclarationId
Details of UPA pension declaration
path Parameters
upaPensionDeclarationId required | string <uuid> The unique identifier of the pension declaration. |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "messageReference": "190",
- "methodOfCreation": {
- "key": 2,
- "value": "Individueel"
}, - "payrollTaxesNumber": "111111110L46",
- "upaPensionDeclarationStatus": {
- "key": 3,
- "value": "Pensioenaangifte aangemaakt"
}, - "period": {
- "year": 2017,
- "periodNumber": 1,
- "periodId": 202101,
- "periodType": {
- "key": 2,
- "value": "month"
}, - "periodStartDate": "2021-11-01",
- "periodEndDate": "2021-11-30"
}, - "withholdingAgentName": "Ben-Hur BV Via Roma",
- "externalParty": {
- "key": 13,
- "value": "PFZW (UPA)"
}, - "sendingPartyNumber": "SWO00077",
- "requestTime": "2018-05-08T15:16:49+02:00",
- "creationTime": "2018-05-08T15:16:49+02:00",
- "approvalTime": "2018-05-08T15:16:49+02:00",
- "cancelledTime": "2018-05-08T15:16:49+02:00",
- "sentTime": "2018-05-08T15:16:49+02:00",
- "removeTime": "2018-05-08T15:16:49+02:00",
- "requestedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "approvedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "cancelledBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "removedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "responseMessages": [
- {
- "datetimeOfRegistration": "2016-01-19",
- "datetimeOfMessageReceipt": "2016-01-19",
- "responseType": {
- "key": 1,
- "value": "Ontvangstbevestiging (ACK)"
}, - "responseStatus": {
- "key": 2,
- "value": "Bericht niet OK (NOK)"
}, - "citizenServiceNumber": "042168588",
- "incomeRelationshipNumber": 12,
- "employeeNumber": 156,
- "code": "NOK",
- "description": "De werkgever heeft geen contract voor de opgegeven regeling. Doe opnieuw aangifte zonder deze regeling.",
- "descriptionFragment": "Het Loonheffingennummer moet bestaan, bekend en in gebruik zijn bij de PUO.",
- "errorType": "F",
- "lineNumber": 14,
- "linePosition": 11
}
]
}
}
Change the status of a upa pension declaration
Activity name : PatchUpaPensionDeclarationByUpaPensionDeclarationId
This endpoints changes the status of the Upa pensiondeclaration based on the provided action.
path Parameters
upaPensionDeclarationId required | string <uuid> The unique identifier of the pension declaration. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/jsonrequired
The request body contains the action (cancel / confirm)
action required | string Enum: "confirm" "cancel" The action to perform on the upa pensiondeclaration |
Responses
Request samples
- Payload
{- "action": "confirm"
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Undo upa pension declaration(verwijderen pensioenaangifte)
Activity name : PostUndoUpaPensionDeclarationByUpaPensionDeclarationId
This is a controller endpoint to perform an action. Previously 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.
By 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.
This action may only be performed successfully if the following requirements are met;
- The UPA pension declaration is the very last UPA pension declaration that has been approved and sent within this payroll administration
- 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.
Metadata : No metadata endpoint available for this controller endpoint.
Defaults : Defaults GET endpoint is available for this controller endpoint at the path .../payrolladministrations/{payrollAdministrationId}/upapensiondeclarations/undo/defaults
.
path Parameters
upaPensionDeclarationId required | string <uuid> The unique identifier of the pension declaration. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download the message of a of an UPA pension declaration
Activity name : GetMessageByUpaPensionDeclarationId
Download the message of the UPA pension declaration (pensioenaangiftebericht) in xml. Please note that this does NOT refer to the response message, but to the initial message i.e. pensioenaangiftebericht.
path Parameters
upaPensionDeclarationId required | string <uuid> The unique identifier of the pension declaration. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of identification data for external parties
Activity name: GetExternalPartyIdentificationsByProviderId
Get a list identification data for external parties at provider level
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "externalParty": {
- "key": 13,
- "value": "AZL (UPA)"
}, - "externalIdentification": "123456789"
}
]
}
Add the identification data for an external party for a provider
Activity name : PostExternalPartyIdentificationByProviderId
Add the identification data for an external party for a provider
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata
to the POST URL.
Defaults: Geen
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object <metadata> (externalPartyReadOnlyFalse) External party (externe partij) | |
externalIdentification | string (externalIdentification) <= 9 characters External identification (externe identificatie) For a UPA pension provider use the idLCr |
Responses
Request samples
- Payload
{- "externalParty": {
- "key": 13
}, - "externalIdentification": "123456789"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "externalParty": {
- "key": 13,
- "value": "AZL (UPA)"
}, - "externalIdentification": "123456789"
}
}
Details of an external party identification for a provider
Activity name : GetExternalPartyIdentificationByProviderIdAndExternalPartyIdentificationId
Get the details external party identification for a provider
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
externalPartyIdentificationId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "externalParty": {
- "key": 13,
- "value": "AZL (UPA)"
}, - "externalIdentification": "123456789"
}
]
}
Edit an external party identification record
Activity name : PutExternalPartyIdentificationByProviderIdAndExternalPartyIdentificationId
Metadata : Geen
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
externalPartyIdentificationId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
externalIdentification | string (externalIdentification) <= 9 characters External identification (externe identificatie) For a UPA pension provider use the idLCr |
Responses
Request samples
- Payload
{- "externalIdentification": "123456789"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "externalParty": {
- "key": 13,
- "value": "AZL (UPA)"
}, - "externalIdentification": "123456789"
}
}
Delete an external party identification record
Activity name : DeleteExternalPartyIdentificationByProviderIdAndExternalPartyIdentificationId
Delete an external party identification record
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
externalPartyIdentificationId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of identification data for external parties on payroll administration level
Activity name: GetExternalPartyIdentificationsByPayrollAdministrationId
Get a list identification data for external parties at payroll administration level
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "externalParty": {
- "key": 13,
- "value": "AZL (UPA)"
}, - "externalIdentification": "123456789"
}
]
}
Add the identification data for an external party for a payroll administration
Activity name : PostExternalPartyIdentificationByPayrollAdministrationId
Add the identification data for an external party 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: Geen
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object <metadata> (externalPartyReadOnlyFalse) External party (externe partij) | |
externalIdentification | string (externalIdentification) <= 9 characters External identification (externe identificatie) For a UPA pension provider use the idLCr |
Responses
Request samples
- Payload
{- "externalParty": {
- "key": 13
}, - "externalIdentification": "123456789"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "externalParty": {
- "key": 13,
- "value": "AZL (UPA)"
}, - "externalIdentification": "123456789"
}
}
Details of an external party identification for a payroll administration
Activity name : GetExternalPartyIdentificationByPayrollAdministrationIdAndExternalPartyIdentificationId
Get the details external party identification for a payroll administration
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
externalPartyIdentificationId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "externalParty": {
- "key": 13,
- "value": "AZL (UPA)"
}, - "externalIdentification": "123456789"
}
]
}
Edit an external party identification record
Activity name : PutExternalPartyIdentificationByPayrollAdministrationIdAndExternalPartyIdentificationId
Metadata : Geen
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
externalPartyIdentificationId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
externalIdentification | string (externalIdentification) <= 9 characters External identification (externe identificatie) For a UPA pension provider use the idLCr |
Responses
Request samples
- Payload
{- "externalIdentification": "123456789"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "externalParty": {
- "key": 13,
- "value": "AZL (UPA)"
}, - "externalIdentification": "123456789"
}
}
Delete an external party identification record
Activity name : DeleteExternalPartyIdentificationByPayrollAdministrationIdAndExternalPartyIdentificationId
Delete an external party identification record
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
externalPartyIdentificationId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Initiate pension declaration Collective
Activity name : PostPensionDeclarationCollectiveByBearerToken. This is a controller endpoint to perform an action.
- The endpoint starts multiple pension declarations within one provider.
- Only one pension declaration per payrolladministration / external party can be started.
path Parameters
payrollPeriodId required | integer <int32> Example: 202401 The unique identifier of the payroll period to return. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Initiate pension declaration Payload.
payrollAdministrationId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
externalPartyKey | integer The key of the external party. |
Responses
Request samples
- Payload
[- {
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "externalPartyKey": 14
}
]
Response samples
- 202
- 400
- 401
- 403
{- "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
Update pension declaration status Collective
Activity name : PatchPensionDeclarationCollectiveByBearerToken This is a controller endpoint to perform an action.
- The endpoint patches multiple pension declarations within one provider.
- Only one pension declaration per payrolladministration / external party can be patched.
path Parameters
payrollPeriodId required | integer <int32> Example: 202401 The unique identifier of the payroll period to return. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Update Pension Declaration Payload.
payrollAdministrationId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
externalPartyKey | integer The key of the external party. |
Responses
Request samples
- Payload
[- {
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "externalPartyKey": 14
}
]
Response samples
- 202
- 400
- 401
- 403
{- "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
Pension wage statement process initiation values for STIPP
Activity name : GetStippPensionWageStatementInitiationValuesByPayrollAdministrationId
The details required to start the process of a pension wage statement (PLO) for STIPP
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31",
- "testYear": false
}, - "referenceDate": "2018-10-23"
}
}
List of all the payroll runs for the pension wage statement STIPP
Activity name : GetStippPensionWageStatementPayrollRunsByPayrollAdministrationId
The list of all the payroll runs that will be included in the next pension wage statement (PLO) for STIPP. Or a list of all the payroll runs that where in cluded in the last PLO
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. If not set the system date is used. |
process required | string Enum: "Delete" "Initiate" Indicates what action is to be performed so the right set if payroll runs can be returned |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "payrollRun": {
- "payrollRunId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31",
- "testYear": false
}, - "sequenceNumberApproved": 6,
- "textPaySlip": "string",
- "textPayment": "string",
- "requestTime": "2018-05-08T15:16:49+02:00",
- "processingFinishedTime": "2018-05-08T15:16:49+02:00",
- "approvalTime": "2018-05-08T15:16:49+02:00"
}
}
]
}
Download a pension wage statement for STIPP
Activity name : PostStippDownloadPensionWageStatementByPayrollAdministrationId
Marks the payroll runs as processed and returns the pension wage statement for STIPP as a txt file.
Note: This endpoint can only be used to start a PLO for the active payroll year (actief verloningsjaar)
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
referenceDate required | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. If not set the system date is used. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
emailAddress | string [ 1 .. 40 ] The email address |
object | |
object |
Responses
Request samples
- Payload
{- "dataProvider": {
- "name": "Hendrix BV",
- "address": "Langeput straat 32, Tilburg"
}, - "contactInformation": {
- "name": "Piet Hendrix",
- "phoneNumber": "013-1345671"
}
}
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Delete the last created pension wage statement for STIPP
Activity name: DeleteStippPensionWageStatementByPayrollAdministrationId
Delete the last created pension wage statement for STIPP. Deleting is done in order of creation
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download the pension wage statement report for STIPP
Activity name : GetStippPensionWageStatementReportByPayrollAdministrationId
Acquire the pension wage statement report for STIPP for the given (payroll)year.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
reportYear required | integer Example: reportYear=2023 A valid year for which the information is requested. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Pension wage statement process initiation values for PGGM
Activity name : GetPggmPensionWageStatementInitiationValuesByPayrollAdministrationId
The details required to start the process of a pension wage statement (PLO) for PGGM
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31",
- "testYear": false
}, - "referenceDate": "2018-10-23"
}
}
List of all the payroll runs for the pension wage statement PGGM
Activity name : GetPggmPensionWageStatementPayrollRunsByPayrollAdministrationId
The list of all the payroll runs that will be included in the next pension wage statement (PLO) for PGGM.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. If not set the system date is used. |
process required | string Enum: "Delete" "Initiate" Indicates what action is to be performed so the right set if payroll runs can be returned |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "payrollRun": {
- "payrollRunId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31",
- "testYear": false
}, - "sequenceNumberApproved": 6,
- "textPaySlip": "string",
- "textPayment": "string",
- "requestTime": "2018-05-08T15:16:49+02:00",
- "processingFinishedTime": "2018-05-08T15:16:49+02:00",
- "approvalTime": "2018-05-08T15:16:49+02:00"
}
}
]
}
Download a pension wage statement for PGGM
Activity name : PostPggmDownloadPensionWageStatementByPayrollAdministrationId
Marks the payroll runs as processed and returns the pension wage statement for PGGM as a txt file.
Note: This endpoint can only be used to start a PLO for the active payroll year (actief verloningsjaar)
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
referenceDate required | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. If not set the system date is used. |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object or null | |
object <metadata> |
Responses
Request samples
- Payload
{- "dataProvider": {
- "deviatingName": "Hendrix BV",
- "deviatingConnectionNumber": 458741
}, - "sectorCompanyClassification": {
- "key": 1
}
}
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Delete the last created pension wage statement for PGGM
Activity name: DeletePggmPensionWageStatementByPayrollAdministrationId
Delete the last created pension wage statement for PGGM. Deleting is done in order of creation
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download the pension wage statement report for PGGM
Activity name : GetPggmPensionWageStatementReportByPayrollAdministrationId
Acquire the pension wage statement report for PGGM for the given (payroll)year.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
reportYear required | integer Example: reportYear=2023 A valid year for which the information is requested. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of Paww declarations
Activity name : GetPawwDeclarationsByPayrollAdministrationId
A list of Paww declarations for an administration
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "messageReference": "190",
- "methodOfCreation": {
- "key": 2,
- "value": "Individueel"
}, - "payrollTaxesNumber": "111111110L46",
- "pawwDeclarationStatus": {
- "key": 3,
- "value": "Paww aangifte aangemaakt"
}, - "period": {
- "year": 2017,
- "periodNumber": 1,
- "periodId": 202101,
- "periodType": {
- "key": 2,
- "value": "month"
}, - "periodStartDate": "2021-11-01",
- "periodEndDate": "2021-11-30"
}, - "withholdingAgentName": "Ben-Hur BV Via Roma",
- "externalParty": {
- "key": 32,
- "value": "SPAWW"
}, - "sendingPartyNumber": "SWO00077",
- "requestTime": "2018-05-08T15:16:49+02:00",
- "creationTime": "2018-05-08T15:16:49+02:00",
- "approvalTime": "2018-05-08T15:16:49+02:00",
- "cancelledTime": "2018-05-08T15:16:49+02:00",
- "sentTime": "2018-05-08T15:16:49+02:00",
- "removeTime": "2018-05-08T15:16:49+02:00",
- "requestedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "approvedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "cancelledBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "removedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "responseMessages": [
- {
- "datetimeOfRegistration": "2016-01-19",
- "datetimeOfMessageReceipt": "2016-01-19",
- "responseType": {
- "key": 1,
- "value": "Ontvangstbevestiging (ACK)"
}, - "responseStatus": {
- "key": 2,
- "value": "Bericht niet OK (NOK)"
}, - "citizenServiceNumber": "042168588",
- "incomeRelationshipNumber": 12,
- "employeeNumber": 156,
- "code": "NOK",
- "description": "De werkgever heeft geen contract voor de opgegeven regeling. Doe opnieuw aangifte zonder deze regeling.",
- "descriptionFragment": "Het Loonheffingennummer moet bestaan, bekend en in gebruik zijn bij de PUO.",
- "errorType": "F",
- "lineNumber": 14,
- "linePosition": 11
}
]
}
]
}
Initiate a Paww declaration
Activity name : PostInitiatePawwDeclarationByPayrollAdministrationId
Initiate the paww declaration for the next available period for the payrolladministration. Information about the next available periode can be obtained using the defaults endpoint (/defaults)
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Initiate declaration.
object |
Responses
Request samples
- Payload
{- "payrollPeriod": {
- "year": 2024,
- "periodNumber": 1
}
}
Response samples
- 202
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Detail Paww declaration
Activity name : GetPawwDeclarationByPawwDeclarationId
Details of Paww declaration
path Parameters
pawwDeclarationId required | string <uuid> The unique identifier of the paww declaration. |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "messageReference": "190",
- "methodOfCreation": {
- "key": 2,
- "value": "Individueel"
}, - "payrollTaxesNumber": "111111110L46",
- "pawwDeclarationStatus": {
- "key": 3,
- "value": "Paww aangifte aangemaakt"
}, - "period": {
- "year": 2017,
- "periodNumber": 1,
- "periodId": 202101,
- "periodType": {
- "key": 2,
- "value": "month"
}, - "periodStartDate": "2021-11-01",
- "periodEndDate": "2021-11-30"
}, - "withholdingAgentName": "Ben-Hur BV Via Roma",
- "externalParty": {
- "key": 32,
- "value": "SPAWW"
}, - "sendingPartyNumber": "SWO00077",
- "requestTime": "2018-05-08T15:16:49+02:00",
- "creationTime": "2018-05-08T15:16:49+02:00",
- "approvalTime": "2018-05-08T15:16:49+02:00",
- "cancelledTime": "2018-05-08T15:16:49+02:00",
- "sentTime": "2018-05-08T15:16:49+02:00",
- "removeTime": "2018-05-08T15:16:49+02:00",
- "requestedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "approvedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "cancelledBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "removedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "responseMessages": [
- {
- "datetimeOfRegistration": "2016-01-19",
- "datetimeOfMessageReceipt": "2016-01-19",
- "responseType": {
- "key": 1,
- "value": "Ontvangstbevestiging (ACK)"
}, - "responseStatus": {
- "key": 2,
- "value": "Bericht niet OK (NOK)"
}, - "citizenServiceNumber": "042168588",
- "incomeRelationshipNumber": 12,
- "employeeNumber": 156,
- "code": "NOK",
- "description": "De werkgever heeft geen contract voor de opgegeven regeling. Doe opnieuw aangifte zonder deze regeling.",
- "descriptionFragment": "Het Loonheffingennummer moet bestaan, bekend en in gebruik zijn bij de PUO.",
- "errorType": "F",
- "lineNumber": 14,
- "linePosition": 11
}
]
}
}
Change the status of a Paww declaration
Activity name : PatchPawwDeclarationByPawwDeclarationId
This endpoints changes the status of the Paww declaration based on the provided action.
path Parameters
pawwDeclarationId required | string <uuid> The unique identifier of the paww declaration. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/jsonrequired
The request body contains the action (cancel / confirm)
action required | string Enum: "confirm" "cancel" The action to perform on the Paww declaration |
Responses
Request samples
- Payload
{- "action": "confirm"
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download the message of a of an Paww declaration
Activity name : GetMessageByPawwDeclarationId
Download the message of the Paww declaration (Paww aangiftebericht) in xml. Please note that this does NOT refer to the response message, but to the initial message i.e. paww aangifte.
path Parameters
pawwDeclarationId required | string <uuid> The unique identifier of the paww declaration. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Undo PAWW declaration(deactiveer PAWW aangifte)
Activity name : PostUndoPawwDeclarationByPawwDeclarationId
PAWW = Private aanvulling WW uitkering
This is a controller endpoint to perform an action.
Previously this specific action was referred to as 'Deactiveren PAWW aangifte'. If this action is performed successfully then the PAWW declaration will be marked 'deleted' in the sense that its results will be undone. Please note that situations where an approved PAWW declaration would have to be 'undone' should generally be avoided.
By undoing the PAWW declaration for this period, it is not automatically removed from the PAWW provider. After undoing the PAWW declaration, you must recreate and confirm the PAWW declaration for this period. Please pay attention to the deadline for confirmation. Subsequently, the PAWW declaration received earlier by the PAWW provider will be overwritten by this new one.
This action may only be performed successfully if the following requirements are met:
- The PAWW declaration is the very last PAWW declaration that has been approved and sent within this payroll administration
- It is not possible to undo a PAWW declaration if there is currently a PAWW declaration 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 GET endpoint is available for this controller endpoint at the path .../payrolladministrations/{payrollAdministrationId}/pawwdeclarations/undo/defaults
.
path Parameters
pawwDeclarationId required | string <uuid> The unique identifier of the paww declaration. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Initialize the proforma environment
Activity name: PostInitializeProformaByEmployerId
Initialize a proforma environment (request the copying of data from live to proforma).
Metadata : None
Defaults : None
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
proformaType | string Enum: "WithSalaryResultsWithSalaryVariables" "WithSalaryResultsWithoutSalaryVariables" "WithoutSalaryResultsWithSalaryVariables" "WithoutSalaryResultsWithoutSalaryVariables" "WithoutEmployments" |
employeeId | string or null <uuid> If this Id is set all the employment of the specific employee will be copied to the proforma environment otherwise all employments are copied. Does not work in combination with |
Responses
Request samples
- Payload
{- "proformaType": "WithSalaryResultsWithSalaryVariables",
- "employeeId": "904d6856-6034-4624-bcbc-886188c115c5"
}
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Get the status of proforma for this employer
Activity name : GetProformaStatusByEmployerId
Get the status of proforma for this employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "status": "Inactive",
- "activeFor": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
}
Provider configuration
Activity name : GetProviderConfigurationByProviderId
Get the configuration at provider level.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "defaultProviderLogo": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "attribute": "Logo 1",
- "name": "ProviderLogo"
}
}
}
Edit provider configuration
Activity name : PutProviderConfigurationByProviderId
Edit the configuration at provider level.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object or null The default provider logo. |
Responses
Request samples
- Payload
{- "defaultProviderLogo": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "defaultProviderLogo": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "attribute": "Logo 1",
- "name": "ProviderLogo"
}
}
}
Provider payslip logo
Activity name : GetProviderPayslipLogoByProviderId
Get the provider payslip logo. This logo serves as a default logo for the payslip.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 401
- 403
{- "message": "Authorization has been denied for this request."
}
Delete the provider payslip logo
Activity name: DeleteProviderPayslipLogoByProviderId
Delete the provider payslip logo
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Upload a logo for the payslip at providerlevel.
Activity name : PostProviderPayslipLogoByProviderId
Upload a logo for the payslip at providerlevel.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Logo to be uploaded for the payslip at providerlevel.
data | string base64 encoded document file. |
mimeType | string The mimetype of the data. |
Responses
Request samples
- Payload
{- "data": "YQ==",
- "mimeType": "image/jpeg"
}
Response samples
- 201
- 400
- 401
- 403
{- "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
]
}
Provider payslip configuration
Activity name : GetProviderPayslipConfigurationByProviderId
Get the payslip configuration at provider level.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "template": {
- "key": 3,
- "value": "Zwart met Loket logo"
}, - "addressLocation": {
- "key": 3,
- "value": "Linksboven"
}, - "employeeNameDisplayMethod": {
- "key": 3,
- "value": "Voorletters Achternaam"
}, - "employeeNumberDisplayMethod": {
- "key": 3,
- "value": "Personeelsnummer"
}, - "hourlyWageDisplayMethod": {
- "key": 3,
- "value": "Uurloon"
}, - "functionDisplayMethod": {
- "key": 3,
- "value": "Standaard functie"
}, - "employmentStartDateDispayMethod": {
- "key": 3,
- "value": "Historical date"
}, - "displaySalutation": true,
- "displaySalaryScale": true,
- "displayDepartment": true
}
}
Edit provider configuration
Activity name : PutProviderPayslipConfigurationByProviderId
Edit the payslip configuration at provider level.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object <metadata> The pdf template for the payslip. | |
object <metadata> The location of the address on the payslip. | |
object <metadata> How to format the name of the employee. | |
object <metadata> Choose which employeeNumber to display. | |
object <metadata> The method to display the hourly wage on the payslip. | |
object <metadata> The method to display the function on the payslip. | |
object <metadata> The method to display the employment start date on the payslip. | |
displaySalutation | boolean Whether to display the salutation on the payslip. |
displaySalaryScale | boolean Whether to display the salary scale on the payslip. |
displayDepartment | boolean Whether to display the department on the payslip. |
Responses
Request samples
- Payload
{- "template": {
- "key": 3
}, - "addressLocation": {
- "key": 3
}, - "employeeNameDisplayMethod": {
- "key": 3
}, - "employeeNumberDisplayMethod": {
- "key": 3
}, - "hourlyWageDisplayMethod": {
- "key": 3
}, - "functionDisplayMethod": {
- "key": 3
}, - "employmentStartDateDispayMethod": {
- "key": 3
}, - "displaySalutation": true,
- "displaySalaryScale": true,
- "displayDepartment": true
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "template": {
- "key": 3,
- "value": "Zwart met Loket logo"
}, - "addressLocation": {
- "key": 3,
- "value": "Linksboven"
}, - "employeeNameDisplayMethod": {
- "key": 3,
- "value": "Voorletters Achternaam"
}, - "employeeNumberDisplayMethod": {
- "key": 3,
- "value": "Personeelsnummer"
}, - "hourlyWageDisplayMethod": {
- "key": 3,
- "value": "Uurloon"
}, - "functionDisplayMethod": {
- "key": 3,
- "value": "Standaard functie"
}, - "employmentStartDateDispayMethod": {
- "key": 3,
- "value": "Historical date"
}, - "displaySalutation": true,
- "displaySalaryScale": true,
- "displayDepartment": true
}
}
The authorization model
Activity name : GetAuthorizationModelByBearerToken
Get a list of all activities with their associated authorizations, modules and roles.
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "GetWagesByEmploymentId",
- "functionalDescription": "Ophalen van de salarisgegevens van een medewerker",
- "authorizations": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Beheer arbeidsvoorwaarden"
}
], - "modules": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Personeelsregistratie"
}
], - "roles": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Provider"
}
]
}
]
}
List groupclassifications for an provider
Activity name : GetGroupClassificationsByProviderId
Get a list of the groupclassifications for an provider.
Note: The groupclassifications defined at the provider level can be used as value for the field groupClassification at administration level.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Regio Zuid"
}
]
}
Add a groupclassification for an provider
Activity name : PostGroupClassificationByProviderId
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a groupclassification
description | string <= 50 characters The description of the groupclassification |
Responses
Request samples
- Payload
{- "description": "Regio Zuid"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Regio Zuid"
}
}
List of employee's and their ESS (WNL) status
Activity name : GetEmployeeSelfServiceByEmployerId
Get a list of all the employee's and their status regarding to ESS (werknemer.loket).
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employee": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen",
- "formattedName": "Wiel - van Bergen S.L. van de"
}, - "hasTwoFactorAuthentication": false,
- "status": "HasAccessToClient"
}
]
}
Change the ESS access for several employees
Activity name : PatchEmployeeSelfServiceAccessByEmployerId
This endpoint allows the user to change the status of access to ESS for several employees of the employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
employeeId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
action | string <= 50 characters Enum: "SendInvite" "RevokeInvite" "RevokeAccess" "ReinstateAccess" "ResendUsername" "DisableTwoFactorAuthentication" The action to be taken for the given employee |
Responses
Request samples
- Payload
[- {
- "employeeId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "action": "SendInvite"
}
]
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
Details of and employees self service portal status
Activity name : GetEmployeeSelfServiceByEmployeeId
Get the details of an employee with regards to ESS access
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "employee": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen",
- "formattedName": "Wiel - van Bergen S.L. van de"
}, - "hasTwoFactorAuthentication": false,
- "status": "HasAccessToClient"
}
}
Change the employee's self service (ESS) access
Activity name : PatchEmployeeSelfServiceAccessByEmployeeId
This endpoint allows the user to change the status of access for the employee's to ESS (Werknemer.loket).
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
employeeId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
action | string <= 50 characters Enum: "SendInvite" "RevokeInvite" "RevokeAccess" "ReinstateAccess" "ResendUsername" "DisableTwoFactorAuthentication" The action to be taken for the given employee |
Responses
Request samples
- Payload
[- {
- "employeeId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "action": "SendInvite"
}
]
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of employee's Clever access status
Activity name : GetCleverAccessStatusByEmployerId
Get a list of all the employee's and their status regarding to the Clever ESS application.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "employeeId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "status": "HasAccessToClient"
}
]
}
Change the Clever access for several employees
Activity name : PatchCleverAccessStatusByEmployerId
This endpoint allows the user to change the status of access to the Clever ESS for several employees of the employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
employeeId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
action | string <= 50 characters Enum: "SendInvite" "RevokeAccess" "ReinstateAccess" The action to be taken for the given employee |
Responses
Request samples
- Payload
[- {
- "employeeId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "action": "SendInvite"
}
]
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
List of Concept employee's and their ESS (WNL) status
Activity name : GetConceptEmployeeSelfServiceByEmployerId
Get a list of all the Concept employee's and their status regarding to ESS (werknemer.loket).
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "conceptEmployee": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen",
- "formattedName": "Wiel - van Bergen S.L. van de"
}, - "status": "HasAccessToClient"
}
]
}
Details of a Concept employee self service portal status
Activity name : GetConceptEmployeeSelfServiceByConceptEmployeeId
Get the details of a Concept employee with regards to ESS access
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "conceptEmployee": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen",
- "formattedName": "Wiel - van Bergen S.L. van de"
}, - "status": "HasAccessToClient"
}
}
Get the preboarding trajectory of a concept employee
Activity name : GetPreboardingTrajectoryByConceptEmployeeId
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "status": "open",
- "dateLastModification": "2022-04-12",
- "clientName": "Clever",
- "fragments": "[\n \"idBewijs\",\n \"persoonsGegevens\"\n]\n"
}
}
Change status of a preboarding trajectory
Activity name : PatchPreboardingTrajectoryByConceptEmployeeId
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
New status
action required | string Enum: "markAsCompleted" "markAsEndedPrematurely" The action to perform on PreboardingTrajectory |
Responses
Request samples
- Payload
{- "action": "markAsCompleted"
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Add a preboarding trajectory
Activity name : PostPreboardingTrajectoryByConceptEmployeeId
path Parameters
conceptEmployeeId required | string <uuid> The unique identifier of the concept employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
None
fragments | string or null (Fragments) JSON string containing the fragments the conceptemployee should provide in the preboarding flow |
Responses
Request samples
- Payload
{- "fragments": "[\n \"idBewijs\",\n \"persoonsGegevens\"\n]\n"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "status": "open",
- "dateLastModification": "2022-04-12",
- "clientName": "Clever",
- "fragments": "[\n \"idBewijs\",\n \"persoonsGegevens\"\n]\n"
}
}
List of provider users for an provider
Activity name : GetProviderUsersByProviderId
Get the list of users of the provider
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "loginMethod": {
- "key": 3,
- "value": "Only via SSO"
}, - "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "userSpecifiedRole": {
- "key": 3,
- "value": "Salarisadministrateur"
}, - "userCustomSpecifiedRole": "Secretariaat medewerker",
- "accessStatus": {
- "key": 3,
- "value": "Has access to Client"
}, - "hasMultiFactorAuthentication": false,
- "twoFactorAuthenticationRequired": false,
- "azureActiveDirectory": {
- "tenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Customer X Azure AD",
- "tenantRegistrationLevel": "provider"
}, - "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "userName": "User42",
- "hasIntegrations": false,
- "hasConnectedApplications": false,
- "hasAuthorisationsOnUserLevel": false,
- "dateTimeLastLogin": "2021-01-19",
- "dateTimeCreation": "2020-01-19",
- "authorizationSet": {
- "key": 3,
- "value": "Salarisadministrateur"
}
}
]
}
Create an SSO or Azure AD provider user for an provider
Activity name : PostProviderUserByProviderId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the POST URL.
Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.
Add an SSO or Azure AD user for an provider.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a user for an provider.
object <metadata> (loginMethod) The allowedlogin method for the user | |
object | |
object (ProviderUser_components-schemas-contactInformation) | |
hasAccessToPayrollingTestData | boolean (hasAccessToPayrollingTestData) Indicates if the user has access to data for payrolling test years |
object or null | |
object or null |
Responses
Request samples
- Payload
{- "loginMethod": {
- "key": 3
}, - "personalDetails": {
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "hasAccessToPayrollingTestData": false,
- "azureActiveDirectory": {
- "tenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "userName": "User123"
}, - "ssoAccount": {
- "userName": "Customer X Azure AD",
- "password": "Password%6"
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "loginMethod": {
- "key": 3,
- "value": "Only via SSO"
}, - "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "userSpecifiedRole": {
- "key": 3,
- "value": "Salarisadministrateur"
}, - "userCustomSpecifiedRole": "Secretariaat medewerker",
- "accessStatus": {
- "key": 3,
- "value": "Has access to Client"
}, - "hasMultiFactorAuthentication": false,
- "twoFactorAuthenticationRequired": false,
- "azureActiveDirectory": {
- "tenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Customer X Azure AD",
- "tenantRegistrationLevel": "provider"
}, - "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "userName": "User42",
- "hasIntegrations": false,
- "hasConnectedApplications": false,
- "hasAuthorisationsOnUserLevel": false,
- "dateTimeLastLogin": "2021-01-19",
- "dateTimeCreation": "2020-01-19",
- "authorizationSet": {
- "key": 3,
- "value": "Salarisadministrateur"
}
}
}
Details of a provider user
Activity name : GetProviderUserByUserId
Get the details of a provider user
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "loginMethod": {
- "key": 3,
- "value": "Only via SSO"
}, - "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "userSpecifiedRole": {
- "key": 3,
- "value": "Salarisadministrateur"
}, - "userCustomSpecifiedRole": "Secretariaat medewerker",
- "accessStatus": {
- "key": 3,
- "value": "Has access to Client"
}, - "hasMultiFactorAuthentication": false,
- "twoFactorAuthenticationRequired": false,
- "azureActiveDirectory": {
- "tenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Customer X Azure AD",
- "tenantRegistrationLevel": "provider"
}, - "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "userName": "User42",
- "hasIntegrations": false,
- "hasConnectedApplications": false,
- "hasAuthorisationsOnUserLevel": false,
- "dateTimeLastLogin": "2021-01-19",
- "dateTimeCreation": "2020-01-19",
- "authorizationSet": {
- "key": 3,
- "value": "Salarisadministrateur"
}
}
}
Edit the details of a provider user
Activity name : PutProviderUserByUserId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
Edit the details of a provider user
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
User to edit.
object <metadata> (loginMethod) The allowedlogin method for the user | |
object | |
object (ProviderUser_components-schemas-contactInformation) | |
object or null <metadata> (userSpecifiedRole) The Role which the user has specified. | |
userCustomSpecifiedRole | string or null (userCustomSpecifiedRole) <= 50 characters Further specification of the user role. |
hasMultiFactorAuthentication | boolean (hasMultiFactorAuthentication) Indicates if the user has multi factor authentication enabled Can only be changed from true to false. |
twoFactorAuthenticationRequired | boolean (twoFactorAuthenticationRequired) Indicates whether two factor authentication is required for the user. This setting is only available for login method: Via website en SSO |
object or null (azureActiveDirectory) |
Responses
Request samples
- Payload
{- "loginMethod": {
- "key": 3
}, - "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "userSpecifiedRole": {
- "key": 3
}, - "userCustomSpecifiedRole": "Secretariaat medewerker",
- "hasMultiFactorAuthentication": false,
- "twoFactorAuthenticationRequired": false,
- "azureActiveDirectory": {
- "tenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "loginMethod": {
- "key": 3,
- "value": "Only via SSO"
}, - "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "userSpecifiedRole": {
- "key": 3,
- "value": "Salarisadministrateur"
}, - "userCustomSpecifiedRole": "Secretariaat medewerker",
- "accessStatus": {
- "key": 3,
- "value": "Has access to Client"
}, - "hasMultiFactorAuthentication": false,
- "twoFactorAuthenticationRequired": false,
- "azureActiveDirectory": {
- "tenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Customer X Azure AD",
- "tenantRegistrationLevel": "provider"
}, - "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "userName": "User42",
- "hasIntegrations": false,
- "hasConnectedApplications": false,
- "hasAuthorisationsOnUserLevel": false,
- "dateTimeLastLogin": "2021-01-19",
- "dateTimeCreation": "2020-01-19",
- "authorizationSet": {
- "key": 3,
- "value": "Salarisadministrateur"
}
}
}
Delete a specific provider user record
Activity name : DeleteProviderUserByUserId
Delete a provider user
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Reinstate or Revoke access to Loket for a provider user (clients)
Activity name : PatchManageProviderUserLoketAccessByUserId
Metadata : No metadata
Defaults : No defaults
Reinstate or Revoke access to Loket.
This endpoint can also be used to block access to just the loket classic interface
Note: Only blocks access to "Loket2" and "Loket3" client. Conections for other clients are not affected by this action.
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
action | string Enum: "RevokeAccess" "ReinstateAccess" "RevokeAccessLoketClassicOnly" "ReinstateAccessLoketClassicOnly" indicates the action to perform. |
Responses
Request samples
- Payload
{- "action": "RevokeAccess"
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "loginMethod": {
- "key": 3,
- "value": "Only via SSO"
}, - "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "userSpecifiedRole": {
- "key": 3,
- "value": "Salarisadministrateur"
}, - "userCustomSpecifiedRole": "Secretariaat medewerker",
- "accessStatus": {
- "key": 3,
- "value": "Has access to Client"
}, - "hasMultiFactorAuthentication": false,
- "twoFactorAuthenticationRequired": false,
- "azureActiveDirectory": {
- "tenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Customer X Azure AD",
- "tenantRegistrationLevel": "provider"
}, - "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "userName": "User42",
- "hasIntegrations": false,
- "hasConnectedApplications": false,
- "hasAuthorisationsOnUserLevel": false,
- "dateTimeLastLogin": "2021-01-19",
- "dateTimeCreation": "2020-01-19",
- "authorizationSet": {
- "key": 3,
- "value": "Salarisadministrateur"
}
}
}
Send an invite to a provider user
Activity name : PostInviteProviderUserByProviderId
Metadata : Possible options for fields of the type 'metadata' can be acquired via /providers/providers/{providerId}/users/metadata
Defaults : Default values for a new object can be acquired by via /providers/providers/{providerId}/users/defaults
Send an invite to an user for an provider user.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Send an invite to a user
object | |
object (ProviderUser_components-schemas-contactInformation) | |
twoFactorAuthenticationRequired | boolean (twoFactorAuthenticationRequired) Indicates whether two factor authentication is required for the user. This setting is only available for login method: Via website en SSO |
hasAccessToPayrollingTestData | boolean (hasAccessToPayrollingTestData) Indicates if the user has access to data for payrolling test years |
destinationForSecret | string [ 3 .. 15 ] characters ^(0\d{9})$|(^(\+(?=31)\d{11}$)|^(\+(?!31)(?!0... The destination phonenumber to sent the secret to during registration. |
Responses
Request samples
- Payload
{- "personalDetails": {
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "twoFactorAuthenticationRequired": false,
- "hasAccessToPayrollingTestData": false,
- "destinationForSecret": "0612345678"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "loginMethod": {
- "key": 3,
- "value": "Only via SSO"
}, - "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "userSpecifiedRole": {
- "key": 3,
- "value": "Salarisadministrateur"
}, - "userCustomSpecifiedRole": "Secretariaat medewerker",
- "accessStatus": {
- "key": 3,
- "value": "Has access to Client"
}, - "hasMultiFactorAuthentication": false,
- "twoFactorAuthenticationRequired": false,
- "azureActiveDirectory": {
- "tenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Customer X Azure AD",
- "tenantRegistrationLevel": "provider"
}, - "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "userName": "User42",
- "hasIntegrations": false,
- "hasConnectedApplications": false,
- "hasAuthorisationsOnUserLevel": false,
- "dateTimeLastLogin": "2021-01-19",
- "dateTimeCreation": "2020-01-19",
- "authorizationSet": {
- "key": 3,
- "value": "Salarisadministrateur"
}
}
}
Resend or Revoke an invite for a provider user
Activity name : PatchProviderUserInviteByUserId
Metadata : Possible options for fields of the type 'metadata' can be acquired via /providers/users/metadata
Defaults : No defaults
Resend or Revoke an invite for an provider user.
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
action | string Enum: "Resend" "Revoke" indicates the action to perform. |
object or null Only include this object if action is Resend |
Responses
Request samples
- Payload
{- "action": "Resend",
- "resendInformation": {
- "destinationForSecret": "0612345678",
- "providerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "twoFactorAuthenticationRequired": false
}
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "loginMethod": {
- "key": 3,
- "value": "Only via SSO"
}, - "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "userSpecifiedRole": {
- "key": 3,
- "value": "Salarisadministrateur"
}, - "userCustomSpecifiedRole": "Secretariaat medewerker",
- "accessStatus": {
- "key": 3,
- "value": "Has access to Client"
}, - "hasMultiFactorAuthentication": false,
- "twoFactorAuthenticationRequired": false,
- "azureActiveDirectory": {
- "tenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Customer X Azure AD",
- "tenantRegistrationLevel": "provider"
}, - "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "userName": "User42",
- "hasIntegrations": false,
- "hasConnectedApplications": false,
- "hasAuthorisationsOnUserLevel": false,
- "dateTimeLastLogin": "2021-01-19",
- "dateTimeCreation": "2020-01-19",
- "authorizationSet": {
- "key": 3,
- "value": "Salarisadministrateur"
}
}
}
List authorization groups (teams) for the given provider
Activity name : GetAuthorizationGroupsByProviderId
Get a list of all authorization groups (teams) for the given provider
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Team oost Nederland",
- "numberOfLinkedUsers": 435,
- "numberOfLinkedEmployers": 435,
- "authorizationSet": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "HR Gebruiker"
}
}
]
}
Create an authorization group (team) for the provider.
Activity name : PostAuthorizationGroupByProviderId
Metadata : No metadata
Defaults : no defaults
Add a new authorization group (team) for the provider.
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add an authorization group (team) for an provider.
description | string [ 1 .. 50 ] characters The description of the authorization group (team) |
Responses
Request samples
- Payload
{- "description": "Team oost Nederland"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Team oost Nederland",
- "numberOfLinkedUsers": 435,
- "numberOfLinkedEmployers": 435,
- "authorizationSet": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "HR Gebruiker"
}
}
}
Details of an authorization group
Activity name : GetAuthorizationGroupByAuthorizationGroupId
Get the details of an authorization group
path Parameters
authorizationGroupId required | string <uuid> The unique identifier of a authorization group |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Team oost Nederland",
- "numberOfLinkedUsers": 435,
- "numberOfLinkedEmployers": 435,
- "authorizationSet": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "HR Gebruiker"
}
}
}
Edit the details of an authorization group
Activity name : PutAuthorizationGroupByAuthorizationGroupId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
Edit the details of an authorization group
path Parameters
authorizationGroupId required | string <uuid> The unique identifier of a authorization group |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Authorization group to edit.
description | string [ 1 .. 50 ] characters The description of the authorization group (team) |
Responses
Request samples
- Payload
{- "description": "Team oost Nederland"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Team oost Nederland",
- "numberOfLinkedUsers": 435,
- "numberOfLinkedEmployers": 435,
- "authorizationSet": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "HR Gebruiker"
}
}
}
Delete an authorization group
Activity name : DeleteAuthorizationGroupByAuthorizationGroupId
Delete an authorization group
path Parameters
authorizationGroupId required | string <uuid> The unique identifier of a authorization group |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
The employers for the authorization group
Activity name : GetAuthorizationGroupEmployersByAuthorizationGroupId
List the employers for the authorization group.
path Parameters
authorizationGroupId required | string <uuid> The unique identifier of a authorization group |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "companyName": "Voorbeeld B.V.",
- "administrationNumber": "SR2",
- "groupCode": 40,
- "isLinked": true
}
}
Manage the authorization group employers
Activity name : PatchAuthorizationGroupEmployersByAuthorizationGroupId
Manage the employers linked to the authorization group. Only the employers with isLinked set to true are saved all other employers will be disabled.
path Parameters
authorizationGroupId required | string <uuid> The unique identifier of a authorization group |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Responses
Request samples
- Payload
[- "string"
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
The users for the authorization group
Activity name : GetAuthorizationGroupUsersByAuthorizationGroupId
List the users for the authorization group.
path Parameters
authorizationGroupId required | string <uuid> The unique identifier of a authorization group |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "userName": "User42",
- "isLinked": true,
- "hasAuthorizationsOnUserLevel": true,
- "hasMultipleTeams": true,
- "hasIntegrations": false
}
}
Manage the authorization group users
Activity name : PatchAuthorizationGroupUsersByAuthorizationGroupId
Manage the users linked to the authorization group. Only the users with isEnabled set to true are saved all other users will be disabled.
path Parameters
authorizationGroupId required | string <uuid> The unique identifier of a authorization group |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
An array of userId GUID that are to be linked to the authorization group. UserId that are not supplied will be unlinked.
Responses
Request samples
- Payload
[- "string"
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of users for an employer
Activity name : GetEmployerUsersByEmployerId
Get the list of users of the employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "loginMethod": {
- "key": 3,
- "value": "Only via SSO"
}, - "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "userSpecifiedRole": {
- "key": 3,
- "value": "Salarisadministrateur"
}, - "userCustomSpecifiedRole": "Secretariaat medewerker",
- "hasAccessToPayrollingTestData": false,
- "accessStatus": {
- "key": 3,
- "value": "Has access to Client"
}, - "hasMultiFactorAuthentication": false,
- "twoFactorAuthenticationRequired": false,
- "azureActiveDirectory": {
- "tenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Customer X Azure AD",
- "tenantRegistrationLevel": "provider"
}, - "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "userName": "User42",
- "isDepartmentManager": false,
- "isLinkedToMultipleEmployers": false,
- "hasIntegrations": false,
- "hasConnectedApplications": false,
- "dateTimeLastLogin": "2021-01-19",
- "dateTimeCreation": "2020-01-19"
}
]
}
Create an SSO or Azure AD user for an employer
Activity name : PostEmployerUserByEmployerId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the POST URL.
Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.
Add an SSO or Azure AD user for an employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a user for an employer.
object <metadata> (loginMethod) The allowedlogin method for the user | |
object | |
object (EmployerUser_components-schemas-contactInformation) | |
hasAccessToPayrollingTestData | boolean (hasAccessToPayrollingTestData) Indicates if the user has access to data for payrolling test years |
object or null | |
object or null |
Responses
Request samples
- Payload
{- "loginMethod": {
- "key": 3
}, - "personalDetails": {
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "hasAccessToPayrollingTestData": false,
- "azureActiveDirectory": {
- "tenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "userName": "User123"
}, - "ssoAccount": {
- "userName": "Customer X Azure AD",
- "password": "Password%6"
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "loginMethod": {
- "key": 3,
- "value": "Only via SSO"
}, - "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "userSpecifiedRole": {
- "key": 3,
- "value": "Salarisadministrateur"
}, - "userCustomSpecifiedRole": "Secretariaat medewerker",
- "hasAccessToPayrollingTestData": false,
- "accessStatus": {
- "key": 3,
- "value": "Has access to Client"
}, - "hasMultiFactorAuthentication": false,
- "twoFactorAuthenticationRequired": false,
- "azureActiveDirectory": {
- "tenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Customer X Azure AD",
- "tenantRegistrationLevel": "provider"
}, - "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "userName": "User42",
- "isDepartmentManager": false,
- "isLinkedToMultipleEmployers": false,
- "hasIntegrations": false,
- "hasConnectedApplications": false,
- "dateTimeLastLogin": "2021-01-19",
- "dateTimeCreation": "2020-01-19"
}
}
Reinstate or Revoke access to Loket for an employer user (clients)
Activity name : PatchManageEmployerUserLoketAccessByUserId
Metadata : No metadata
Defaults : No defaults
Reinstate or Revoke access to Loket.
This endpoint can also be used to block access to just the loket classic interface
Note: Only blocks access to "Loket2" en "Loket3" client. Conections for other clients are not affected by this action.
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
action | string Enum: "RevokeAccess" "ReinstateAccess" "RevokeAccessLoketClassicOnly" "ReinstateAccessLoketClassicOnly" indicates the action to perform. |
Responses
Request samples
- Payload
{- "action": "RevokeAccess"
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "loginMethod": {
- "key": 3,
- "value": "Only via SSO"
}, - "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "userSpecifiedRole": {
- "key": 3,
- "value": "Salarisadministrateur"
}, - "userCustomSpecifiedRole": "Secretariaat medewerker",
- "hasAccessToPayrollingTestData": false,
- "accessStatus": {
- "key": 3,
- "value": "Has access to Client"
}, - "hasMultiFactorAuthentication": false,
- "twoFactorAuthenticationRequired": false,
- "azureActiveDirectory": {
- "tenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Customer X Azure AD",
- "tenantRegistrationLevel": "provider"
}, - "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "userName": "User42",
- "isDepartmentManager": false,
- "isLinkedToMultipleEmployers": false,
- "hasIntegrations": false,
- "hasConnectedApplications": false,
- "dateTimeLastLogin": "2021-01-19",
- "dateTimeCreation": "2020-01-19"
}
}
Send an invite to an email address to create an employer user
Activity name : PostInviteEmployerUserByEmployerId
Metadata : Possible options for fields of the type 'metadata' can be acquired via /providers/employers/{employerId}/users/metadata
Defaults : Default values for a new object can be acquired by via /providers/employers/{employerId}/users/defaults
Send an invite to an user for an employer user.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Send an invite to a user
object | |
object (EmployerUser_components-schemas-contactInformation) | |
twoFactorAuthenticationRequired | boolean (twoFactorAuthenticationRequired) Indicates whether two factor authentication is required for the user. This setting is only available for login method: Via website en SSO |
hasAccessToPayrollingTestData | boolean (hasAccessToPayrollingTestData) Indicates if the user has access to data for payrolling test years |
destinationForSecret | string [ 3 .. 15 ] characters ^(0\d{9})$|(^(\+(?=31)\d{11}$)|^(\+(?!31)(?!0... The destination phonenumber to sent the secret to during registration. |
Responses
Request samples
- Payload
{- "personalDetails": {
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "twoFactorAuthenticationRequired": false,
- "hasAccessToPayrollingTestData": false,
- "destinationForSecret": "0612345678"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "loginMethod": {
- "key": 3,
- "value": "Only via SSO"
}, - "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "userSpecifiedRole": {
- "key": 3,
- "value": "Salarisadministrateur"
}, - "userCustomSpecifiedRole": "Secretariaat medewerker",
- "hasAccessToPayrollingTestData": false,
- "accessStatus": {
- "key": 3,
- "value": "Has access to Client"
}, - "hasMultiFactorAuthentication": false,
- "twoFactorAuthenticationRequired": false,
- "azureActiveDirectory": {
- "tenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Customer X Azure AD",
- "tenantRegistrationLevel": "provider"
}, - "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "userName": "User42",
- "isDepartmentManager": false,
- "isLinkedToMultipleEmployers": false,
- "hasIntegrations": false,
- "hasConnectedApplications": false,
- "dateTimeLastLogin": "2021-01-19",
- "dateTimeCreation": "2020-01-19"
}
}
Resend or Revoke an invite for an employer user
Activity name : PatchEmployerUserInviteByUserId
Metadata : Possible options for fields of the type 'metadata' can be acquired via /providers/employers/{employerId}/users/metadata
Defaults : No defaults
Resend or Revoke an invite for an employer user.
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
action | string Enum: "Resend" "Revoke" indicates the action to perform. |
object or null Only include this object if action is Resend |
Responses
Request samples
- Payload
{- "action": "Resend",
- "resendInformation": {
- "destinationForSecret": "0612345678",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "twoFactorAuthenticationRequired": false
}
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "loginMethod": {
- "key": 3,
- "value": "Only via SSO"
}, - "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "userSpecifiedRole": {
- "key": 3,
- "value": "Salarisadministrateur"
}, - "userCustomSpecifiedRole": "Secretariaat medewerker",
- "hasAccessToPayrollingTestData": false,
- "accessStatus": {
- "key": 3,
- "value": "Has access to Client"
}, - "hasMultiFactorAuthentication": false,
- "twoFactorAuthenticationRequired": false,
- "azureActiveDirectory": {
- "tenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Customer X Azure AD",
- "tenantRegistrationLevel": "provider"
}, - "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "userName": "User42",
- "isDepartmentManager": false,
- "isLinkedToMultipleEmployers": false,
- "hasIntegrations": false,
- "hasConnectedApplications": false,
- "dateTimeLastLogin": "2021-01-19",
- "dateTimeCreation": "2020-01-19"
}
}
Details of an employer user
Activity name : GetEmployerUserByUserId
Get the details of an employer user
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "loginMethod": {
- "key": 3,
- "value": "Only via SSO"
}, - "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "userSpecifiedRole": {
- "key": 3,
- "value": "Salarisadministrateur"
}, - "userCustomSpecifiedRole": "Secretariaat medewerker",
- "hasAccessToPayrollingTestData": false,
- "accessStatus": {
- "key": 3,
- "value": "Has access to Client"
}, - "hasMultiFactorAuthentication": false,
- "twoFactorAuthenticationRequired": false,
- "azureActiveDirectory": {
- "tenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Customer X Azure AD",
- "tenantRegistrationLevel": "provider"
}, - "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "userName": "User42",
- "isDepartmentManager": false,
- "isLinkedToMultipleEmployers": false,
- "hasIntegrations": false,
- "hasConnectedApplications": false,
- "dateTimeLastLogin": "2021-01-19",
- "dateTimeCreation": "2020-01-19"
}
}
Edit the details of an employer user user
Activity name : PutEmployerUserByUserId
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
Edit the details of an employer user
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
User to edit.
object <metadata> (loginMethod) The allowedlogin method for the user | |
object | |
object (EmployerUser_components-schemas-contactInformation) | |
object or null <metadata> (userSpecifiedRole) The Role which the user has specified. | |
userCustomSpecifiedRole | string or null (userCustomSpecifiedRole) <= 50 characters Further specification of the user role. |
hasAccessToPayrollingTestData | boolean (hasAccessToPayrollingTestData) Indicates if the user has access to data for payrolling test years |
hasMultiFactorAuthentication | boolean (hasMultiFactorAuthentication) Indicates if the user has multi factor authentication enabled Can only be changed from true to false. |
twoFactorAuthenticationRequired | boolean (twoFactorAuthenticationRequired) Indicates whether two factor authentication is required for the user. This setting is only available for login method: Via website en SSO |
object or null (schemas-azureActiveDirectory) |
Responses
Request samples
- Payload
{- "loginMethod": {
- "key": 3
}, - "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "userSpecifiedRole": {
- "key": 3
}, - "userCustomSpecifiedRole": "Secretariaat medewerker",
- "hasAccessToPayrollingTestData": false,
- "hasMultiFactorAuthentication": false,
- "twoFactorAuthenticationRequired": false,
- "azureActiveDirectory": {
- "tenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "loginMethod": {
- "key": 3,
- "value": "Only via SSO"
}, - "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "userSpecifiedRole": {
- "key": 3,
- "value": "Salarisadministrateur"
}, - "userCustomSpecifiedRole": "Secretariaat medewerker",
- "hasAccessToPayrollingTestData": false,
- "accessStatus": {
- "key": 3,
- "value": "Has access to Client"
}, - "hasMultiFactorAuthentication": false,
- "twoFactorAuthenticationRequired": false,
- "azureActiveDirectory": {
- "tenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Customer X Azure AD",
- "tenantRegistrationLevel": "provider"
}, - "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "userName": "User42",
- "isDepartmentManager": false,
- "isLinkedToMultipleEmployers": false,
- "hasIntegrations": false,
- "hasConnectedApplications": false,
- "dateTimeLastLogin": "2021-01-19",
- "dateTimeCreation": "2020-01-19"
}
}
Delete a specific employer user record
Activity name : DeleteEmployerUserByUserId
Delete an employer user
path Parameters
userId required | string <uuid> The unique identifier of an user |
query Parameters
transferNotificationsTo | string <uuid> The unique identifier of the user to transfer unread notifications to |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Information about the employer user to determine if the user can be deleted
Activity name : GetInformationForEmployerUserDeleteByEmployerIdAndUserId
Get information about the user to determine if the user can be deleted or unlinked from the given employer.
path Parameters
userId required | string <uuid> The unique identifier of an user |
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "numberOfUnreadNotifications": 34,
- "numberOfActiveConnections": 0,
- "numberOfActiveIntegrations": 3,
- "numberOfLinkedEmployers": 3
}
}
unlink employer user and employer
Activity name : DeleteLinkBetweenEmployerUserAndEmployerByEmployerIdAndUserId
Delete the link between an employer user and the given employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
userId required | string <uuid> The unique identifier of an user |
query Parameters
transferNotificationsTo | string <uuid> The unique identifier of the user to transfer unread notifications to |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Link an existing employer user to this employer.
Activity name : PostLinkExistingEmployerUserByEmployerId
Metadata : No metadata endpoint
Defaults : No default values
Link an existing employer user to this employer.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Link an existing user to this employer.
userId | string <uuid> (idReadOnlyFalse) ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
departments | Array of strings or null <uuid> [ items <uuid > ] |
Responses
Request samples
- Payload
{- "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "departments": [
- "904d6856-6034-4624-bcbc-886188c115c5"
]
}
Response samples
- 200
- 400
- 401
- 403
{- "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "loginMethod": {
- "key": 3,
- "value": "Only via SSO"
}, - "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "userSpecifiedRole": {
- "key": 3,
- "value": "Salarisadministrateur"
}, - "userCustomSpecifiedRole": "Secretariaat medewerker",
- "hasAccessToPayrollingTestData": false,
- "accessStatus": {
- "key": 3,
- "value": "Has access to Client"
}, - "hasMultiFactorAuthentication": false,
- "twoFactorAuthenticationRequired": false,
- "azureActiveDirectory": {
- "tenant": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Customer X Azure AD",
- "tenantRegistrationLevel": "provider"
}, - "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "userName": "User42",
- "isDepartmentManager": false,
- "isLinkedToMultipleEmployers": false,
- "hasIntegrations": false,
- "hasConnectedApplications": false,
- "dateTimeLastLogin": "2021-01-19",
- "dateTimeCreation": "2020-01-19"
}
}
Get the list of departments that the user has access to
Activity name: GetEmployerUsersLinkedDepartmentsByEmployerId
Get the list of departments that the user has access to
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "departments": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop Binnendienst",
- "hasAccessToSubDepartments": false
}
]
}
]
}
Link or unlink departments from an user.
Activity name: PatchEmployerUserLinkedDepartmentsByEmployerIdAndUserId
This endpoint enables the user to link or unlink multiple 'linkages' with one call.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/jsonrequired
The request body
departmentId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier (GUID/UUID) of the department |
action | string Enum: "link" "unlink" The action to perform. |
hasAccessToSubDepartments | boolean Indicates whether the user will have access to departments that are configured as sub-departments of the selected department. |
Responses
Request samples
- Payload
[- {
- "departmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "action": "link",
- "hasAccessToSubDepartments": false
}
]
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of employers linked to the user
Activity name : GetLinkedEmployersByUserId
List of employers accessible by the user
path Parameters
userId required | string <uuid> The unique identifier of an user |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "companyName": "Voorbeeld B.V.",
- "address": {
- "street": "Voordijk",
- "houseNumber": 12,
- "postalCode": "1234AA",
- "city": "Leiden"
}, - "providerSettings": {
- "administrationNumber": "SR2",
- "groupCode": 40
}, - "contactInformation": {
- "phoneNumber": "(088) 31 11150"
}, - "contact": {
- "name": "Henk de Vries",
- "phoneNumber": "013-12345678"
}, - "branch": {
- "key": 2,
- "value": "Landbouw en jacht"
}
}
]
}
The notification settings for the user
Activity name : GetEmployerUserNotificationSettingsByUserId
List the configuration per notification for the user
path Parameters
userId required | string <uuid> The unique identifier of an user |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "notificationType": {
- "key": 3,
- "value": "Start of employment"
}, - "createNumberOfDaysBeforeEvent": 30,
- "sendMailWhenNotificationIsCreated": false,
- "receiveDepartmentSignalsOnly": false,
- "isEnabled": true
}
]
}
Manage the employer user notification settings
Activity name : PatchEmployerUserNotificationSettingsByUserId
Manage the employer user notifications and notificationSet
.
Note: Currently the notificationSet
doesnt do anything in regard to which notifications are enabled or disabled. It only functions as a guide to the GUI to visualize and save the notifications linked to the notificationSet
Only the changes supplied are processed existing records not supplied in the request body will be left unchanged. e.g. If three notifications are enabled for the user and a patch is performed with in the body one new notification with the isEnabled
= true. The result will be that the user has 4 enabled notifications.
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object or null <metadata> (notificationSet) | |
Array of objects (schemas-notifications) |
Responses
Request samples
- Payload
{- "notificationSet": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "notifications": [
- {
- "notificationType": {
- "key": 3
}, - "createNumberOfDaysBeforeEvent": 30,
- "sendMailWhenNotificationIsCreated": false,
- "receiveDepartmentSignalsOnly": false,
- "isEnabled": true
}
]
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
The notification set for the user
Activity name : GetEmployerUserNotificationSetByUserId
The configured notification set for the user
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Salarisadministrateur"
}
}
List of all the clients for the provider user
Activity name: GetProviderUserClientsByUserId
List of all the clients for the provider user
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "lastLogin": "2018-05-08T15:16:49+02:00",
- "accessStatus": {
- "key": 3,
- "value": "Has access to Client"
}, - "client": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC-I",
- "consumerFriendlyName": "ABC international"
}
}
]
}
List of all the clients for the employer user
Activity name: GetEmployerUserClientsByUserId
List of all the clients for the employer user
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "lastLogin": "2018-05-08T15:16:49+02:00",
- "accessStatus": {
- "key": 3,
- "value": "Has access to Client"
}, - "client": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC-I",
- "consumerFriendlyName": "ABC international"
}
}
]
}
List of recommended actions for an employer, per logged on user
Activity name : GetRecomendedActionsByEmployerId
Get the list of recommended actions of the employer, per logged on user
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "rank": 1,
- "url": "{URI}/providers/employers/123/salarisverwerking/starten",
- "action": {
- "key": 1,
- "value": "Starten verloning"
}
}
]
}
Get current user
Activity name: GetUserByToken
Properties of the current user.
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "user": {
- "userSpecifiedRole": {
- "key": 3,
- "value": "Salarisadministrateur"
}, - "userCustomSpecifiedRole": "Secretariaat medewerker"
},
}
}
Basic properties of a user
Activity name: GetUserMinimizedByUserId
Basic properties of a user.
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen",
- "formattedName": "S. van Bergen"
}
}
}
Edit current user
Activity name: PutUserByToken
Edit some of the properties of the current user. Metadata can be acquired by adding /metadata to the path.
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
User to edit.
object or null | |
object or null | |
object or null |
Responses
Request samples
- Payload
{- "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567"
}, - "user": {
- "userSpecifiedRole": {
- "key": 3
}, - "userCustomSpecifiedRole": "Secretariaat medewerker"
}
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "contactInformation": {
- "placeOfEmployment": "Amsterdam office",
- "phoneNumber": "+31 13-1234567",
- "emailAddress": "[email protected]"
}, - "user": {
- "userSpecifiedRole": {
- "key": 3,
- "value": "Salarisadministrateur"
}, - "userCustomSpecifiedRole": "Secretariaat medewerker"
},
}
}
Photo of an user
Activity name : GetUserPhotoByToken
Photo of the user to use as an avatar/profile picture
Caching: This resource changes very infrequently and can be cached for a longer time.
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 401
- 403
{- "message": "Authorization has been denied for this request."
}
Post user photo
Activity name : PostUserPhotoByToken
Photo of the user to use as an avatar/profile picture
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Logo to be uploaded for the user.
data | string base64 encoded document file. |
mimeType | string The mimetype of the data. |
Responses
Request samples
- Payload
{- "data": "YQ==",
- "mimeType": "image/jpeg"
}
Response samples
- 401
- 403
{- "message": "Authorization has been denied for this request."
}
Delete user photo
Activity name : DeleteUserPhotoByToken
Photo of the user to use as an avatar/profile picture
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of all the integrations for the logon user
Activity name: GetIntegrationsByBearerToken
List of all the integrations 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
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "createdOn": "2018-05-08T15:16:49+02:00",
- "lastLogin": "2018-05-08T15:16:49+02:00",
- "isBlocked": true,
- "application": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC international",
- "isBlocked": true,
- "isAvailableInMarketplace": true
}
}
]
}
List of all the integrations for the employer user
Activity name: GetEmployerUserIntegrationsByUserId List of all the integrations for the employer user
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "createdOn": "2018-05-08T15:16:49+02:00",
- "lastLogin": "2018-05-08T15:16:49+02:00",
- "isBlocked": true,
- "application": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC international",
- "isBlocked": true,
- "isAvailableInMarketplace": true
}
}
]
}
Change an integration
Activity name: PutEmployerUserIntegrationByUserIdAndApplicationId
Change the integration
path Parameters
userId required | string <uuid> The unique identifier of an user |
applicationId required | string <uuid> The unique identifier of an integration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
isBlocked | boolean Indicates whether the application user combination is blocked (for this single user) |
Responses
Request samples
- Payload
{- "isBlocked": true
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "createdOn": "2018-05-08T15:16:49+02:00",
- "lastLogin": "2018-05-08T15:16:49+02:00",
- "isBlocked": true,
- "application": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC international",
- "isBlocked": true,
- "isAvailableInMarketplace": true
}
}
}
Delete an integration
Activity name: DeleteEmployerUserIntegrationByUserIdAndApplicationId
Delete an integration
path Parameters
userId required | string <uuid> The unique identifier of an user |
applicationId required | string <uuid> The unique identifier of an integration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download the application logo
Activity name: GetEmployerUserIntegrationLogoByUserIdAndApplicationId
This activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.
Caching: This resource changes very infrequently and can be cached for a longer time.
Get the logo of the application. In case no logo is know the service will return a 404.
path Parameters
userId required | string <uuid> The unique identifier of an user |
applicationId required | string <uuid> The unique identifier of an application |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 401
- 403
{- "message": "Authorization has been denied for this request."
}
List of all the integrations for a provider user
Activity name: GetProviderUserIntegrationsByUserId
List of all the integrations for the provider user
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "createdOn": "2018-05-08T15:16:49+02:00",
- "lastLogin": "2018-05-08T15:16:49+02:00",
- "isBlocked": true,
- "application": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC international",
- "isBlocked": true,
- "isAvailableInMarketplace": true
}
}
]
}
Change an integration for a provider user
Activity name: PutProviderUserIntegrationByUserIdAndApplicationId
Change the integration
path Parameters
userId required | string <uuid> The unique identifier of an user |
applicationId required | string <uuid> The unique identifier of an integration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
isBlocked | boolean Indicates whether the application user combination is blocked (for this single user) |
Responses
Request samples
- Payload
{- "isBlocked": true
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "createdOn": "2018-05-08T15:16:49+02:00",
- "lastLogin": "2018-05-08T15:16:49+02:00",
- "isBlocked": true,
- "application": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC international",
- "isBlocked": true,
- "isAvailableInMarketplace": true
}
}
}
Delete an integration for a provider user
Activity name: DeleteProviderUserIntegrationByUserIdAndApplicationId
Delete an integration
path Parameters
userId required | string <uuid> The unique identifier of an user |
applicationId required | string <uuid> The unique identifier of an integration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Download the application logo
Activity name: GetProviderUserIntegrationLogoByUserIdAndApplicationId
This activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.
Caching: This resource changes very infrequently and can be cached for a longer time.
Get the logo of the application. In case no logo is know the service will return a 404.
path Parameters
userId required | string <uuid> The unique identifier of an user |
applicationId required | string <uuid> The unique identifier of an application |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 401
- 403
{- "message": "Authorization has been denied for this request."
}
List of all the clients for the logon user
Activity name: GetClientsByBearerToken
List of all the clients for the logon user
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "lastLogin": "2018-05-08T15:16:49+02:00",
- "accessStatus": {
- "key": 3,
- "value": "Has access to Client"
}, - "client": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC-I",
- "consumerFriendlyName": "ABC international"
}
}
]
}
Get user filter settings
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.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "employmentFilter": {
- "filterOnDepartments": [
- {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
], - "filterOnFunctions": [
- {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
], - "filterOnEmployedStatus": "AllEmployments",
- "filterOnOnCallEmployment": true,
- "filterOnAdministrations": [
- {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
], - "filterOnEmploymentTypes": [
- {
- "key": 1
}
], - "referenceDate": "2024-01-01"
}
}
}
Edit the user filter settings
Activity name: PutUserFilterSettingsByEmployerId
Edit the filter settings for the current user for the employer.
Metadata can be acquired by adding /metadata to the path.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Filters
object |
Responses
Request samples
- Payload
{- "employmentFilter": {
- "filterOnDepartments": [
- {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
], - "filterOnFunctions": [
- {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
], - "filterOnEmployedStatus": "AllEmployments",
- "filterOnOnCallEmployment": true,
- "filterOnAdministrations": [
- {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
], - "filterOnEmploymentTypes": [
- {
- "key": 1
}
], - "referenceDate": "2024-01-01"
}
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "employmentFilter": {
- "filterOnDepartments": [
- {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
], - "filterOnFunctions": [
- {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
], - "filterOnEmployedStatus": "AllEmployments",
- "filterOnOnCallEmployment": true,
- "filterOnAdministrations": [
- {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
], - "filterOnEmploymentTypes": [
- {
- "key": 1
}
], - "referenceDate": "2024-01-01"
}
}
}
List of user responsibilities for the provider
Activity name : GetUserResponsibilitiesByProviderId
Get the list of user responsibilities for the provider
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Payroll profesional",
- "origin": "System"
}
]
}
Create an user responsibility for a provider
Activity name : PostUserResponsibilityByProviderId
Create a new user responsibility record for the given provider
Metadata : No metadata
Defaults : No defaults
path Parameters
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
User responsibility
name | string [ 1 .. 70 ] characters name of the user responsibility |
Responses
Request samples
- Payload
{- "name": "Payroll profesional"
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Payroll profesional",
- "origin": "System"
}
}
Edit an user responsibility
Activity name : PutUserResponsibilityByProviderIdAndUserResponsibilityId
Edit the details of an user responsibility
Metadata : No metadata
path Parameters
userResponsibilityId required | string <uuid> The unique identifier of a user responsibility |
providerId required | string <uuid> The unique identifier of a provider |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
User responsibility to edit.
name | string [ 1 .. 70 ] characters name of the user responsibility |
Responses
Request samples
- Payload
{- "name": "Payroll profesional"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Payroll profesional",
- "origin": "System"
}
}
List of user responsibilities for the employer
Activity name : GetUserResponsibilitiesByEmployerId
Get the list of user responsibilities for the employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Payroll profesional",
- "numberOfLinkedUsers": 3,
- "origin": "System"
}
]
}
List of employer users and their linked status to the user responsibility for the given employer
Activity name : GetLinkedUsersByEmployerIdAndUserResponsibilityId
Get the list of all employer users and if they are linked to the user responsibility for the given employer or not
path Parameters
userResponsibilityId required | string <uuid> The unique identifier of a user responsibilityId |
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "personalDetails": {
- "firstName": "Susan",
- "initials": "S.L.",
- "prefix": "van",
- "lastName": "Bergen"
}, - "userName": "User42",
- "isLinked": true
}
]
}
Manage the users linked to the user responsibility
Activity name : PatchLinkedUsersByEmployerIdAndUserResponsibilityId
Manage the users linked to the user responsibility for the employer
path Parameters
userResponsibilityId required | string <uuid> The unique identifier of a user responsibilityId |
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
id | string <uuid> (idReadOnlyFalse) ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
isLinked | boolean If true the user is linked to the given responsibility for the given employer Link or unlink resposibilty for the user and the given employer. |
Responses
Request samples
- Payload
[- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "isLinked": true
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of responsibilities for the user
Activity name : GetUserResponsibilitiesByEmployerIdAndUserId
Get the list of responsibilities for the user
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
userId required | string <uuid> The unique identifier of an user |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Payroll profesional",
- "isLinked": true
}
]
}
Manage the responsibilities linked to the user
Activity name : PatchUserResponsibilitiesByEmployerIdAndUserId
Manage the responsibility linked to the user
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
id | string <uuid> (idReadOnlyFalse) ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
isLinked | boolean If true the user is linked to the given responsibility for the given employer |
Responses
Request samples
- Payload
[- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "isLinked": true
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of all the connected applications for the logon user
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
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Connection for HpGL",
- "key": 21,
- "applicationProvider": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Precies online"
}, - "createdOn": "2018-05-08T15:16:49+02:00",
- "lastUsedOn": "2018-05-08T15:16:49+02:00"
}
]
}
Finish the OAuth flow for a connected application
Activity name : PatchConnectedApplicationByBearerToken
This endpoint will either create a new connected application or refresh the refresh_token for an existing connected application.
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01optional
state | string The state as given in the first step of the Oauth code flow |
code | string The new refresh token of the Oauth refresh flow |
Responses
Request samples
- Payload
{- "state": "lshjgoi7329o4nsldjuf0s9udjfsd09fsdjfpsd98234ln",
- "code": "lshjgoi7329o4nsldjuf0s9udjfsd09fsdjfpsd98234ln0498yjhkjk379u4yijrhkg394yurjeogk39y54oerkhgf24pwrojgfkl94ypuroejghkf9y4rpjhkd93y45evrjhdk943y5uprjeok"
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Connection for HpGL",
- "key": 21,
- "applicationProvider": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Precies online"
}, - "createdOn": "2018-05-08T15:16:49+02:00",
- "lastUsedOn": "2018-05-08T15:16:49+02:00"
}
}
Initiate the OAuth flow to connect to an application
Activity name : PatchInitiateConnectedApplicationByBearerToken
A successfull call to this endpoint will return an OAuth URL that can be used to start the OAuth flow for the current user.
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
description | string or null <= 250 characters |
object <metadata> |
Responses
Request samples
- Payload
{- "description": "Precies online",
- "applicationProvider": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
}
}
Initiate the OAuth flow to refresh a connection for an application
Activity name : PatchRefreshConnectedApplicationByBearerToken
A 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.
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
id | string <uuid> (idReadOnlyFalse) ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
Responses
Request samples
- Payload
{- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
}
}
Delete a connected application
Activity name: DeleteConnectedApplicationByConnectedApplicationId
Delete a connected application
path Parameters
connectedApplicationId required | string <uuid> The unique identifier of a connected application |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of all the connected applications for the logon user
Activity name: GetConnectedApplicationsProviderUserByUserId
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
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Connection for HpGL",
- "key": 21,
- "applicationProvider": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Precies online"
}, - "createdOn": "2018-05-08T15:16:49+02:00",
- "lastUsedOn": "2018-05-08T15:16:49+02:00"
}
]
}
Initiate the OAuth flow to connect to an application
Activity name: PatchInitiateConnectedApplicationProviderUserByUserId
A successfull call to this endpoint will return an OAuth URL that can be used to start the OAuth flow for the current user.
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
description | string or null <= 250 characters |
object <metadata> |
Responses
Request samples
- Payload
{- "description": "Precies online",
- "applicationProvider": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
}
}
Initiate the OAuth flow to refresh a connection for an application
Activity name: PatchRefreshConnectedApplicationProviderUserByUserId
A 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.
path Parameters
userId required | string <uuid> The unique identifier of an user |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
id | string <uuid> (idReadOnlyFalse) ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
Responses
Request samples
- Payload
{- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
}
}
Delete a connected application
Activity name: DeleteConnectedApplicationProviderUserByConnectedApplicationId
Delete a connected application
path Parameters
connectedApplicationId required | string <uuid> The unique identifier of a connected application |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Paygrade metadata for concept employee
Activity name : GetConceptEmployeePayGradeMetaDataByPayrollAdministrationIdAndPayscaleKeyAndPayGradeKey
Acquire data on a specific paygrade, this consists of a list of paygrade values and their respective startDates.
If a valid date
parameter is included in the call, the list will consists of one item that is applicable for that date.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
payscaleKey required | integer Key for specific payscale |
paygradeKey required | integer Key for specific paygrade |
query Parameters
date | string <date> A valid date (xxxx-xx-xx) |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
[- [
- {
- "startDate": "2018-01-01",
- "value": 1153.1
}
]
]
PayGradeAmounts for the employments
Activity name : GetActualPayGradeAmountsByPayrollAdministrationId
Provides the PayGradeAmounts on a specific date for all PayScales of the payrolladministration's employments. This information can be used to create new wage records.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
[- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payScale": {
- "key": 1,
- "value": "Glastuinbouw maand, Loongebouw A"
}, - "payGrade": {
- "key": 1,
- "value": "Schaal B1, 15 jaar",
- "payGradeAmount": {
- "startDate": "2018-01-01",
- "value": 1153.1
}
}
}
]
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).
List of wages for an employment
Activity name : GetWagesByEmploymentId
Get the list of wages for the employment
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "1995-05-21",
- "endDate": "2019-08-24",
- "payrollPeriodType": {
- "key": 1,
- "value": "Maand"
}, - "grossWage": 2300,
- "grossWageType": {
- "key": 2,
- "value": "hourly"
}, - "isGrossWageFullTime": true,
- "netWage": 2400,
- "netWageType": {
- "key": 1,
- "value": "hourly"
}, - "employerCosts": 3500,
- "employerCostsType": {
- "key": 1,
- "value": "hourly"
}, - "payScale": {
- "key": 1,
- "value": "Glastuinbouw maand, Loongebouw A"
}, - "payGrade": {
- "key": 1,
- "value": "Schaal B1, 15 jaar"
}, - "applyPayGrade": true
}
]
}
Create an wage for an employment
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.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Wage to add to the employment.
startDate | string <date> The start date for the information in the record. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. Note It is possible to have no wage record. |
grossWage | number or null <double> [ 0.01 .. 999999.99 ] The gross wage for the employee |
object or null <metadata> Indicates whether the | |
netWage | number or null <double> [ 0.01 .. 999999.99 ] Net wage for the employment |
object or null <metadata> 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. | |
employerCosts | number or null <double> [ 0.01 .. 99999.99 ] The cost for the employer for this employee. |
object or null <metadata> 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. | |
object or null <metadata> 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
| |
object or null <metadata> 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.
| |
applyPayGrade | boolean or null Apply pay grade indicates that after submitting the record the server will replace the value of |
Responses
Request samples
- Payload
{- "startDate": "1995-05-21",
- "grossWage": 2300,
- "grossWageType": {
- "key": 2
}, - "netWage": 2400,
- "netWageType": {
- "key": 1
}, - "employerCosts": 3500,
- "employerCostsType": {
- "key": 1
}, - "payScale": {
- "key": 1
}, - "payGrade": {
- "key": 1
}, - "applyPayGrade": true
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "1995-05-21",
- "endDate": "2019-08-24",
- "payrollPeriodType": {
- "key": 1,
- "value": "Maand"
}, - "grossWage": 2300,
- "grossWageType": {
- "key": 2,
- "value": "hourly"
}, - "isGrossWageFullTime": true,
- "netWage": 2400,
- "netWageType": {
- "key": 1,
- "value": "hourly"
}, - "employerCosts": 3500,
- "employerCostsType": {
- "key": 1,
- "value": "hourly"
}, - "payScale": {
- "key": 1,
- "value": "Glastuinbouw maand, Loongebouw A"
}, - "payGrade": {
- "key": 1,
- "value": "Schaal B1, 15 jaar"
}, - "applyPayGrade": true
}
}
Details of a single wage
Activity name : GetWageByWageId
Get the details of a single wage
path Parameters
wageId required | string <uuid> The unique identifier of a wage |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "1995-05-21",
- "endDate": "2019-08-24",
- "payrollPeriodType": {
- "key": 1,
- "value": "Maand"
}, - "grossWage": 2300,
- "grossWageType": {
- "key": 2,
- "value": "hourly"
}, - "isGrossWageFullTime": true,
- "netWage": 2400,
- "netWageType": {
- "key": 1,
- "value": "hourly"
}, - "employerCosts": 3500,
- "employerCostsType": {
- "key": 1,
- "value": "hourly"
}, - "payScale": {
- "key": 1,
- "value": "Glastuinbouw maand, Loongebouw A"
}, - "payGrade": {
- "key": 1,
- "value": "Schaal B1, 15 jaar"
}, - "applyPayGrade": true
}
}
Edit a wage
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.
path Parameters
wageId required | string <uuid> The unique identifier of a wage |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Wage to edit.
startDate | string <date> The start date for the information in the record. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. Note It is possible to have no wage record. |
grossWage | number or null <double> [ 0.01 .. 999999.99 ] The gross wage for the employee |
object or null <metadata> Indicates whether the | |
netWage | number or null <double> [ 0.01 .. 999999.99 ] Net wage for the employment |
object or null <metadata> 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. | |
employerCosts | number or null <double> [ 0.01 .. 99999.99 ] The cost for the employer for this employee. |
object or null <metadata> 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. | |
object or null <metadata> 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
| |
object or null <metadata> 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.
| |
applyPayGrade | boolean or null Apply pay grade indicates that after submitting the record the server will replace the value of |
Responses
Request samples
- Payload
{- "startDate": "1995-05-21",
- "grossWage": 2300,
- "grossWageType": {
- "key": 2
}, - "netWage": 2400,
- "netWageType": {
- "key": 1
}, - "employerCosts": 3500,
- "employerCostsType": {
- "key": 1
}, - "payScale": {
- "key": 1
}, - "payGrade": {
- "key": 1
}, - "applyPayGrade": true
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "1995-05-21",
- "endDate": "2019-08-24",
- "payrollPeriodType": {
- "key": 1,
- "value": "Maand"
}, - "grossWage": 2300,
- "grossWageType": {
- "key": 2,
- "value": "hourly"
}, - "isGrossWageFullTime": true,
- "netWage": 2400,
- "netWageType": {
- "key": 1,
- "value": "hourly"
}, - "employerCosts": 3500,
- "employerCostsType": {
- "key": 1,
- "value": "hourly"
}, - "payScale": {
- "key": 1,
- "value": "Glastuinbouw maand, Loongebouw A"
}, - "payGrade": {
- "key": 1,
- "value": "Schaal B1, 15 jaar"
}, - "applyPayGrade": true
}
}
Delete a specific wage record
Activity name : DeleteWageByWageId
Delete a wage record for the employment
path Parameters
wageId required | string <uuid> The unique identifier of a wage |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Minimumwage for an employment
Activity name : GetMinimumWageByEmploymentId
This endpoint calculates the minimumwage for an employment.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
referenceDate | string <date> Example: referenceDate=2022-01-01 Set a reference date for choosing the date dependent data. |
paygradeKey | integer The Paygrade (age) to use for calculating the minimumwage. When not supplied, the age is calculated. |
payscaleKey required | integer The Payscale to use for calculating the minimumwage The following payscales are supported: -1 Wettelijk minimumloon, maandloon -2 Wettelijk minimumloon, 4 weken -3 Wettelijk minimumloon, uurloon |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "referenceDate": "2024-05-21",
- "payScale": {
- "key": -1
}, - "payGrade": {
- "key": 18,
- "amount": 2040.37
}
}
}
List of wage proposals for the employments of an employer
Activity name : GetWageProposalsByEmployerId
Returns a list of wage proposals for the employments of the employer. A wage proposal is created when an employment reaches the criteria set for the next tier of wage. E.G the minimum wage is linked to the age of a person so a wage proposal is created 60 days befor the birthday of an employment linked to the minimum wage and configured for wage proposals. Via this functionality the created wage proposal can be approved or rejected resulting in either a new wage record updated to reflect the correct wage or in case of a rejection the employment is disabled for wage proposals.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payScale": {
- "key": 1,
- "value": "Glastuinbouw maand, Loongebouw A"
}, - "grossWageType": {
- "key": 2,
- "value": "hourly"
}, - "currentPayGrade": {
- "key": 1,
- "value": "Schaal B1, 15 jaar"
}, - "currentGrossWage": 23,
- "proposedPayGrade": {
- "key": 1,
- "value": "Schaal B1, 15 jaar"
}, - "proposedGrossWage": 23,
- "startDateProposal": "2017-11-01",
- "proposalReason": {
- "key": 1,
- "value": "Birthday"
}, - "status": {
- "key": 1,
- "value": "Open"
}, - "employmentInformation": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employeeNumber": 156,
- "firstName": "Susan",
- "formattedName": "Wiel - van Bergen S.L. van de",
- "incomeRelationshipNumber": 12,
- "payrollAdministration": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "ABC accountants",
- "clientNumber": 1234,
- "description": "Bakker"
}, - "function": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Directeur",
- "group": "internal"
}, - "department": {
- "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "code": 2,
- "description": "Verkoop"
}
}
}
]
}
Accept or reject wage proposals
Activity name : PatchWageProposalsByWageProposalId
Accept or reject wage proposals
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
id required | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier (a GUID/UUID) |
action required | string Enum: "accept" "reject" The action to perform on the wage proposal resulting in a change of
|
Responses
Request samples
- Payload
[- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "action": "accept"
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Perform a wage projection
Activity name : PostWageProjectionByEmploymentId
This endpoint can only be used for employments that are already known in the loket.nl system.
Metadata : No metadata endpoint available for this controller endpoint.
Defaults : No defaults endpoint available for this controller endpoint.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
object or null This endpoint can only be used for employments that are already known in the loket.nl system. If however you want to perform a calculation with different parameters then that are known in the loket system they can be set here | |
calculateUsingNextYearsValues | boolean or null Default: false 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." |
Responses
Request samples
- Payload
{- "deviations": {
- "startDate": "1995-05-21",
- "percentageChange": 25,
- "hoursPerWeek": 37.5
}, - "calculateUsingNextYearsValues": true
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriods": [
- {
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31",
- "testYear": false
}, - "payslipTypes": [
- {
- "payslipType": {
- "key": 1,
- "value": "Normaal strook"
}, - "payrollComponentResults": [
- {
- "payrollComponent": {
- "key": 1,
- "value": "Uren gewerkt",
- "category": {
- "key": null,
- "value": null
}, - "column": {
- "key": null,
- "value": null
}, - "costsEmployer": {
- "key": null,
- "value": null
}
}, - "value": 40,
- "valueSpecialTariff": 144
}
]
}
]
}
]
}
}
Perform a wage projection based on a default CLA configuration
Activity name : PostWageprojectionBasedOnDefaultClaConfigurationByEmploymentId
This endpoint can be used to calculate a wage projection based on a default collective labor agreement (CLA) configuration. The input fields allow for certain customizations.
Metadata : No metadata endpoint available for this controller endpoint.
Defaults : No defaults endpoint available for this controller endpoint.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
grossWage | number <double> [ 0.01 .. 999999.99 ] The grosswage per payroll period |
hoursPerWeek | number <double> [ 0.01 .. 99.99 ] The hours per week te be used in the wage calculation. Please note that currently this endpoint will always calculate as if the hours provided are full time hours. |
dateOfBirth | string <date> The date of birth |
object or null | |
object or null | |
applyPayrollTaxDeduction | boolean or null Indicates whether payroll tax deduction is to be applied (loonheffingskorting) |
object or null | |
object or null | |
object or null | |
object or null Deviations allow the user to calculate the difference between the current wage and the wage after certain deviations. If no deviations are required set the object to NULL | |
calculateUsingNextYearsValues | boolean or null Default: false 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." |
Responses
Request samples
- Payload
{- "grossWage": 3500,
- "hoursPerWeek": 24.5,
- "dateOfBirth": "1995-05-21",
- "holidayAllowance": {
- "percentage": 8,
- "resultPayrollComponent": {
- "key": 82
}
}, - "additionalPayrollPeriod": {
- "percentage": 8,
- "resultPayrollComponent": {
- "key": 83
}
}, - "applyPayrollTaxDeduction": false,
- "companyCar": {
- "fiscalAddition": 345.87,
- "fiscalAdditionPeriod": "Year"
}, - "deductions": {
- "net": 50.87,
- "gross": 50.87
}, - "payments": {
- "net": 50.87,
- "gross": 50.87
}, - "deviations": {
- "grossWagePercentageChange": 25,
- "hoursPerWeek": 37.5
}, - "calculateUsingNextYearsValues": true
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriods": [
- {
- "payrollPeriod": {
- "year": 2017,
- "periodNumber": 1,
- "periodStartDate": "2018-01-01",
- "periodEndDate": "2018-01-31",
- "testYear": false
}, - "payslipTypes": [
- {
- "payslipType": {
- "key": 1,
- "value": "Normaal strook"
}, - "payrollComponentResults": [
- {
- "payrollComponent": {
- "key": 1,
- "value": "Uren gewerkt",
- "category": {
- "key": null,
- "value": null
}, - "column": {
- "key": null,
- "value": null
}, - "costsEmployer": {
- "key": null,
- "value": null
}
}, - "value": 40,
- "valueSpecialTariff": 144
}
]
}
]
}
]
}
}
Wage projection Collective labor agreements defaults
Activity name : GetClaDataForWageProjectionByCollectiveLaborAgreementId
Get de configuration of a specific Collective labor agreement. This configuration (data) can then be used (as input) to perform a wage calculation or wage projection with.
path Parameters
collectiveLaborAgreementId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveLaborAgreement": {
- "name": "Voorbeeld B.V.",
- "baseForCalculation": [
- {
- "key": 1,
- "description": "vakantie toeslag",
- "resultPayrollComponent": {
- "key": 82,
- "description": "Output, VAKANTIE TOESL"
}, - "baseType": {
- "key": 1,
- "value": "Vakantiebijslag"
}, - "percentage": 8
}
], - "employments": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
], - "nextYear": {
- "available": true,
- "status": {
- "key": 1,
- "value": "Definitive"
}, - "year": 2017
}
}
}
}
List of collective labor agreements (CLA)
Activity name : GetCollectiveLaborAgreementsByUserId
Get a list of all collective labor agreements (CLA) accessible to the current user
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "name": "Voorbeeld B.V."
}
]
}
Get data to create an importfile
Activity name : GetWageImportDataByPayrollAdministrationId
Returns, for the given payrolladministration, a set of data that can be used as a base for importing wage through a csv file.
Note that on importing, the columnnames must be in Dutch. (Clientnr PersnrVerl Persnr Naam Ingangsdatum Basisloon BasisloonEenheid Nettoloon NettoloonEenheid Loonkosten LoonkostenEenheid)
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "clientNumber": 20720,
- "payrollEmployeeNumber": 202,
- "employeeNumber": 156,
- "formattedName": "Jong, I",
- "startDate": "2023-11-01",
- "grossWage": 2300,
- "grossWageTypeKey": 2,
- "netWage": 2400,
- "netWageTypeKey": 1,
- "employerCosts": 3500,
- "employerCostsTypeKey": 1
}
]
}
Import wage via a csv file
Activity name : PostWageImportDataByPayrollAdministrationId
Imports a csv file containing wage records.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
csv file to be uploaded.
mimeType | string Value: "text/csv" The type of file to import. Currently only csv is supported |
data | string base64 encoded file. |
Responses
Request samples
- Payload
{- "mimeType": "text/csv",
- "data": "YQ=="
}
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
List deviating hourly wage
Activity name : GetDeviatingHourlyWagesByEmploymentId
Get a list of the deviating hourly wages of the employment.
Note: Loket.nl has different ways to register deviating hourly wage.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "payrollComponent": {
- "key": 70,
- "description": "LOON/SALARIS"
}, - "value": 50.87
}
]
}
Add a deviating hourly wage for an employment
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.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a deviating hourly wage
startDate | string <date> (DeviatingHourlyWage_components-schemas-startDate) The date on which this DeviatingHouryWage starts. A (broken chain)[./#section/Data/Date-chains] per DeviatingHouryWage is maintained within this resource. So multiple DeviatingHouryWages can be active at the same time but one specific DeviatingHouryWage can never be active multiple times at the same time. |
endDate | string or null <date> (DeviatingHourlyWage_components-schemas-endDate) The end date of the entity. The date is up to and including. |
object <metadata> (schemas-payrollComponent) 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.
| |
value | number (value) [ 0.01 .. 99999.99 ] ^(\d{1,5})(\.\d{1,2})?$ The value for the selected payroll component. |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "payrollComponent": {
- "key": 70
}, - "value": 50.87
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "payrollComponent": {
- "key": 70,
- "description": "LOON/SALARIS"
}, - "value": 50.87
}
}
Details of an deviating hourly wage
Activity name : GetDeviatingHourlyWageByDeviatingHourlyWageId
Get the details of a deviating hourly wage
path Parameters
deviatingHourlyWageId required | string <uuid> The unique identifier of the record |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "payrollComponent": {
- "key": 70,
- "description": "LOON/SALARIS"
}, - "value": 50.87
}
]
}
Edit a deviating hourly wage record
Activity name : PutDeviatingHourlyWageByDeviatingHourlyWageId
Metadata : No metadata as payrollComponent
is read only in the PUT.
path Parameters
deviatingHourlyWageId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
startDate | string <date> (DeviatingHourlyWage_components-schemas-startDate) The date on which this DeviatingHouryWage starts. A (broken chain)[./#section/Data/Date-chains] per DeviatingHouryWage is maintained within this resource. So multiple DeviatingHouryWages can be active at the same time but one specific DeviatingHouryWage can never be active multiple times at the same time. |
endDate | string or null <date> (DeviatingHourlyWage_components-schemas-endDate) The end date of the entity. The date is up to and including. |
value | number (value) [ 0.01 .. 99999.99 ] ^(\d{1,5})(\.\d{1,2})?$ The value for the selected payroll component. |
Responses
Request samples
- Payload
{- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "value": 50.87
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "2018-01-01",
- "endDate": "2018-10-23",
- "payrollComponent": {
- "key": 70,
- "description": "LOON/SALARIS"
}, - "value": 50.87
}
}
Delete a deviating hourly wage record
Activity name : DeleteDeviatingHourlyWageByDeviatingHourlyWageId
Delete an existing deviating hourly wage record
path Parameters
deviatingHourlyWageId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
List of costs per hour for an employment
Activity name: GetCostPerHourByEmploymentId
Get the list of costs per hour for an employment
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
includeEstimation | boolean Example: includeEstimation=true include an estimation if no cost per unit records are present |
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriods": {
- "id": 202001,
- "year": 2020,
- "periodNumber": 1,
- "startDate": "2020-01-01",
- "endDate": "2020-01-31"
}, - "costPerHour": 21.2,
- "registrationMethod": {
- "key": 1,
- "value": "Verloning"
}
}
]
}
Add a cost per hour for an employment
Activity name : PostCostPerHourByEmploymentId
Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata
to the POST URL.
Defaults: Defaults can be acquired(GET)by adding /defaults
to the POST URL.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Add a cost per hour
object The period of the kpu record. | |
costPerHour | number <double> [ -99999.99 .. 99999.99 ] The cost per hour for the employment |
Responses
Request samples
- Payload
{- "payrollPeriods": {
- "id": 202001
}, - "costPerHour": 21.2
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriods": {
- "id": 202001,
- "year": 2020,
- "periodNumber": 1,
- "startDate": "2020-01-01",
- "endDate": "2020-01-31"
}, - "costPerHour": 21.2,
- "registrationMethod": {
- "key": 1,
- "value": "Verloning"
}
}
}
Details of cost per hour
Activity name : GetCostPerHourByCostPerHourId
Get the details of a cost per hour record
path Parameters
costPerHourId required | string <uuid> The unique identifier of the cost per hour record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriods": {
- "id": 202001,
- "year": 2020,
- "periodNumber": 1,
- "startDate": "2020-01-01",
- "endDate": "2020-01-31"
}, - "costPerHour": 21.2,
- "registrationMethod": {
- "key": 1,
- "value": "Verloning"
}
}
]
}
Edit a cost per hour record
Activity name : PutCostperhourByCostperhourId
Metadata : No metadata.
path Parameters
costPerHourId required | string <uuid> The unique identifier of the cost per hour record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
costPerHour | number <double> [ -99999.99 .. 99999.99 ] The cost per hour for the employment |
Responses
Request samples
- Payload
{- "costPerHour": 21.2
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollPeriods": {
- "id": 202001,
- "year": 2020,
- "periodNumber": 1,
- "startDate": "2020-01-01",
- "endDate": "2020-01-31"
}, - "costPerHour": 21.2,
- "registrationMethod": {
- "key": 1,
- "value": "Verloning"
}
}
}
Delete a cost per hour record
Activity name : DeleteCostPerHourByCostPerHourId
Delete an existing cost per hour record
path Parameters
costPerHourId required | string <uuid> The unique identifier of the cost per hour record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Create wages for multiple employments
Activity name : PostCollectiveWageByEmployerId
Create new grosswage records for multiple employments of an employer
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Wages to add.
employmentId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
startDate | string <date> The start date for the information in the record. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. Note It is possible to have no wage record. |
grossWage | number or null <double> [ 0.01 .. 999999.99 ] The gross wage for the employee |
Responses
Request samples
- Payload
[- {
- "employmentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "startDate": "1995-05-21",
- "grossWage": 2300
}
]
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}
Cancel a workflow
Activity name : PatchCancelWorkflowByWorkflowId
Allows the employee to cancel the workflow. Cancelation is only allowed when no actions have yet been taken for the workflow.
path Parameters
workflowId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Workflows assigned to the user
Activity name: GetAssignedWorkflowsByEmployerId
Get the list workflows that are assigned to the user or the role of the user.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "status": {
- "key": 1,
- "value": "In progress"
}, - "functionalStatus": {
- "key": 1,
- "value": "Rejected"
}, - "canBeEditedByInitiator": true,
- "canBeCancelledByInitiator": true,
- "currentTask": {
- "type": "InputTask"
}, - "assignees": [
- {
- "role": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Employer"
}, - "userResponsibility": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Payroll professional"
}
}
], - "trigger": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Address change for employee"
}, - "workflowTemplate": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Approval by employer"
}, - "allowedTransitions": {
- "description": "Controleer de vergoedingen",
- "httpVerb": "POST",
- "transitions": [
- {
- "action": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Approve",
- "data": { }
}
]
}, - "comment": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "timestamp": "2019-11-23T11:14:06Z",
- "text": "Moving house"
}, - "initiatedOn": "2019-11-23T11:14:06Z",
- "initiatedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "lastModifiedOn": "2019-11-23T11:14:06Z",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "apiPayload": "{\"phoneNumber\":\"040-1234567\",\"mobilePhoneNumber\":\"06-12345678\",\"emailAddress\":\"[email protected]\",\"comment\":\"Clever contact workflow!\"}",
- "apiParams": {
- "employeeId": "d037bf68-d783-423b-b8e0-45aff6fe46b6",
- "contactId": "d037bf68-d783-423b-b8e0-45aff6fe46b6"
}, - "comments": [
- {
- "commentedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "commentedOn": "2019-11-23T11:14:06Z",
- "comment": "Comment to initiator"
}
], - "apiViewModel": "{\"phoneNumber\":\"040-1234567\",\"mobilePhoneNumber\":\"06-12345678\",\"emailAddress\":\"[email protected]\",\"comment\":\"Clever contact workflow!\"}"
}
]
}
Workflows initiated by the user
Activity name: GetInitiatedWorkflowsByBearerToken
Get the workflows that are initiated by the user.
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "status": {
- "key": 1,
- "value": "In progress"
}, - "functionalStatus": {
- "key": 1,
- "value": "Rejected"
}, - "canBeEditedByInitiator": true,
- "canBeCancelledByInitiator": true,
- "currentTask": {
- "type": "InputTask"
}, - "assignees": [
- {
- "role": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Employer"
}, - "userResponsibility": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Payroll professional"
}
}
], - "trigger": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Address change for employee"
}, - "workflowTemplate": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Approval by employer"
}, - "allowedTransitions": {
- "description": "Controleer de vergoedingen",
- "httpVerb": "POST",
- "transitions": [
- {
- "action": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Approve",
- "data": { }
}
]
}, - "comment": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "timestamp": "2019-11-23T11:14:06Z",
- "text": "Moving house"
}, - "initiatedOn": "2019-11-23T11:14:06Z",
- "initiatedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "lastModifiedOn": "2019-11-23T11:14:06Z",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "apiPayload": "{\"phoneNumber\":\"040-1234567\",\"mobilePhoneNumber\":\"06-12345678\",\"emailAddress\":\"[email protected]\",\"comment\":\"Clever contact workflow!\"}",
- "apiParams": {
- "employeeId": "d037bf68-d783-423b-b8e0-45aff6fe46b6",
- "contactId": "d037bf68-d783-423b-b8e0-45aff6fe46b6"
}, - "comments": [
- {
- "commentedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "commentedOn": "2019-11-23T11:14:06Z",
- "comment": "Comment to initiator"
}
], - "apiViewModel": "{\"phoneNumber\":\"040-1234567\",\"mobilePhoneNumber\":\"06-12345678\",\"emailAddress\":\"[email protected]\",\"comment\":\"Clever contact workflow!\"}"
}
]
}
Workflows for the employer
Activity name: GetWorkflowsByEmployerId
Get the list of all workflows for an employer. All as in both open as finished workflows are returned.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "status": {
- "key": 1,
- "value": "In progress"
}, - "functionalStatus": {
- "key": 1,
- "value": "Rejected"
}, - "canBeEditedByInitiator": true,
- "canBeCancelledByInitiator": true,
- "currentTask": {
- "type": "InputTask"
}, - "assignees": [
- {
- "role": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Employer"
}, - "userResponsibility": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Payroll professional"
}
}
], - "trigger": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Address change for employee"
}, - "workflowTemplate": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Approval by employer"
}, - "allowedTransitions": {
- "description": "Controleer de vergoedingen",
- "httpVerb": "POST",
- "transitions": [
- {
- "action": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Approve",
- "data": { }
}
]
}, - "comment": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "timestamp": "2019-11-23T11:14:06Z",
- "text": "Moving house"
}, - "initiatedOn": "2019-11-23T11:14:06Z",
- "initiatedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "lastModifiedOn": "2019-11-23T11:14:06Z",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "apiPayload": "{\"phoneNumber\":\"040-1234567\",\"mobilePhoneNumber\":\"06-12345678\",\"emailAddress\":\"[email protected]\",\"comment\":\"Clever contact workflow!\"}",
- "apiParams": {
- "employeeId": "d037bf68-d783-423b-b8e0-45aff6fe46b6",
- "contactId": "d037bf68-d783-423b-b8e0-45aff6fe46b6"
}, - "comments": [
- {
- "commentedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "commentedOn": "2019-11-23T11:14:06Z",
- "comment": "Comment to initiator"
}
], - "apiViewModel": "{\"phoneNumber\":\"040-1234567\",\"mobilePhoneNumber\":\"06-12345678\",\"emailAddress\":\"[email protected]\",\"comment\":\"Clever contact workflow!\"}"
}
]
}
Details of a workflow
Activity name: GetWorkflowByWorkflowId
Get the details of a workflow
path Parameters
workflowId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "status": {
- "key": 1,
- "value": "In progress"
}, - "functionalStatus": {
- "key": 1,
- "value": "Rejected"
}, - "canBeEditedByInitiator": true,
- "canBeCancelledByInitiator": true,
- "currentTask": {
- "type": "InputTask"
}, - "assignees": [
- {
- "role": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Employer"
}, - "userResponsibility": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Payroll professional"
}
}
], - "trigger": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Address change for employee"
}, - "workflowTemplate": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Approval by employer"
}, - "allowedTransitions": {
- "description": "Controleer de vergoedingen",
- "httpVerb": "POST",
- "transitions": [
- {
- "action": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Approve",
- "data": { }
}
]
}, - "comment": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "timestamp": "2019-11-23T11:14:06Z",
- "text": "Moving house"
}, - "initiatedOn": "2019-11-23T11:14:06Z",
- "initiatedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "lastModifiedOn": "2019-11-23T11:14:06Z",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "apiPayload": "{\"phoneNumber\":\"040-1234567\",\"mobilePhoneNumber\":\"06-12345678\",\"emailAddress\":\"[email protected]\",\"comment\":\"Clever contact workflow!\"}",
- "apiParams": {
- "employeeId": "d037bf68-d783-423b-b8e0-45aff6fe46b6",
- "contactId": "d037bf68-d783-423b-b8e0-45aff6fe46b6"
}, - "comments": [
- {
- "commentedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "commentedOn": "2019-11-23T11:14:06Z",
- "comment": "Comment to initiator"
}
], - "apiViewModel": "{\"phoneNumber\":\"040-1234567\",\"mobilePhoneNumber\":\"06-12345678\",\"emailAddress\":\"[email protected]\",\"comment\":\"Clever contact workflow!\"}"
}
}
Allows the user to transition the workflow.
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.
path Parameters
workflowId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
action | string <uuid> |
description | string |
input | string or null |
comment | string or null [ 1 .. 1000 ] characters leave a comment to the initiator of the workflow |
Responses
Request samples
- Payload
{- "description": "Approve",
- "action": "fabf3b25-abf9-4e8c-a8f7-81400d1b0e96"
}
Response samples
- 202
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Manage the workflow triggers for the employer. Workflow triggers are triggers that trigger a workflow.
Get Workflow Triggers by Employer ID
Activity name: GetWorkflowTriggersByEmployerId Fetches 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.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Adreswijziging",
- "category": "WNL",
- "workflowTemplate": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
]
}
Manage the workflow templates for the employer. Workflow template define what happens when a workflow is triggered.
Get Workflow Template
Activity name: GetWorkflowTemplateByWorkflowTemplateId
Get a workflow template by its ID. Workflow templates define what happens when a workflow is triggered.
path Parameters
workflowTemplateId required | string <uuid> The unique identifier of the workflow template. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "tasks": [
- {
- "taskId": 1,
- "taskType": "Notification",
- "description": "string",
- "sendEmail": true,
- "assignees": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "assigneeType": "UserType",
- "description": "string",
- "numberOfLinkedUsers": 3
}
]
}
]
}
}
Edit a workflow template
Activity name: PutWorkflowTemplateByWorkflowTemplateId
Edit a workflow template. Workflow templates define what happens when a workflow is triggered.
Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
path Parameters
workflowTemplateId required | string <uuid> The unique identifier of the workflow template. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
The workflow template to update.
Array of objects (task) <= 6 items |
Responses
Request samples
- Payload
{- "tasks": [
- {
- "taskId": 1,
- "taskType": "Notification",
- "description": "string",
- "sendEmail": true,
- "assignees": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "assigneeType": "UserType"
}
]
}
]
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "tasks": [
- {
- "taskId": 1,
- "taskType": "Notification",
- "description": "string",
- "sendEmail": true,
- "assignees": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "assigneeType": "UserType",
- "description": "string",
- "numberOfLinkedUsers": 3
}
]
}
]
}
}
Delete a workflow template
Activity name: DeleteWorkflowTemplateByWorkflowTemplateId
Delete a workflow template for a workflow trigger. Workflow templates define what happens when a workflow is triggered.
path Parameters
workflowTemplateId required | string <uuid> The unique identifier of the workflow template. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Create a workflow template for a given employer and workflow trigger
Activity name: PostWorkflowTemplateByEmployerIdAndWorkflowTriggerId
Creates a new workflow template for a given employer and workflow trigger. Workflow templates define what happens when a workflow is triggered.
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.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
workflowTriggerId required | string <uuid> The unique identifier of the workflow trigger. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
The workflow template to create.
Array of objects (task) <= 6 items |
Responses
Request samples
- Payload
{- "tasks": [
- {
- "taskId": 1,
- "taskType": "Notification",
- "description": "string",
- "sendEmail": true,
- "assignees": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "assigneeType": "UserType"
}
]
}
]
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "tasks": [
- {
- "taskId": 1,
- "taskType": "Notification",
- "description": "string",
- "sendEmail": true,
- "assignees": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "assigneeType": "UserType",
- "description": "string",
- "numberOfLinkedUsers": 3
}
]
}
]
}
}
Manages the connection between workflow triggers and their associated workflow template. With this resource you can manage which trigger will trigger what workflow.
Workflowtrigger to workflowtemplate mapping
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.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
filter | string Example: filter=cancellationPeriodTimeUnit.key eq 4 Filter the collection |
orderBy | string^-?\w+(,-?\w+)*$ Example: orderBy=-companyName,address.houseNumber Order the collection on one or more fields |
pageNumber | integer <int32> Default: 1 Example: pageNumber=2 Specifies which page should be returned |
pageSize | integer <int32> Default: 250 Example: pageSize=20 Specifies the number of objects per page |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "trigger": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Address change for employee"
}, - "workflowTemplate": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Approval by employer"
}, - "createdOn": "2019-11-23T11:14:06Z",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "lastModifiedOn": "2019-11-23T11:14:06Z",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
]
}
Create a workflow trigger mapping record for an employer
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.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Workflow triggers record to add to the employer.
object <metadata> Indicates the workflow trigger to be configured.
| |
object <metadata> Indicates what workflow template will be used to initiate a workflow when the trigger takes place.
|
Responses
Request samples
- Payload
{- "trigger": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "workflowTemplate": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Response samples
- 201
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "trigger": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Address change for employee"
}, - "workflowTemplate": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Approval by employer"
}, - "createdOn": "2019-11-23T11:14:06Z",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "lastModifiedOn": "2019-11-23T11:14:06Z",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
}
Details of a workflow trigger mapping record
Activity name: GetWorkflowTriggerMappingByWorkflowTriggerMappingId
Get the details of a workflow trigger mapping
path Parameters
workflowTriggerMappingId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "trigger": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Address change for employee"
}, - "workflowTemplate": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Approval by employer"
}, - "createdOn": "2019-11-23T11:14:06Z",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "lastModifiedOn": "2019-11-23T11:14:06Z",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
}
Edit the details of a workflow trigger mapping record
Activity name: PutWorkflowTriggerMappingByWorkflowTriggerMappingId
Edit the details for a workflow trigger mapping record
Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the PUT URL.
path Parameters
workflowTriggerMappingId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Workflow trigger to edit.
object <metadata> Indicates the workflow trigger to be configured.
| |
object <metadata> Indicates what workflow template will be used to initiate a workflow when the trigger takes place.
|
Responses
Request samples
- Payload
{- "trigger": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}, - "workflowTemplate": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "trigger": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Address change for employee"
}, - "workflowTemplate": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Approval by employer"
}, - "createdOn": "2019-11-23T11:14:06Z",
- "createdBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "lastModifiedOn": "2019-11-23T11:14:06Z",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}
}
}
Delete a specific workflow trigger mapping record
Activity name: DeleteWorkflowTriggerMappingByWorkflowTriggerMappingId
Delete a workflow trigger mapping record for the employer
path Parameters
workflowTriggerMappingId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Initiate the change address workflow for an employee
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
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Input for the workflow (the new address)
effectiveFromDate | string <date> The effective from date refers to the specific date on which the change outlined in the request should become operational |
object | |
comment | string or null [ 1 .. 1000 ] characters An extra comment for the change request |
Responses
Request samples
- Payload
{- "effectiveFromDate": "2024-09-31",
- "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "postalCode": "1234 AA",
- "country": {
- "key": 1
}
}, - "comment": "We move house September 26th"
}
Response samples
- 202
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Initiate the change contact information workflow for an employee
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
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Input for the workflow
phoneNumber | string or null <= 15 characters The phone number of the employee. |
mobilePhoneNumber | string or null <= 15 characters The mobile phone number of the employee. |
emailAddress | string or null <= 255 characters The e-mail address of the employee. Only one email address is allowed. |
comment | string or null [ 1 .. 1000 ] characters An extra comment for the change request |
Responses
Request samples
- Payload
{- "phoneNumber": "+31 13-1234567",
- "mobilePhoneNumber": "+31 6-1231456",
- "comment": "We move house September 26th"
}
Response samples
- 202
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Initiate the change personal information workflow for an employee
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
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Input for the workflow
effectiveFromDate | string <date> The effective from date refers to the specific date on which the change outlined in the request should becomes operational |
object <metadata> The civil/marital status of the employee | |
object <metadata> (howToFormatLastName) Indicates how the system will format the last name. | |
lastNamePartner | string or null [ 1 .. 25 ] characters The last name of the employee's partner. |
prefixPartner | string or null <= 10 characters The prefix to the last name of the employee's partner. |
comment | string or null [ 1 .. 1000 ] characters An extra comment for the change request |
Responses
Request samples
- Payload
{- "effectiveFromDate": "2024-09-31",
- "civilStatus": {
- "key": 2
}, - "howToFormatLastName": {
- "key": 2
}, - "lastNamePartner": "Wiel",
- "prefixPartner": "van de",
- "comment": "I got married !!!!!!!"
}
Response samples
- 202
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Initiate the change partner information workflow for an employee
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
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Input for the workflow
action | string Value: "create" |
startDate | string or null <date> (properties-startDate) startdate |
endDate | string or null <date> (properties-endDate) end date |
firstName | string or null (firstName) [ 1 .. 28 ] characters The first name, given name, forename or Christian name as part of a persons personal name. |
lastName | string (lastName) [ 1 .. 25 ] characters The last name, family name or surname as part of a persons personal name. |
prefix | string or null (prefix) [ 1 .. 10 ] characters The prefix to the last name |
initials | string or null (initials) [ 1 .. 6 ] characters The initials |
dateOfBirth | string <date> (dateOfBirth) The date of birth |
placeOfBirth | string or null (placeOfBirth) [ 1 .. 24 ] characters The place of birth |
dateOfDeath | string or null <date> (dateOfDeath) The date of death |
object <metadata> (properties-howToFormatLastName) Indicates how the system will format the last name. | |
object or null <metadata> (title) The title to be used (if any). | |
object <metadata> (gender) The gender | |
object or null <metadata> (waoClassification) The occupational disability classification in the form of a percentage range. | |
comment | string or null non-empty An extra comment for the change request |
Responses
Request samples
- Payload
{- "action": "create",
- "startDate": "1995-05-21",
- "endDate": "1995-05-21",
- "firstName": "Susan",
- "lastName": "Bergen",
- "prefix": "van",
- "initials": "S.L.",
- "dateOfBirth": "1995-05-21",
- "placeOfBirth": "Amsterdam",
- "dateOfDeath": "2019-08-24",
- "howToFormatLastName": {
- "key": 2
}, - "title": {
- "key": 2
}, - "gender": {
- "key": 2
}, - "waoClassification": {
- "key": 2
}, - "comment": "We move house September 26th"
}
Response samples
- 202
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Initiate the manage contact workflow for an employee
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
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Input for the workflow
action | string Value: "create" |
name | string (properties-name) <= 70 characters Name of the contact |
description | string (properties-description) <= 50 characters Describes the relationship of the contact to the employee |
phoneNumber | string or null (phoneNumber) <= 15 characters The phone number of the contact |
object or null (properties-address) | |
particularities | string or null (particularities) <= 4000 characters Extra information about the contact |
comment | string or null non-empty An extra comment for the change request |
Responses
Request samples
- Payload
{- "action": "create",
- "name": "Johanna Bakker",
- "description": "Moeder",
- "phoneNumber": "013-12345678",
- "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "postalCode": "1234 AA",
- "country": {
- "key": 1
}
}, - "particularities": "Genoemd adres is een priveadres",
- "comment": "Nieuw doctor"
}
Response samples
- 202
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Initiate the declaration workflow for an employment
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
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Input for the workflow
object <metadata> (payrollComponent) 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. | |
calculatedDistanceByRoutingService | number or null <double> (calculatedDistanceByRoutingService) [ 0.01 .. 99999999.99 ] ^(\d{1,8})(\.\d{1,2})?$ The value calulated by the routing service |
numberOfUnits | number <double> (numberOfUnits) [ 0.01 .. 99999999.99 ] ^(\d{1,8})(\.\d{1,2})?$ The number of units requested |
declarationDate | string <date> (declarationDate) The date to which the declaration is applicable. As requested by the employee. |
reasonForDeviatingFromCalculatedDistance | string or null (reasonForDeviatingFromCalculatedDistance) <= 1000 characters The reason why the employee deviated form the calculated distance. |
Array of objects or null (route) 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. | |
comment | string or null [ 1 .. 1000 ] characters An extra comment for the declaration request |
Responses
Request samples
- Payload
{- "payrollComponent": {
- "key": 11
}, - "calculatedDistanceByRoutingService": 8,
- "numberOfUnits": 8,
- "declarationDate": "2017-11-01",
- "reasonForDeviatingFromCalculatedDistance": "There were some ongoing road works i had to get around",
- "route": [
- {
- "pointOfInterest": {
- "name": "Van Spaendonck Groep"
}, - "address": {
- "freeformAddress": "Reitseplein 1, 5037 AA Tilburg",
- "countryCode": "NL"
}, - "position": {
- "latitude": 51.585996,
- "longitude": 5.585996
}
}
], - "comment": "Had to park in a garage"
}
Response samples
- 202
- 400
- 401
- 403
{- "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
}
Change the details of a declaration
Activity name: PatchInitiatedDeclarationWorkflowByWorkflowId
Allows 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. Has a user approved initiatl information is can no longer be changed. If changes are still allowed can be determined based on the field canBeEditedByInitiator
in the workflow object.
Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata
to the POST URL.
Defaults : none
path Parameters
workflowId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Input for the workflow
object <metadata> (payrollComponent) 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. | |
calculatedDistanceByRoutingService | number or null <double> (calculatedDistanceByRoutingService) [ 0.01 .. 99999999.99 ] ^(\d{1,8})(\.\d{1,2})?$ The value calulated by the routing service |
numberOfUnits | number <double> (numberOfUnits) [ 0.01 .. 99999999.99 ] ^(\d{1,8})(\.\d{1,2})?$ The number of units requested |
declarationDate | string <date> (declarationDate) The date to which the declaration is applicable. As requested by the employee. |
reasonForDeviatingFromCalculatedDistance | string or null (reasonForDeviatingFromCalculatedDistance) <= 1000 characters The reason why the employee deviated form the calculated distance. |
Array of objects or null (route) 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. | |
comment | string or null [ 1 .. 1000 ] characters An extra comment for the declaration request |
Responses
Request samples
- Payload
{- "payrollComponent": {
- "key": 11
}, - "calculatedDistanceByRoutingService": 8,
- "numberOfUnits": 8,
- "declarationDate": "2017-11-01",
- "reasonForDeviatingFromCalculatedDistance": "There were some ongoing road works i had to get around",
- "route": [
- {
- "pointOfInterest": {
- "name": "Van Spaendonck Groep"
}, - "address": {
- "freeformAddress": "Reitseplein 1, 5037 AA Tilburg",
- "countryCode": "NL"
}, - "position": {
- "latitude": 51.585996,
- "longitude": 5.585996
}
}
], - "comment": "Had to park in a garage"
}
Response samples
- 202
- 400
- 401
- 403
{- "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
}
Initiate the change IBAN workflow for an employment
Activity name: PostInitiateChangeIbanWorkflowByEmploymentId
Allows the user to trigger a workflow to change the IBAN (that is used to payout the net wage) for an employment. The workflow may require the change to be approved.
Metadata : no 'metadata'
Defaults : none
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Input for the workflow
iban | string [ 15 .. 34 ] characters The new IBAN for the employment |
comment | string or null [ 1 .. 1000 ] characters An extra comment for the change IBAN request |
Responses
Request samples
- Payload
{- "iban": "NL91ABNA0417164300",
- "comment": "I switched bank"
}
Response samples
- 202
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Download attachment
Activity name : GetDeclarationAttachmentByWorkflowId
Download the attachment (via Qwoater) for the given declaration workflowId. In case no attachment is know the service will return a 404.
path Parameters
workflowId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Responses
Response samples
- 401
- 403
{- "message": "Authorization has been denied for this request."
}
Upload attachment
Activity name : PostDeclarationAttachmentByWorkflowId
Upload an attachment to a declaration workflow. Via Qwoater.
path Parameters
workflowId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Document to be uploaded as attachment to the declaration.
file | string base64 encoded document file. |
filename | string [ 1 .. 250 ] characters The name of the file. Qwoater: Filename |
Responses
Request samples
- Payload
{- "file": "YQ==",
- "filename": "BowlsJohn.pdf"
}
Response samples
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "BrokenBusinessRule",
- "description": "Invalid value for <field>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- { }
]
}
Check if a list of workflowId's for an employment have an attachment
Activity name : GetWorkflowsWithAttachmentByEmploymentId
Get a list of all declarationId's of declarations that have an attachment to it.
The attachment is stored in Qwoater, and thus on the background a call to Qwoater will be performed to check whether an attachment is available for a declaration.
If an attachment is available then a call may be performed to the attachment download endpoint to actually start downloading the attachment for this declaration.
path Parameters
employmentId required | string <uuid> The unique identifier of the employment |
query Parameters
workflowIds required | string <uuid> WorkflowIds for which the attachment is available. This parameter may be included multiple times to indicate multiple workflowIds. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "workflowIds": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
]
}
Check if a list of workflowId's for an employer have an attachment
Activity name : GetWorkflowsWithAttachmentByEmployerId
This endpoint returns from a set of workflow IDs, the workflow Ids for which an attachment is available
All declarationIds must belong to the same employerId.
Attachments 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.
path Parameters
employerId required | string <uuid> The unique identifier of the employer |
query Parameters
workflowIds required | string <uuid> WorkflowIds for which the attachment is available. This parameter may be included multiple times to indicate multiple workflowIds. |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "totalSize": 650,
- "pageSize": 250,
- "totalPages": 3,
- "currentPage": 2,
- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "_embedded": [
- {
- "workflowIds": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
]
}
Progress of a Workflow
Gets the workflowProgres of a specific workflow
path Parameters
workflowId required | string <uuid> The unique identifier of the record |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "status": {
- "key": 1,
- "value": "In progress"
}, - "functionalStatus": {
- "key": 1,
- "value": "Rejected"
}, - "canBeEditedByInitiator": true,
- "canBeCancelledByInitiator": true,
- "trigger": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "description": "Address change for employee"
}, - "initiatedOn": "2019-11-23T11:14:06Z",
- "initiatedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "lastModifiedOn": "2019-11-23T11:14:06Z",
- "lastModifiedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "apiPayload": "{\"phoneNumber\":\"040-1234567\",\"mobilePhoneNumber\":\"06-12345678\",\"emailAddress\":\"[email protected]\",\"comment\":\"Clever contact workflow!\"}",
- "apiViewModel": "{\"phoneNumber\":\"040-1234567\",\"mobilePhoneNumber\":\"06-12345678\",\"emailAddress\":\"[email protected]\",\"comment\":\"Clever contact workflow!\"}",
- "tasks": [
- {
- "taskId": 1,
- "taskType": "Notification",
- "description": "string",
- "sendEmail": true,
- "executedBy": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "executedOn": "2019-11-23T11:14:06Z",
- "status": {
- "key": 1,
- "value": "Success"
}, - "assignees": [
- {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "assigneeType": "UserType",
- "description": "string"
}
], - "comments": [
- {
- "commentedBy": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "initials": "I",
- "prefix": "de",
- "lastName": "Jong",
- "formattedName": "Jong, I"
}, - "commentedOn": "2019-11-23T11:14:06Z",
- "comment": "Comment to initiator"
}
]
}
]
}
}
Start the change address workflow for an employee
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.
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Data to as input for the workflow (the new address)
object | |
comment | string or null [ 1 .. 1000 ] characters An extra comment for the change request |
Responses
Request samples
- Payload
{- "address": {
- "street": "Voordijk",
- "city": "Leiden",
- "houseNumber": 12,
- "houseNumberAddition": "D",
- "postalCode": "1234 AA",
- "country": {
- "key": 1
}
}, - "comment": "We move house September 26th"
}
Response samples
- 202
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Start the change contactinformation workflow for an employee
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.
path Parameters
employeeId required | string <uuid> The unique identifier of the employee |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
Data to serve as input for the workflow (the new contactinformation)
object | |
comment | string or null [ 1 .. 1000 ] characters An extra comment for the change request |
Responses
Request samples
- Payload
{- "contactInformation": {
- "phoneNumber": "+31 13-1234567",
- "mobilePhoneNumber": "+31 6-1231456",
- "faxNumber": "+31 13-1234561",
- "emailAddress": "[email protected]"
}, - "comment": "Changed my mobile phone number."
}
Response samples
- 202
- 400
- 401
- 403
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": {
- "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
}
Request year transition
Activity name : PatchRequestYearTransitionByPayrollAdministrationIdAndYearId
This endpoint allows the user to request a year transition for a specific payroll administration and year. The user can indicate if an email will be sent to the employees and the date on which the employee can access the yearendstatement. During the year transition the given year will be closed and a new year will be opened.
path Parameters
payrollAdministrationId required | string <uuid> The unique identifier of an administration |
yearId required | string <uuid> The guid of the payroll year |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
sentEssMail | boolean Property that indicates if an email will be sent to the employees. |
dateAvailableEss | string or null <date> The date on which the employee can access the yearendstatement. |
Responses
Request samples
- Payload
{- "sentEssMail": true,
- "dateAvailableEss": "2025-04-01"
}
Response samples
- 200
- 400
- 401
- 403
- 409
{- "version": {
- "obsoleteDate": "2019-08-24",
- "resourceVersion": "2018-12-31"
}, - "messages": [
- {
- "type": "Warning",
- "description": "<some warning>",
- "id": "904d6856-6034-4624-bcbc-886188c115c5",
- "code": 12,
- "properties": [
- "string"
]
}
], - "content": { }
}
Request year transition collective
Activity name : PostRequestYearTransitionCollectiveByBearerTokenAndYearId
This endpoint allows the user to request a year transition for several payroll administrations. The user can indicate if an email will be sent to the employees and the date on which the employee can access the yearendstatement. During the year transition the given year will be closed and a new year will be opened.
path Parameters
yearId required | string <uuid> The guid of the payroll year |
header Parameters
Authorization required | string^Bearer\s[\w-]+$ Example: Bearer <TOKEN> A valid Bearer token for authorizing the request. |
Accept required | string Example: application/json;version=2018-01-01 The accept header is used to influence what type of output is returned and in most cases the version of the output |
Request Body schema: application/json;version=2018-01-01required
payrollAdministrationId | string <uuid> ^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){... The unique identifier of an object (GUID/UUID) |
sentEssMail | boolean Property that indicates if an email will be sent to the employees. |
dateAvailableEss | string or null <date> The date on which the employee can access the yearendstatement. |
Responses
Request samples
- Payload
[- {
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "sentEssMail": true,
- "dateAvailableEss": "2025-04-01"
}
]
Response samples
- 202
- 400
- 401
- 403
- 409
{- "content": {
- "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
- "submittedOn": "2023-05-08T15:16:49+02:00",
- "status": "Completed",
- "type": "Werknemerloket",
- "itemCount": {
- "processedWithError": 10,
- "processed": 75,
- "processedWithWarning": 15,
- "total": 100
}
}
}