invantive documentation
Invantive Support ForumsLog In / Sign Up

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
payrollAdministrationId `` The unique identifier of an administration
payrollPeriodIdEnd `` The unique identifier of the last payroll period to return
payrollPeriodIdStart `` 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_journalPossibleActions_journalPossibleActionsAdditionalInfo_key varchar2 itgen_loketnl_journal_journalpossibleactions_journalpossibleactionsadditionalinfo_key
journal_journalPossibleActions_journalPossibleActionsAdditionalInfo_value varchar2 itgen_loketnl_journal_journalpossibleactions_journalpossibleactionsadditionalinfo_value
journal_journalPossibleActions_key int32 itgen_loketnl_journal_journalpossibleactions_key
journal_journalPossibleActions_value varchar2 itgen_loketnl_journal_journalpossibleactions_value
journal_journalStatus_journalStatusAdditionalInfo_key varchar2 itgen_loketnl_journal_journalstatus_journalstatusadditionalinfo_key
journal_journalStatus_journalStatusAdditionalInfo_value varchar2 itgen_loketnl_journal_journalstatus_journalstatusadditionalinfo_value
journal_journalStatus_key int32 itgen_loketnl_journal_journalstatus_key
journal_journalStatus_value varchar2 itgen_loketnl_journal_journalstatus_value
pawwDeclaration_pawwDeclarationPossibleActions_key int32 itgen_loketnl_pawwdeclaration_pawwdeclarationpossibleactions_key
pawwDeclaration_pawwDeclarationPossibleActions_pawwDeclarationPossibleActionsAdditionalInfo_key varchar2 itgen_loketnl_pawwdeclaration_pawwdeclarationpossibleactions_pawwdeclarationpossibleactionsadditionalinfo_key
pawwDeclaration_pawwDeclarationPossibleActions_pawwDeclarationPossibleActionsAdditionalInfo_value varchar2 itgen_loketnl_pawwdeclaration_pawwdeclarationpossibleactions_pawwdeclarationpossibleactionsadditionalinfo_value
pawwDeclaration_pawwDeclarationPossibleActions_value varchar2 itgen_loketnl_pawwdeclaration_pawwdeclarationpossibleactions_value
pawwDeclaration_pawwDeclarationStatus_key int32 itgen_loketnl_pawwdeclaration_pawwdeclarationstatus_key
pawwDeclaration_pawwDeclarationStatus_pawwDeclarationStatusAdditionalInfo_key varchar2 itgen_loketnl_pawwdeclaration_pawwdeclarationstatus_pawwdeclarationstatusadditionalinfo_key
pawwDeclaration_pawwDeclarationStatus_pawwDeclarationStatusAdditionalInfo_value varchar2 itgen_loketnl_pawwdeclaration_pawwdeclarationstatus_pawwdeclarationstatusadditionalinfo_value
pawwDeclaration_pawwDeclarationStatus_value varchar2 itgen_loketnl_pawwdeclaration_pawwdeclarationstatus_value
pawwDeclaration_pensionAdministratorType varchar2 itgen_loketnl_pawwdeclaration_pensionadministratortype The type of Pension declaration
payroll_payrollPossibleActions_key int32 itgen_loketnl_payroll_payrollpossibleactions_key
payroll_payrollPossibleActions_payrollPossibleActionsAdditionalInfo_key varchar2 itgen_loketnl_payroll_payrollpossibleactions_payrollpossibleactionsadditionalinfo_key
payroll_payrollPossibleActions_payrollPossibleActionsAdditionalInfo_value varchar2 itgen_loketnl_payroll_payrollpossibleactions_payrollpossibleactionsadditionalinfo_value
payroll_payrollPossibleActions_value varchar2 itgen_loketnl_payroll_payrollpossibleactions_value
payroll_payrollStatus_key int32 itgen_loketnl_payroll_payrollstatus_key
payroll_payrollStatus_payrollStatusAdditionalInfo_key varchar2 itgen_loketnl_payroll_payrollstatus_payrollstatusadditionalinfo_key
payroll_payrollStatus_payrollStatusAdditionalInfo_value varchar2 itgen_loketnl_payroll_payrollstatus_payrollstatusadditionalinfo_value
payroll_payrollStatus_value varchar2 itgen_loketnl_payroll_payrollstatus_value
payroll_typeOfInitiationLastPayrollRun varchar2 itgen_loketnl_payroll_typeofinitiationlastpayrollrun Indicates whether the run is completed with or withour employments.
payrollPeriod_payrollPeriodId int32 itgen_loketnl_payrollperiod_payrollperiodid The year and period of the payroll period
payrollPeriod_periodEndDate datetime Payroll Period End Date The last day of the period to which the payroll period data applies
payrollPeriod_periodNumber int32 Payroll Period Number The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53])
payrollPeriod_periodStartDate datetime Payroll Period Start Date The first day of the period to which the payroll period data applies
payrollPeriod_year int32 Payroll Period Year The year of the payroll period
payrollTaxReturn_initiateIdealPayment_key int32 itgen_loketnl_payrolltaxreturn_initiateidealpayment_key
payrollTaxReturn_initiateIdealPayment_value varchar2 itgen_loketnl_payrolltaxreturn_initiateidealpayment_value
payrollTaxReturn_payrollTaxReturnPossibleActions_key int32 itgen_loketnl_payrolltaxreturn_payrolltaxreturnpossibleactions_key
payrollTaxReturn_payrollTaxReturnPossibleActions_payrollTaxReturnPossibleActionsAdditionalInfo_key varchar2 itgen_loketnl_payrolltaxreturn_payrolltaxreturnpossibleactions_payrolltaxreturnpossibleactionsadditionalinfo_key
payrollTaxReturn_payrollTaxReturnPossibleActions_payrollTaxReturnPossibleActionsAdditionalInfo_value varchar2 itgen_loketnl_payrolltaxreturn_payrolltaxreturnpossibleactions_payrolltaxreturnpossibleactionsadditionalinfo_value
payrollTaxReturn_payrollTaxReturnPossibleActions_value varchar2 itgen_loketnl_payrolltaxreturn_payrolltaxreturnpossibleactions_value
payrollTaxReturn_payrollTaxReturnStatus_key int32 itgen_loketnl_payrolltaxreturn_payrolltaxreturnstatus_key
payrollTaxReturn_payrollTaxReturnStatus_payrollTaxReturnStatusAdditionalInfo_key varchar2 itgen_loketnl_payrolltaxreturn_payrolltaxreturnstatus_payrolltaxreturnstatusadditionalinfo_key
payrollTaxReturn_payrollTaxReturnStatus_payrollTaxReturnStatusAdditionalInfo_value varchar2 itgen_loketnl_payrolltaxreturn_payrolltaxreturnstatus_payrolltaxreturnstatusadditionalinfo_value
payrollTaxReturn_payrollTaxReturnStatus_value varchar2 itgen_loketnl_payrolltaxreturn_payrolltaxreturnstatus_value
payrollTaxReturnPeriod_lastPayrollPeriodId int32 itgen_loketnl_payrolltaxreturnperiod_lastpayrollperiodid The year and period identifying the last payroll period that is part of the payroll tax return period.
payrollTaxReturnPeriod_payrollTaxReturnPeriodId int32 itgen_loketnl_payrolltaxreturnperiod_payrolltaxreturnperiodid The year and period of the payroll tax return period
payrollTaxReturnPeriod_periodEndDate datetime itgen_loketnl_payrolltaxreturnperiod_periodenddate The last day of the period to which the payroll tax return period data applies
payrollTaxReturnPeriod_periodNumber int32 itgen_loketnl_payrolltaxreturnperiod_periodnumber The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 13])
payrollTaxReturnPeriod_periodStartDate datetime itgen_loketnl_payrolltaxreturnperiod_periodstartdate The first day of the period to which the payroll tax return period data applies
payrollTaxReturnPeriod_year int32 itgen_loketnl_payrolltaxreturnperiod_year The year of the payroll tax return period
pensionDeclaration_pensionAdministratorType varchar2 itgen_loketnl_pensiondeclaration_pensionadministratortype The type of Pension declaration
pensionDeclaration_pensionDeclarationPossibleActions_key int32 itgen_loketnl_pensiondeclaration_pensiondeclarationpossibleactions_key
pensionDeclaration_pensionDeclarationPossibleActions_pensionDeclarationPossibleActionsAdditionalInfo_key varchar2 itgen_loketnl_pensiondeclaration_pensiondeclarationpossibleactions_pensiondeclarationpossibleactionsadditionalinfo_key
pensionDeclaration_pensionDeclarationPossibleActions_pensionDeclarationPossibleActionsAdditionalInfo_value varchar2 itgen_loketnl_pensiondeclaration_pensiondeclarationpossibleactions_pensiondeclarationpossibleactionsadditionalinfo_value
pensionDeclaration_pensionDeclarationPossibleActions_value varchar2 itgen_loketnl_pensiondeclaration_pensiondeclarationpossibleactions_value
pensionDeclaration_pensionDeclarationStatus_key int32 itgen_loketnl_pensiondeclaration_pensiondeclarationstatus_key
pensionDeclaration_pensionDeclarationStatus_pensionDeclarationStatusAdditionalInfo_key varchar2 itgen_loketnl_pensiondeclaration_pensiondeclarationstatus_pensiondeclarationstatusadditionalinfo_key
pensionDeclaration_pensionDeclarationStatus_pensionDeclarationStatusAdditionalInfo_value varchar2 itgen_loketnl_pensiondeclaration_pensiondeclarationstatus_pensiondeclarationstatusadditionalinfo_value
pensionDeclaration_pensionDeclarationStatus_value varchar2 itgen_loketnl_pensiondeclaration_pensiondeclarationstatus_value

Release Notes

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