Loket.nl API

Details of a single partner __Activity name :__ GetPartnerByPartnerId Get the details of a single partner

List of partners for an employee __Activity name :__ GetPartnersByEmployeeId Get the list of partners of the employee

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.

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.

List of payment information for an employer __Activity name:__ GetPaymentInformationSepaByEmployerId Get the list of sepa paymentinformation for all employments of an employer.

Get a list of payment information sepa __Activity name :__ GetPaymentInformationSepaByEmploymentIdGet 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.

Get the details of a payment information sepa __Activity name :__ GetPaymentInformationSepaBypaymentInformationSepaIdGet 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.

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.

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.

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. __Deprecated:__ Dit endpoint wordt vervangen door een nieuwe versie op URL `/verloningmicro/providers/employers/payrolladministrations/payrollruns/{id}/paymentsReport` (activity: GetPaymentsReportByPayrollRunId).

Details of a payroll administration __Activity name :__ GetPayrollAdministrationByPayrollAdministrationId Get the details of a single payroll administration

Details of a payroll administration configuration __Activity name :__ GetPayrollAdministrationConfigurationByPayrollAdministrationId Get the details of a single payroll administration configuration

List of payroll administrations configurations for an employer __Activity name :__ GetPayrollAdministrationConfigurationsByEmployerId Get a list of all payroll administration configurations for an employer

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_

List of payroll administrations for an employer __Activity name :__ GetPayrollAdministrationsByEmployerId Get a list of all payroll administrations for an employer

List of employment turnover per payroll administration for the provider __Activity name :__ GetPayrollAdministrationsEmploymentTurnoverByProviderId

List of payslips per type for all payroll administrations of the provider __Activity name :__ GetPayrollAdministrationsNumberOfPayslipsByProviderId

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.

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.

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

Details of an payroll component set __Activity name :__ GetPayrollComponentSetsByPayrollComponentSetId Get the details of an payroll components sets.

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

Payroll components __Activity name :__ GetPayrollComponentsByPayrollAdministrationIdAndYear Get the available payroll components for an administration.

Download payroll control register for a payroll run __Activity name :__ GetPayrollControlRegisterByPayrollRunId Returns payroll control register for a payroll run as a PDF file. __Deprecated:__ Dit endpoint wordt vervangen door een nieuwe versie op URL `/verloningmicro/providers/employers/payrolladministrations/payrollruns/{id}/payrollcontrolregisterreport` (activity: GetPayrollControlRegisterReportByPayrollRunId).

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.

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.

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.

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 `../v2/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 `../v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/payrollperioddata/defaults`.

Details of a payroll period data __Activity name :__ GetPayrollPeriodDataByPayrollPeriodDataId Get the details of payroll period data

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.

Results of Smart Paste on payroll period data __Activity name :__ GetPayrollPeriodDataSmartPasteResultsBySmartPasteId Get the results of a Smart Paste operation on payroll period data.

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.

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

Download a cummulative payslip for a single payroll period __Activity name :__ GetPayrollPeriodSummaryByEmploymentIdAndPayrollPeriodIdDownload 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 /v2/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

List of all available payroll periods and runs __Activity name :__ GetPayrollPeriodsByPayrollAdministrationId Returns a list of all payroll periods available for the given payroll administration

List of all available payroll periods __Activity name :__ GetPayrollPeriodsMinimizedByPayrollAdministrationId Returns a list of all payroll periods available for the given payroll administration

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 `../v2/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 `../v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview/defaults`.

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.

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.

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.

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.

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.

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"

Details of a payrollrun __Activity name :__ GetPayrollRunByPayrollRunId Get the details of a single payrollrun

Details of a payroll run note __Activity name :__ GetPayrollRunNoteByNoteId Get the details of a note

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.

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.

Get results for a payroll run __Activity name :__ GetPayrollRunResultsByPayrollRunId Returns the results for the payroll run

List of payroll runs for an administration __Activity name :__ GetPayrollRunsByPayrollAdministrationId A list of payroll runs for an administration

Overview of the data used in a payroll simulation __Activity name :__ GetPayrollSimulatorDataByEmploymentId Get an overview of the data used in a payroll simulation