Loket.nl API

Create wages for multiple employments __Activity name :__ PostCollectiveWageByEmployerId Create new grosswage records for multiple employments of an employer

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.

Create a concept employee for an employer __Activity name :__ PostConceptEmployeeByEmployerIdCreate a concept employee for an employer* Possible options (metadata) for generic fields of the type \metadata\" can be acquired (GET) by adding `/metadata` to the URL.* Possible options dependent on a specific payrollAdministration can be acquired via `../v2/providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}`.* Possible options for payGrade can be acquired via `../v2/providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}`.A `payGrade` has time based values dictating the wage for a given period. These values can be acquired by performing another metadata request to GET `../v2/providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}/paygrade/{payGradeKey}`. This endpoint has the optional parameter \"date\" that may be used to specifying a measure date.__Defaults :__ Default values for a new object can be acquired by adding `/defaults` to the POST URL. Default values that are dependent on the selected payroll administration can be acquired by adding `/v2/providers/employers/conceptemployees/defaults/payrolladministration/{payrollAdministrationId}` to the POST URL.__NonPayrollAdministrations__ For nonPayrollAdministrations the equivalent MetaData-endpoints are also available as described above. However NO specific defaults endpoint is available for the nonPayrollAdministration."

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.

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

Create a contact person for a concept employee __Activity name :__ PostContactPersonByConceptEmployeeId __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 person for a concept employee

Add a contract code for an employer __Activity name :__ PostContractCodeByEmployerId

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.

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.

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.

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.

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.

Add a custom field for an employer __Activity name :__ PostCustomFieldByEmployerId

Add a custom holiday for an employer __Activity name :__ PostCustomHolidayByEmployerId

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.

Upload attachment __Activity name :__ PostDeclarationAttachmentByWorkflowId Upload an attachment to a declaration workflow. Via Qwoater.

Create a declaration for an employment __Activity name :__ PostDeclarationByEmploymentId Add a declaration for an employment. This can be only be done by the employee.

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

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.

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.

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

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.

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.

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.

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.

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.

Create a download request __Activity name:__ PostDownloadRequestByBearerToken Create a download request for an employment

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

Add an education further indication for an employer __Activity name :__ PostEducationFurtherIndicationByEmployerId

Add an education type for an employer __Activity name :__ PostEducationTypeByEmployerId

Create an EmailIdentity for an employer __Activity name:__ PostEmailIdentityByEmployerId Create an EmailIdentity for an employer.

Create an EmailIdentity for a provider __Activity name:__ PostEmailIdentityByProviderId Create an EmailIdentity for a provider.

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.

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.

Import employee via a csv file __Activity name :__ PostEmployeeImportDataByPayrollAdministrationId Imports a csv file containing employee records.

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.

Post employee photo __Activity name :__ PostEmployeePhotoByEmployeeId Photo of the employee to use as an avatar/profile picture

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.

Upload a logo for the employer __Activity name :__ PostEmployerLogoByEmployerId Upload a logo for the employer.

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.

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.

Create employment for existing employee __Activity name :__ PostEmploymentByEmployeeIdCreate an additional employment for an already existing employee.Please note that the creation of an Employment is not RESTful by design.In Loket, when a new Employee is created it will have to be created including its underlying Employment and its accessory resources. This specific endpoint is relevant in the following scenario: there is already an Employee with at least one Employment, and one wishes to create an additional Employment for that currently existing Employee. When successfully calling this endpoint, an Employment with its accessory resources will be created.__Metadata :__ * Possible options (metadata) for generic fields of the type \metadata\" can be acquired (GET) by adding `/metadata` to the URL.* Possible options dependent on a specific payrollAdministration can be acquired by adding `/metadata/payrolladministration/{payrollAdministrationId}` to the url.* Possible options for payGrade can be acquired by adding `metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}` to the url.A `payGrade` has time based values dictating the wage for a given period. These values can be acquired by performing another metadata request by adding `/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}/paygrade/{payGradeKey}` to the url. This endpoint has the optional parameter \"date\" that may be used to specifying a measure date.__Defaults :__ Default values for a new object can be acquired by adding `/defaults` to the URL. Default values that are dependent on the selected payroll administration can be acquired by adding `../v2/providers/employers/employees/employments/defaults/payrolladministration/{payrollAdministrationId}` to the URL.__NonPayrollAdministrations__ For nonPayrollAdministrations the equivalent metaData-endpoints are also available as described above. Also, a defaults endpoint is available for the nonPayrollAdministration. Please note that this requires `../nonpayrolladministrations/{nonPayrollAdministrationId}` in the path."

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.

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

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.

Create an Employment template for an employer __Activity name :__ PostEmploymentTemplateByByEmployerIdCreate a employment template for an employer* Possible options (metadata) for generic fields of the type \metadata\" can be acquired (GET) by adding `/metadata` to the URL.* Possible options dependent on a specific payrollAdministration can be acquired via `../v2/providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}`.* Possible options for payGrade can be acquired via `../v2/providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}`.A `payGrade` has time based values dictating the wage for a given period. These values can be acquired by performing another metadata request to GET `../v2/providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}/paygrade/{payGradeKey}`. This endpoint has the optional parameter \"date\" that may be used to specifying a measure date.__Defaults :__ Default values for a new object can be acquired by adding `/defaults` to the POST URL. Default values that are dependent on the selected payroll administration can be acquired by adding `/v2/providers/employers/employmenttemplates/defaults/payrolladministration/{payrollAdministrationId}` to the POST URL.__NonPayrollAdministrations__ For nonPayrollAdministrations the equivalent MetaData-endpoints are also available as described above. Default values that are dependent on the selected non-payroll administration can be acquired via `/v2/providers/employers/employmenttemplates/defaults/nonpayrolladministration/{nonPayrollAdministrationId}`."

Perform an employee self service wage projection based on default CLA configuration __Activity name :__ PostEssWageProjectionBasedOnDefaultClaConfigurationByBearerToken This endpoint performs an employee self service wage projection based on default CLA configuration using the bearer token context.

Perform an employee self service wage projection __Activity name :__ PostEssWageProjectionByEmploymentId This endpoint performs an employee self service wage projection for an existing employment.

Customise an employee self service wage projection __Activity name :__ PostEssWageProjectionCustomiseByEmploymentId This endpoint customises an employee self service wage projection for an existing employment.

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