invantive documentation
Invantive Support ForumsLog In / Sign Up

PayrollRunPayslipTypeComponentsByPayrollRunId: Loket.nl REST itgen_loketnl_payrollrunpaysliptypecomponentsbypayrollrunid_plural

read only REST

  • Catalog: LoketNlRest
  • Schema: PayrollRunResults
  • Label: itgen_loketnl_payrollrunpaysliptypecomponentsbypayrollrunid_plural

Get results for a payroll run Activity name : GetPayrollRunResultsByPayrollRunId

Returns the results for the payroll run

Can only retrieve data.

API Source

  • Endpoint: /providers/employers/payrolladministrations/payrollruns/{payrollrunId}/results
  • Operation: get /providers/employers/payrolladministrations/payrollruns/{payrollrunId}/results

Parameters

Name Data Type Required Default Documentation
payrollrunId `` The unique identifier of the payroll run

Table Columns

The columns of the table PayrollRunPayslipTypeComponentsByPayrollRunId are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
employmentId guid Employment ID The unique identifier of an object (GUID/UUID)
payrollComponent_category_key int32 Payroll Component Category Key
payrollComponent_category_value varchar2 Payroll Component Category Value
payrollComponent_column_key int32 itgen_loketnl_payrollcomponent_column_key
payrollComponent_column_value varchar2 itgen_loketnl_payrollcomponent_column_value
payrollComponent_costsEmployer_key int32 itgen_loketnl_payrollcomponent_costsemployer_key
payrollComponent_costsEmployer_value varchar2 itgen_loketnl_payrollcomponent_costsemployer_value
payrollComponent_key int32 Payroll Component Key The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know many of them by heart.
payrollComponent_value varchar2(14) itgen_loketnl_payrollcomponent_value The description of the payroll component
payrollPeriod_periodEndDate datetime Payroll Period End Date The last day of the period for which the tax return message was created
payrollPeriod_periodNumber int32 Payroll Period Number The period number of the payroll period the record relates to
payrollPeriod_periodStartDate datetime Payroll Period Start Date The first day of the period for which the tax return message was created
payrollPeriod_testYear char Payroll Period Test Year Indicates whether the payroll periode is part of a test year. In Loket it is possible to run a year of a payrolladministration as a so-called test year. This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.
payrollPeriod_year int32 Payroll Period Year The year of the payroll period the record relates to
payslipType_key int32 Payslip Type Key
payslipType_value varchar2 Payslip Type Value
value decimal Value Value/ amount (normaal tarief voor belasting, tabelloon) for the payrollcomponent. Only a 'normal' type payslip may have value for this.
valueSpecialTariff decimal Value Special Tariff Value/ amount (speciaal tarief voor belasting) for the payrollcomponent. Both a 'normal' and 'special tariff' type payslip may a value for this. Also, both valueNormal and valueSpecialTariff may have a value at the same time.

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: