v3

latestOpenAPI 3.1.02026-07-311,0939714.5 MB
Payroll period data

Insert or update payroll period data

This endpoint is the REST alternative to the ImporteerGegevens (Variabele Gegevens) SOAP webservice functionality <br/> <br/> Activity name : PatchPayrollPeriodDataByEmploymentId <br/> <br/> This endpoint is typically used by applications that are considered to be leading in regard to the values for the payroll components they manage. For most (external) applications this will the most viable endpoint to achieve that functionality. Loket considers these parties as not interested in the current state of the payroll period data in the Loket 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 will either insert a new record or update the existing record with the supplied data.

  • A new record is created when the combination of payrollPeriod, shift, payslipType, distributionUnit, costCenter and costUnit is valid and does not exist for the employment. Next to that, the objects consisting of payrollComponent, value and attribute are inserted into the database. <br />
  • An update is performed when the combination of payrollPeriod, shift, payslipType, distributionUnit, costCenter and costUnit does exist for the employment. In that case the specified objects consisting of payrollComponent, value and attribute are inserted into the database, overwriting existing values. Existing records with a payrollComponent.key that is not supplied in the request are not modified. <br/> <br/> Metadata : <br/> Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the PATCH URL <br/> Possible values for fields of the type 'metadata' that are PERIOD-specific can be acquired (GET) by adding /metadata/year/{year}/period/{periodNumber} to the PATCH URL <br/> <br/> Default values : <br/> Default values may be acquired by adding /defaults (GET) to the PATCH url . It is very much (!!!) recommended to acquire the defaults-objects first and use that information when inserting data for this employment. I.e. use the default values for costCenter, shift etcetera and the complement the object with the payroll components you want to provide. <br/> <br/> Extra background reading : <br/> It may be useful to read more about payroll period data (variabele gegevens, mutaties) on the Loket helpdesk portal. Please note that this information is in Dutch and access is required. <br/>
patch/v2/providers/employers/employees/employments/{employmentId}/payrollperioddata

Path parameters

employmentIdstring uuid required

The unique identifier of the employment

Query parameters

filterstring
Example:cancellationPeriodTimeUnit.key eq 4

Filter the collection

orderBystring
Example:-companyName,address.houseNumber

Order the collection on one or more fields

pageNumberinteger
Example:2

Specifies which page should be returned

pageSizeinteger
Example:20

Specifies the number of objects per page

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Response

OK