actionGETv1.0.0
Acquire company information
__Activity name:__ GetCompanyInformationByChamberOfCommerceNumber This endpoint allows the user to acquire basic company information for a specific chamber of commerce number.
actionGETv1.0.0
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.
actionGETv1.0.0
Acquire the address for a combination of `postalCode` and `houseNumber`
__Activity name :__ GetAddressyByPostalCodeAndHouseNumber <br/> 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 succesful call to this endpoint. The city and street name returned by this endpoint are according to the nen standard <br/>
actionGETv1.0.0
Acquire the AOW date
__Activity name:__ GetAowDateByDateOfBirth This endpoint allows the user to acquire the AOW date of an employee.
actionGETv1.0.0
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.
actionGETv1.0.0
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.
actionGETv1.0.0
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.
actionGETv1.0.0
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.
actionGETv1.0.0
Configured external tenant for a provider user
__Activity name :__ GetConfiguredExternalTenantByProviderUserId Get the external tenant that is configured for this specific user.
actionGETv1.0.0
Contact history for an absence
__Activity name :__ GetAbsenceContactHistoryByAbsenceId Get the contacts history for a specific absence (verzuimmelding).
actionGETv1.0.0
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.
actionGETv1.0.0
Detail of a benefit or deduction record
__Activity name :__ GetBenefitsAndDeductionsBybenefitsAndDeductionsId Get a benefit or deduction for the employment
actionGETv1.0.0
Details of a authorization set
__Activity name :__ GetAuthorizationSetsByAuthorizationSetId Details of an authorization set.
actionGETv1.0.0
Details of a child
__Activity name :__ GetChildByChildId Get the details of a child
actionGETv1.0.0
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.
actionGETv1.0.0
Details of a concept employee
__Activity name :__ GetConceptEmployeeByConceptEmployeeId Get the details of a concept employee
actionGETv1.0.0
Details of a concept employee with fewer fields.
__Activity name :__ GetConceptEmployeeMinimizedByConceptEmployeeId Get the details of a concept employee with fewer fields
actionGETv1.0.0
Details of a contact history
__Activity name :__ GetAbsenceContactHistoryByAbsenceContactHistoryId Get the details of a contact
actionGETv1.0.0
Details of a department
__Activity name:__ GetDepartmentByDepartmentId Get the details of department
actionGETv1.0.0
Details of a Deviating AWF contributions record
__Activity name:__ GetDeviatingAwfContributionByDeviatingAwfContributionId Get the details of a Deviating AWF contributions record
actionGETv1.0.0
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
actionGETv1.0.0
Details of a fiscal record
__Activity name:__ GetFiscalPropertiesByFiscalPropertiesId Get the details of fiscal
actionGETv1.0.0
Details of a function
__Activity name:__ GetFunctionByFunctionId Get the details of function
actionGETv1.0.0
Details of a journal allocation
__Activity name:__ GetJournalAllocationByJournalAllocationId Get the details of a financial journal allocation record (journaliseren module).
actionGETv1.0.0
Details of a journal run
__Activity name :__ GetJournalRunByJournalRunId Returns the details of a journal run. </br>
actionGETv1.0.0
Details of a leave type
__Activity name:__ GetLeaveTypeByEmployerIdAndLeaveTypeId Get the details of a leave type
actionGETv1.0.0
Details of a national holiday
__Activity name:__ GetNationalHolidaysByEmployerIdAndNationalHolidayId Get the details of a national holiday
actionGETv1.0.0
Details of a notification set
__Activity name :__ GetNotificationSetByNotificationSetId Details of an notification set.
actionGETv1.0.0
Details of a payroll period data
__Activity name :__ GetPayrollPeriodDataByPayrollPeriodDataId <br/> <br/> Get the details of payroll period data
actionGETv1.0.0
Details of a payrollrun
__Activity name :__ GetPayrollRunByPayrollRunId Get the details of a single payrollrun
actionGETv1.0.0
Details of a single contact
__Activity name :__ GetContactByContactId Get the details of a single contact
actionGETv1.0.0
Details of a single education
__Activity name :__ GetEducationByEducationId Get the details of a single education
actionGETv1.0.0
Details of a single partner
__Activity name :__ GetPartnerByPartnerId Get the details of a single partner
actionGETv1.0.0
Details of a single wage
__Activity name :__ GetWageByWageId Get the details of a single wage
actionGETv1.0.0
Details of a social security benefits record
__Activity name:__ GetSocialSecurityBenefitBySocialSecurityBenefitId Get the details of a social security benefits record
actionGETv1.0.0
Details of a social security record
__Activity name:__ GetSocialSecurityConfigurationBySocialSecurityConfigurationId Get the details of a social security configuration record
actionGETv1.0.0
Details of a tax return for an administration
__Activity name :__ GetPayrollTaxReturnByPayrollTaxReturnId The details of a tax return for an administration
actionGETv1.0.0
Details of a workflow
__Activity name:__ GetWorkflowByWorkflowId Get the details of a workflow
actionGETv1.0.0
Details of an abp fund
__Activity name :__ GetAbpFundByAbpFundId Get the details of an abp fund
actionGETv1.0.0
Details of an Absence
__Activity name :__ GetAbsenceByAbsenceId Get the details of an Absence
actionGETv1.0.0
Details of an Absence Progress
__Activity name :__ GetAbsenceProgressByAbsenceProgressId Get the details of an Absence Progress
actionGETv1.0.0
Details of an employee
__Activity name :__ GetEmployeeByEmployeeId Get the details of a single employee
actionGETv1.0.0
Details of an employer
__Activity name :__ GetEmployerByEmployerId Get the details of a single employers
actionGETv1.0.0
Details of an employment
__Activity name :__ GetEmploymentByEmploymentId Get the details for an employment
actionGETv1.0.0
Details of an organizational entity
__Activity name:__ GetOrganizationalEntityByOrganizationalEntityId Get the details of organizational entity
actionGETv1.0.0
Details of an user
__Activity name :__ GetEmployerUserByUserId Get the details of an user
actionGETv1.0.0
Details of cost per hour
__Activity name :__ GetCostPerHourByCostPerHourId Get the details of a cost per hour record
actionGETv1.0.0
Details of the working hours
__Activity name :__ GetWorkingHoursByWorkingHoursId <br/> <br/> Get the details of a working hours record
actionGETv1.0.0
Details of wachtgeld
__Activity name :__ GetWachtgeldByWachtgeldId Get the details of a wachtgeld record
actionGETv1.0.0
Document count
__Activity name :__ GetDocumentCountByConceptEmployeeId Get a count of the number of documents in the dossier. Via Qwoater.
actionGETv1.0.0
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.
actionGETv1.0.0
Errors of a journal run
__Activity name :__ GetJournalRunErrorsByJournalRunId Errors that occured while processing the journalrun can be obtained via this endpoint.
actionGETv1.0.0
Get a list of functions
__Activity name :__ GetDataNewBusinessFunctions <br/> Get a list of functions known by Data New Business. <br/>
actionGETv1.0.0
Get a list of SEPA files for a payroll run
__Activity name :__ GetSepaFilesByPayrollRunId Returns the SEPA file(s) for the specified payroll run.
actionGETv1.0.0
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.
actionGETv1.0.0
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.
actionGETv1.0.0
Get Benify URL for an employee
__Activity name :__ GetBenifyUrlByEmployeeId Get a URL to access the Benify portal for an employee.
actionGETv1.0.0
Get default input parameters transition compensation
__Activity name :__ GetCalculateTransitionCompensationDefaultsByEmploymentId Get the default values of the input parameters for the POST action.
actionGETv1.0.0
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.
actionGETv1.0.0
Get payroll period data audit trail
__Activity name :__ GetPayrollPeriodDataAuditTrailByPayrollAdministrationId Get the audit trail for the payroll period data.
actionGETv1.0.0
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.
actionGETv1.0.0
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"
actionGETv1.0.0
Get results for a payroll run
__Activity name :__ GetPayrollRunResultsByPayrollRunId Returns the results for the payroll run
actionGETv1.0.0
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.
actionGETv1.0.0
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.
actionGETv1.0.0
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.
actionGETv1.0.0
Get the details of an attachment of earnings record
__Activity name :__ GetAttachmentOfEarningsByAttachmentOfEarningsId Get the details of an attachment of earnings record
actionGETv1.0.0
Get the details of an protected earnings record
__Activity name :__ GetProtectedEarningsByProtectedEarningsId Get the details of an protected earnings record
actionGETv1.0.0
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
actionGETv1.0.0
Get the status of proforma for this employer
__Activity name :__ GetProformaStatusByEmployerId Get the status of proforma for this employer
actionGETv1.0.0
Get the status of the IDEAL payment
__Activity name :__ GetIdealPaymentStatusByPayrollTaxReturnId Get the status of the IDEAL payment
actionGETv1.0.0
Get user filter settings
__Activity name:__ GetUserFilterSettingsByEmployerId 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.
actionGETv1.0.0
Get Yourcampus URL for a user
__Activity name :__ GetYourcampusUrlByUserId Get a URL to access the Yourcampus portal for a user
actionGETv1.0.0
List of abp funds the employment partakes in
__Activity name :__ GetAbpFundsByEmploymentId Get a list of the abp funds the employment partakes in.
actionGETv1.0.0
List of absence progress for an absence
__Activity name :__ GetAbsenceProgressByAbsenceId Get a list of absence progress (verzuimverloop) for a specific absence (verzuimmelding).
actionGETv1.0.0
List of absences for an employee
__Activity name :__ GetAbsencesByEmployeeId Get a list of all absences for the given employee
actionGETv1.0.0
List of actual benefitsanddeductions for an employer
__Activity name:__ GetActualBenefitsAndDeductionsByEmployerId Get the list of actual benefitsanddeductions for an employer
actionGETv1.0.0
List of actual organizational entities for an employer
__Activity name:__ GetActualOrganizationalEntitiesByEmployerId Get the list of actual organizational entities for an employer
actionGETv1.0.0
List of actual wages for an employer
__Activity name:__ GetActualWagesByEmployerId Get the list of actual wages for an employer
actionGETv1.0.0
List of actual working hours for an employer
__Activity name:__ GetActualWorkingHoursByEmployerId Get the list of actual working hours for an employer
actionGETv1.0.0
List of all available payroll periods
__Activity name :__ GetPayrollPeriodsMinimizedByPayrollAdministrationId Returns a list of all payroll periods available for the given payroll administration
actionGETv1.0.0
List of all available payroll periods and runs
__Activity name :__ GetPayrollPeriodsByPayrollAdministrationId Returns a list of all payroll periods available for the given payroll administration
actionGETv1.0.0
List of all the applications available to the employer
__Activity name:__ GetAvailableApplicationsByEmployerId List of all the applications available to the employer.
actionGETv1.0.0
List of all the integrations for the employer user
__Activity name:__ GetEmployerUserIntegrationsByUserId List of all the integrations for the employer user
actionGETv1.0.0
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.
actionGETv1.0.0
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
actionGETv1.0.0
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.
actionGETv1.0.0
list of insurance contracts
__Activity name :__ GetAchmeaInsuranceContractsByUserId Get a list of all Achmea insurance contracts accessible to the current user
actionGETv1.0.0
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.
actionGETv1.0.0
List of Partners for an employer
__Activity name:__ GetActualPartnersByEmployerId Get the list of Actual partners for all employees of an employer
actionGETv1.0.0
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.
actionGETv1.0.0
Pay payroll taxes using IDEAL
__Activity name :__ GetIdealUrlByPayrollTaxReturnId Get URL which allows the user to pay payroll taxes via IDEAL
actionGETv1.0.0
Payroll components
__Activity name :__ GetPayrollComponentsByPayrollAdministrationIdAndYear Get the available payroll components for an administration.
actionGETv1.0.0
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.
actionGETv1.0.0
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`.
actionGETv1.0.0
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.
actionGETv1.0.0
Retrieve the report of the signing - Conceptemployee
__Activity name :__ GetSignatureReportByConceptEmployeeIdAndDocumentId __Metadata:__ No metadata available. Report of the signature.
actionGETv1.0.0
Retrieve the report of the signing - Employment
__Activity name :__ GetSignatureReportByEmploymentIdAndDocumentId __Metadata:__ No metadata available. Report of the signature.
actionGETv1.0.0
Signature details - Conceptemployee
__Activity name :__ GetSignatureByConceptEmployeeIdAndDocumentId __Metadata:__ No metadata available. Retrieve the status of the signing.
actionGETv1.0.0
Signature details - Employment
__Activity name :__ GetSignatureByEmploymentIdAndDocumentId __Metadata:__ No metadata available. Retrieve the status of the signing.
Beyond the catalog
Any provider, on request.
01
Request it
Tell us which provider you need, and we will ship it in the registry.
02
Generate it
Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.
acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec