PayrollProcessOverviewByPayrollAdministrationId: Loket.nl REST itgen_loketnl_payrollprocessoverviewbypayrolladministrationid_plural
read only REST
- Catalog:
LoketNlRest - Schema:
PayrollAdministrationProcessOverview - Label: itgen_loketnl_payrollprocessoverviewbypayrolladministrationid_plural
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.
Can only retrieve data.
API Source
- Endpoint:
/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview - Operation:
get /providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
payroll |
`` | The unique identifier of an administration | ||
payroll |
`` | The unique identifier of the last payroll period to return | ||
payroll |
`` | The unique identifier of the first payroll period to return |
Table Columns
The columns of the table PayrollProcessOverviewByPayrollAdministrationId 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 |
|---|---|---|---|---|---|
journal_ |
varchar2 |
itgen_loketnl_journal_journalpossibleactions_journalpossibleactionsadditionalinfo_key | |||
journal_ |
varchar2 |
itgen_loketnl_journal_journalpossibleactions_journalpossibleactionsadditionalinfo_value | |||
journal_ |
int32 |
itgen_loketnl_journal_journalpossibleactions_key | |||
journal_ |
varchar2 |
itgen_loketnl_journal_journalpossibleactions_value | |||
journal_ |
varchar2 |
itgen_loketnl_journal_journalstatus_journalstatusadditionalinfo_key | |||
journal_ |
varchar2 |
itgen_loketnl_journal_journalstatus_journalstatusadditionalinfo_value | |||
journal_ |
int32 |
itgen_loketnl_journal_journalstatus_key | |||
journal_ |
varchar2 |
itgen_loketnl_journal_journalstatus_value | |||
paww |
int32 |
itgen_loketnl_pawwdeclaration_pawwdeclarationpossibleactions_key | |||
paww |
varchar2 |
itgen_loketnl_pawwdeclaration_pawwdeclarationpossibleactions_pawwdeclarationpossibleactionsadditionalinfo_key | |||
paww |
varchar2 |
itgen_loketnl_pawwdeclaration_pawwdeclarationpossibleactions_pawwdeclarationpossibleactionsadditionalinfo_value | |||
paww |
varchar2 |
itgen_loketnl_pawwdeclaration_pawwdeclarationpossibleactions_value | |||
paww |
int32 |
itgen_loketnl_pawwdeclaration_pawwdeclarationstatus_key | |||
paww |
varchar2 |
itgen_loketnl_pawwdeclaration_pawwdeclarationstatus_pawwdeclarationstatusadditionalinfo_key | |||
paww |
varchar2 |
itgen_loketnl_pawwdeclaration_pawwdeclarationstatus_pawwdeclarationstatusadditionalinfo_value | |||
paww |
varchar2 |
itgen_loketnl_pawwdeclaration_pawwdeclarationstatus_value | |||
paww |
varchar2 |
itgen_loketnl_pawwdeclaration_pensionadministratortype | The type of Pension declaration | ||
payroll_ |
int32 |
itgen_loketnl_payroll_payrollpossibleactions_key | |||
payroll_ |
varchar2 |
itgen_loketnl_payroll_payrollpossibleactions_payrollpossibleactionsadditionalinfo_key | |||
payroll_ |
varchar2 |
itgen_loketnl_payroll_payrollpossibleactions_payrollpossibleactionsadditionalinfo_value | |||
payroll_ |
varchar2 |
itgen_loketnl_payroll_payrollpossibleactions_value | |||
payroll_ |
int32 |
itgen_loketnl_payroll_payrollstatus_key | |||
payroll_ |
varchar2 |
itgen_loketnl_payroll_payrollstatus_payrollstatusadditionalinfo_key | |||
payroll_ |
varchar2 |
itgen_loketnl_payroll_payrollstatus_payrollstatusadditionalinfo_value | |||
payroll_ |
varchar2 |
itgen_loketnl_payroll_payrollstatus_value | |||
payroll_ |
varchar2 |
itgen_loketnl_payroll_typeofinitiationlastpayrollrun | Indicates whether the run is completed with or withour employments. | ||
payroll |
int32 |
itgen_loketnl_payrollperiod_payrollperiodid | The year and period of the payroll period | ||
payroll |
datetime |
Payroll Period End Date | The last day of the period to which the payroll period data applies | ||
payroll |
int32 |
Payroll Period Number | The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) | ||
payroll |
datetime |
Payroll Period Start Date | The first day of the period to which the payroll period data applies | ||
payroll |
int32 |
Payroll Period Year | The year of the payroll period | ||
payroll |
int32 |
itgen_loketnl_payrolltaxreturn_initiateidealpayment_key | |||
payroll |
varchar2 |
itgen_loketnl_payrolltaxreturn_initiateidealpayment_value | |||
payroll |
int32 |
itgen_loketnl_payrolltaxreturn_payrolltaxreturnpossibleactions_key | |||
payroll |
varchar2 |
itgen_loketnl_payrolltaxreturn_payrolltaxreturnpossibleactions_payrolltaxreturnpossibleactionsadditionalinfo_key | |||
payroll |
varchar2 |
itgen_loketnl_payrolltaxreturn_payrolltaxreturnpossibleactions_payrolltaxreturnpossibleactionsadditionalinfo_value | |||
payroll |
varchar2 |
itgen_loketnl_payrolltaxreturn_payrolltaxreturnpossibleactions_value | |||
payroll |
int32 |
itgen_loketnl_payrolltaxreturn_payrolltaxreturnstatus_key | |||
payroll |
varchar2 |
itgen_loketnl_payrolltaxreturn_payrolltaxreturnstatus_payrolltaxreturnstatusadditionalinfo_key | |||
payroll |
varchar2 |
itgen_loketnl_payrolltaxreturn_payrolltaxreturnstatus_payrolltaxreturnstatusadditionalinfo_value | |||
payroll |
varchar2 |
itgen_loketnl_payrolltaxreturn_payrolltaxreturnstatus_value | |||
payroll |
int32 |
itgen_loketnl_payrolltaxreturnperiod_lastpayrollperiodid | The year and period identifying the last payroll period that is part of the payroll tax return period. | ||
payroll |
int32 |
itgen_loketnl_payrolltaxreturnperiod_payrolltaxreturnperiodid | The year and period of the payroll tax return period | ||
payroll |
datetime |
itgen_loketnl_payrolltaxreturnperiod_periodenddate | The last day of the period to which the payroll tax return period data applies | ||
payroll |
int32 |
itgen_loketnl_payrolltaxreturnperiod_periodnumber | The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 13]) | ||
payroll |
datetime |
itgen_loketnl_payrolltaxreturnperiod_periodstartdate | The first day of the period to which the payroll tax return period data applies | ||
payroll |
int32 |
itgen_loketnl_payrolltaxreturnperiod_year | The year of the payroll tax return period | ||
pension |
varchar2 |
itgen_loketnl_pensiondeclaration_pensionadministratortype | The type of Pension declaration | ||
pension |
int32 |
itgen_loketnl_pensiondeclaration_pensiondeclarationpossibleactions_key | |||
pension |
varchar2 |
itgen_loketnl_pensiondeclaration_pensiondeclarationpossibleactions_pensiondeclarationpossibleactionsadditionalinfo_key | |||
pension |
varchar2 |
itgen_loketnl_pensiondeclaration_pensiondeclarationpossibleactions_pensiondeclarationpossibleactionsadditionalinfo_value | |||
pension |
varchar2 |
itgen_loketnl_pensiondeclaration_pensiondeclarationpossibleactions_value | |||
pension |
int32 |
itgen_loketnl_pensiondeclaration_pensiondeclarationstatus_key | |||
pension |
varchar2 |
itgen_loketnl_pensiondeclaration_pensiondeclarationstatus_pensiondeclarationstatusadditionalinfo_key | |||
pension |
varchar2 |
itgen_loketnl_pensiondeclaration_pensiondeclarationstatus_pensiondeclarationstatusadditionalinfo_value | |||
pension |
varchar2 |
itgen_loketnl_pensiondeclaration_pensiondeclarationstatus_value |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: