invantive documentation
Invantive Support ForumsLog In / Sign Up

PayrollRunByPayrollRunId: Loket.nl REST itgen_loketnl_payrollrunbypayrollrunid_plural

read only REST

  • Catalog: LoketNlRest
  • Schema: PayrollRun
  • Label: itgen_loketnl_payrollrunbypayrollrunid_plural

Details of a payrollrun Activity name : GetPayrollRunByPayrollRunId

Get the details of a single payrollrun

Can only retrieve data.

API Source

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

Parameters

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

Table Columns

The columns of the table PayrollRunByPayrollRunId 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
approvalTime datetime Approval Time The time at which the payroll run was approved by the user
approvedBy_formattedName varchar2 Approved by Formatted Name preformatted user name for displaying. <lastname>", "<initials>" "<prefix>
approvedBy_id guid Approved by ID The unique identifier of an object (GUID/UUID)
approvedBy_initials varchar2(6) Approved by Initials The initials of the user
approvedBy_lastName varchar2(25) Approved by Last Name The last name of the user
approvedBy_prefix varchar2(10) Approved by Prefix The prefix of the user
availableForEmployeeDate datetime Date Available for Employee The date on which the pay slips will be available to employees.
errorsAndWarnings_hasErrors char itgen_loketnl_errorsandwarnings_haserrors Indicates whether the payrollrun has errors
errorsAndWarnings_hasWarnings char itgen_loketnl_errorsandwarnings_haswarnings Indicates whether the payrollrun has warnings
id guid ID The unique identifier of an object (GUID/UUID)
methodOfCreation_key int32 Method of Creation Key The key indicating how the payroll run was created.
methodOfCreation_value varchar2 Method of Creation Value The value describing how the payroll run was created.
payrollPeriod_periodNumber int32 Payroll Period Number The period number of the payroll period the record relates to
payrollPeriod_year int32 Payroll Period Year The year of the payroll period the record relates to
payrollRunStatus_key int32 Payroll Run Status Key The key indicating the current status of the payroll run.
payrollRunStatus_value varchar2 Payroll Run Status Value The value describing the current status of the payroll run. * Staat klaar voor verloning. (key = 0) * Verloning gereed. (key = 1) * Proforma verloning gereed. (key = 2) * Verwijderd door gebruiker (key = 5) * Verloning geannuleerd door gebruiker. (key = 6) * Fout tijdens verloning. (key = 7) * Geen loonresultaten, verloning geannuleerd. (key = 8) * Verloning goedgekeurd. (key = 9)
payrollTaxReturnPeriod_periodNumber int32 itgen_loketnl_payrolltaxreturnperiod_periodnumber The period number of the payroll period the record relates to
payrollTaxReturnPeriod_year int32 itgen_loketnl_payrolltaxreturnperiod_year The year of the payroll period the record relates to
processingFinishedTime datetime Processing Finished Time Date-time when the calculations of the wages was finished
removedBy_formattedName varchar2 Removed by Name preformatted user name for displaying. <lastname>", "<initials>" "<prefix>
removedBy_id guid Removed by ID The unique identifier of an object (GUID/UUID)
removedBy_initials varchar2(6) Removed by Initials The initials of the user
removedBy_lastName varchar2(25) Removed by Last Name The last name of the user
removedBy_prefix varchar2(10) Removed by Prefix The prefix of the user
removeTime datetime Remove Time The time at which the pay roll run was removed.
requestedBy_formattedName varchar2 Requested by Formatted Name preformated user name for displaying. <lastname>", "<initials>" "<prefix>
requestedBy_id guid Requested by ID The unique identifier of an object (GUID/UUID)
requestedBy_initials varchar2(6) Requested by Initials The initials of the user
requestedBy_lastName varchar2(25) Requested by Last Name The last name of the user
requestedBy_prefix varchar2(10) Requested by Prefix The prefix of the user
requestTime datetime Request Time The time at which the payroll run was requested by the user
sendEmailToEmployee char Send Email to Employee Indicates whether an email should be sent to the employees when the pay slip is available to them. NULL will be seen as false
sequenceNumber int32 Sequence Number An incremental number with a payrolling year to uniquely identify a payroll run. Null can be returned for those runs that dont contain "wages".
sequenceNumberApproved int32 Sequence Number Approved An incremental number with a payrolling year to uniquely identify an approved payroll run.
textPayment varchar2(32) Text Payment An optional text provided by an authorized user that will be displayed as a description for the payment.
textPaySlip varchar2(25) Text Pay Slip An optional text provided by an authorized user that will be displayed on the pay slip.
textTariffPaySlip varchar2(25) Text Tariff Pay Slip An additional text to be displayed on the tariff payslip.

Release Notes

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