Loket.nl API

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

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)

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.

Edit the details of a cost center __Activity name:__ PatchCostCenterAtPayrollAdministrationLevelByCostCenterId Edit the details of a cost center record (kosten plaats) * No metadata required

Edit the details of a cost center at provider level __Activity name:__ PatchCostCenterAtProviderLevelByCostCenterId Edit the details of a cost center at provider level.

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)

Edit the links between cost center and cost units __Activity name:__ PatchCostCenterCostUnitMatrixAtProviderLevelByJournalProfileId Edit the links between cost center and cost units (koppeling kostenplaats en kostendrager)

Edit the details of a cost unit at provider level __Activity name:__ PatchCostUnitAtProviderLevelByCostUnitId Edit the details of a cost unit at provider level.

Edit the details of a cost unit record __Activity name:__ PatchCostUnitByCostUnitId Edit the details of a cost unit record (kosten drager) * No metadata required

Change the ESS access for several employees __Activity name :__ PatchESSAccessStatusByEmployerId This endpoint allows the user to change the status of access to the ESS for several employees of the employer.

Change the email address for an employee __Activity name :__ PatchEmailByEmployeeId __Defaults :__ No defaults

Activate employee profile for the employment __Activity name :__ PatchEmployeeProfileByEmploymentId Create Fondsen, Grondslagen and toeslagen based on the employment's employeeProfile.

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

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.

Manage the authorization groups linked to the employer __Activity name :__ PatchEmployerAuthorizationGroupsByProviderIdAndEmployerId Manage the authorization groups linked to the employer.

Manage the employer user authorizations __Activity name :__ PatchEmployerUserAuthorizationsByEmployerIdAndUserId Manage the employer user authorizations and `authorizationSet`. __Note:__ Currently the `authorizationSet` doesnt do anything in regard to which authorizations are enabled or disabled. It only functions as a guide to the GUI to visualize and save the authorizations linked to the `authorizationSet` Only the authorizations with isEnabled set to true are saved all other authorizations will be disabled.

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 /v2/providers/employers/{employerId}/users/metadata __Defaults :__ No defaults Resend or Revoke an invite for an employer user.

Link or unlink departments from an user. __Activity name:__ PatchEmployerUserLinkedDepartmentsByEmployerIdAndUserId This endpoint enables the user to link or unlink multiple 'linkages' with one call.

Link or unlink Employee from an user. __Activity name:__ PatchEmployerUserLinkedEmployeeByEmployerIdAndUserId This endpoint enables the user to link or unlink an employee. Leave the employeeId empty to unlink the employee from the user.

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.

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.

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

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.

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.

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. If an user has already approved initial information, it can no longer be changed. To determine if it is allowed to make changes, please see field `canBeEditedByInitiator` in the workflow object. __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL. __Defaults :__ none

Change the details of a leave request __Activity name:__ PatchInitiatedLeaveRequestWorkflowByWorkflowId Allows the user to change the initial values of a leave request workflow. Changes are only allowed so long as no other actor has made any changes for the workflow. e.g. If an user has already approved initial information, it can no longer be changed. To determine if it is allowed to make changes, please see field `canBeEditedByInitiator` in the workflow object. __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) via `/v2/providers/employers/employees/employments/{employmentId}/leaverequests/metadata`. __Defaults :__ none

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.

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.

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.

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.

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.

Edit the details of a journal allocation record __Activity name:__ PatchLedgerAccountAtPayrollAdministrationLevelByLedgerAccountId Edit the details of a ledger account record (grootboekrekening) * No metadata required

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

Edit the details of a ledger account to payroll component link record __Activity name:__ PatchLedgerAccountToPayrollComponentLinkAtPayrollAdministrationLevelByLedgerAccountToPayrollComponentLinkIdEdit 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

Edit the details of a ledger account to payroll component link record at provider level __Activity name:__ PatchLedgerAccountToPayrollComponentLinkAtProviderLevelByLedgerAccountToPayrollComponentLinkIdEdit the details of a ledger account to payroll component link record at provider level.

Manage the users linked to the user responsibility __Activity name :__ PatchLinkedUsersByEmployerIdAndUserResponsibilityId Manage the users linked to the user responsibility for the employer

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.

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.

MDV notifications __Activity name :__ PatchMdvNotificationsByPayrollAdministrationId Mdv notifications

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.

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.

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.

Mark one or more notifications as read. __Activity name :__ PatchNotificationsByEmployerId Mark notifications as read

Mark multiple notifications as read. __Activity name :__ PatchNotificationsByBearerToken Mark notifications as read in a collective process

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 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. * An update is performed when the combination of `payrollPeriod`, `shift`, `payslipType`, `distributionUnit`, `costCenter` and `costUnit` _does_ exist for the employment. In that case the specified objects consisting of `payrollComponent`, `value` and `attribute` are inserted into the database, overwriting existing values. Existing records with a `payrollComponent.key` that is not supplied in the request are not modified. __Metadata :__ Possible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PATCH URL Possible values for fields of the type 'metadata' that are PERIOD-specific can be acquired (GET) by adding `/metadata/year/{year}/period/{periodNumber}` to the PATCH URL __Default values :__ Default values may be acquired by adding `/defaults` (GET) to the PATCH url . It is very much (!!!) recommended to acquire the defaults-objects first and use that information when inserting data for this employment. I.e. use the default values for costCenter, shift etcetera and the complement the object with the payroll components you want to provide. __Extra background reading :__ It may be useful to read more about payroll period data (variabele gegevens, mutaties) on the Loket [helpdesk portal](https://helpdesk.loket.nl/hc/nl/articles/115003667669-Variabele-mutaties-Individuele-vastlegging). Please note that this information is in Dutch and access is required.

Change the availableForEmployee data __Activity name :__ PatchPayrollRunByPayrollRunId Allows the user to change the `availableForEmployeeDate` and `sendEmailToEmployee` fields

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.

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.

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

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.