PayrollRunsByPayrollAdministrationId: Loket.nl REST itgen_loketnl_payrollrunsbypayrolladministrationid_plural
read only REST
- Catalog:
LoketNlRest - Schema:
PayrollRun - Label: itgen_loketnl_payrollrunsbypayrolladministrationid_plural
List of payroll runs for an administration Activity name : GetPayrollRunsByPayrollAdministrationId
A list of payroll runs for an administration
Can only retrieve data.
API Source
- Endpoint:
/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollruns - Operation:
get /providers/employers/payrolladministrations/{payrollAdministrationId}/payrollruns
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
payroll |
`` | The unique identifier of an administration |
Table Columns
The columns of the table PayrollRunsByPayrollAdministrationId 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 |
|---|---|---|---|---|---|
approval |
datetime |
Approval Time | The time at which the payroll run was approved by the user | ||
approved |
varchar2 |
Approved by Formatted Name | preformatted user name for displaying. <lastname>", "<initials>" "<prefix> | ||
approved |
guid |
Approved by ID | The unique identifier of an object (GUID/UUID) | ||
approved |
varchar2 |
Approved by Initials | The initials of the user | ||
approved |
varchar2 |
Approved by Last Name | The last name of the user | ||
approved |
varchar2 |
Approved by Prefix | The prefix of the user | ||
available |
datetime |
Date Available for Employee | The date on which the pay slips will be available to employees. | ||
errors |
char |
itgen_loketnl_errorsandwarnings_haserrors | Indicates whether the payrollrun has errors | ||
errors |
char |
itgen_loketnl_errorsandwarnings_haswarnings | Indicates whether the payrollrun has warnings | ||
errors |
char |
itgen_loketnl_errorsandwarningshaserrors | |||
errors |
char |
itgen_loketnl_errorsandwarningshaswarnings | |||
id |
guid |
ID | The unique identifier of an object (GUID/UUID) | ||
method |
int32 |
Method of Creation Key | The key indicating how the payroll run was created. | ||
method |
varchar2 |
Method of Creation Value | The value describing how the payroll run was created. | ||
payroll |
int32 |
Payroll Period Number | The period number of the payroll period the record relates to | ||
payroll |
int32 |
Payroll Period Year | The year of the payroll period the record relates to | ||
payroll |
int32 |
Payroll Run Status Key | The key indicating the current status of the payroll run. | ||
payroll |
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) | ||
payroll |
int32 |
itgen_loketnl_payrolltaxreturnperiod_periodnumber | The period number of the payroll period the record relates to | ||
payroll |
int32 |
itgen_loketnl_payrolltaxreturnperiod_year | The year of the payroll period the record relates to | ||
processing |
datetime |
Processing Finished Time | Date-time when the calculations of the wages was finished | ||
removed |
varchar2 |
Removed by Name | preformatted user name for displaying. <lastname>", "<initials>" "<prefix> | ||
removed |
guid |
Removed by ID | The unique identifier of an object (GUID/UUID) | ||
removed |
varchar2 |
Removed by Initials | The initials of the user | ||
removed |
varchar2 |
Removed by Last Name | The last name of the user | ||
removed |
varchar2 |
Removed by Prefix | The prefix of the user | ||
remove |
datetime |
Remove Time | The time at which the pay roll run was removed. | ||
requested |
varchar2 |
Requested by Formatted Name | preformated user name for displaying. <lastname>", "<initials>" "<prefix> | ||
requested |
guid |
Requested by ID | The unique identifier of an object (GUID/UUID) | ||
requested |
varchar2 |
Requested by Initials | The initials of the user | ||
requested |
varchar2 |
Requested by Last Name | The last name of the user | ||
requested |
varchar2 |
Requested by Prefix | The prefix of the user | ||
request |
datetime |
Request Time | The time at which the payroll run was requested by the user | ||
send |
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 | ||
sequence |
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". | ||
sequence |
int32 |
Sequence Number Approved | An incremental number with a payrolling year to uniquely identify an approved payroll run. | ||
text |
varchar2 |
Text Payment | An optional text provided by an authorized user that will be displayed as a description for the payment. | ||
text |
varchar2 |
Text Pay Slip | An optional text provided by an authorized user that will be displayed on the pay slip. | ||
text |
varchar2 |
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: