invantive documentation
Invantive Support ForumsLog In / Sign Up

PayrollProcessStatusByProviderId: Loket.nl REST itgen_loketnl_payrollprocessstatusbyproviderid_plural

read only REST

  • Catalog: LoketNlRest
  • Schema: PayrollProcessStatus
  • Label: itgen_loketnl_payrollprocessstatusbyproviderid_plural

Payroll status for each administration (deprecated). Activity name : GetPayrollProcessStatusByProviderId

Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.

Defaults : The default value for payrollPeriod.payrollPeriodId can be acquired by adding `/defaults' to the POST URL.

Deprecated : This endpoint will no longer be developed. Returns an array of objects. Each object contains information about the payroll administration and the payroll processes status.

Can only retrieve data.

API Source

  • Endpoint: /providers/{providerId}/payrollprocessstatus
  • Operation: get /providers/{providerId}/payrollprocessstatus

Parameters

Name Data Type Required Default Documentation
payrollPeriodId `` The unique identifier of the payroll period to return.
providerId `` The unique identifier of a provider

Table Columns

The columns of the table PayrollProcessStatusByProviderId 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
administrationNumber varchar2(15) Administration Number The administration number is a free field commonly used to register the debtors number.
cao_key int32 CAO Key
cao_value varchar2(50) CAO Value
clientNumber int32 Client Number The client number is a unique number for administrations that are used for payrolling. This field has no value if the administration is not used for payrolling.
employerId guid itgen_loketnl_employerid The unique identifier of an object (GUID/UUID)
employerLogo varchar2 Employer Logo The location of the logo of the employer. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
groupClassification_key int32 itgen_loketnl_groupclassification_key
groupClassification_value varchar2 itgen_loketnl_groupclassification_value
groupCode int64 Group Code Number (integer) used for grouping administrations.
hasAutomaticPayroll char itgen_loketnl_hasautomaticpayroll Indicates whether automatic payrolling is set
id guid ID The unique identifier of an object (GUID/UUID)
loonmodel_key int32 itgen_loketnl_loonmodel_key
loonmodel_value varchar2(50) itgen_loketnl_loonmodel_value
name varchar2(70) Name Name of the administration
payrollPeriod_announcements_hasUnreadAnnouncements char itgen_loketnl_payrollperiod_announcements_hasunreadannouncements Indicates whether the administration has unread announcements
payrollPeriod_notifications_hasUnreadNotifications char itgen_loketnl_payrollperiod_notifications_hasunreadnotifications Indicates whether the administration has unread notifications
payrollPeriod_payrollPeriodId int32 itgen_loketnl_payrollperiod_payrollperiodid The year and period of the payroll period
payrollPeriod_payrollProcess_methodOfCreation_key int32 itgen_loketnl_payrollperiod_payrollprocess_methodofcreation_key The key indicating how the payroll run was created.
payrollPeriod_payrollProcess_methodOfCreation_value varchar2 itgen_loketnl_payrollperiod_payrollprocess_methodofcreation_value The value describing how the payroll run was created.
payrollPeriod_payrollProcess_status_key int32 itgen_loketnl_payrollperiod_payrollprocess_status_key
payrollPeriod_payrollProcess_status_value varchar2 itgen_loketnl_payrollperiod_payrollprocess_status_value
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
payrollPeriodType_key int32 Payroll Period Type Key
payrollPeriodType_value varchar2(50) Payroll Period Type Value
shortName varchar2(12) Short Name Shortened name of the administration

Release Notes

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