invantive documentation
Invantive Support ForumsLog In / Sign Up

ApgPensionDeclarationByApgPensionDeclarationId: Loket.nl REST itgen_loketnl_apgpensiondeclarationbyapgpensiondeclarationid_plural

read only REST

  • Catalog: LoketNlRest
  • Schema: ApgPensionDeclaration
  • Label: itgen_loketnl_apgpensiondeclarationbyapgpensiondeclarationid_plural

Detail APG pension declaration for an administration Activity name : GetApgPensionDeclarationByApgPensionDeclarationId

Details of APG pension declaration

Can only retrieve data.

API Source

  • Endpoint: /providers/employers/payrolladministrations/apgpensiondeclarations/{apgPensionDeclarationId}
  • Operation: get /providers/employers/payrolladministrations/apgpensiondeclarations/{apgPensionDeclarationId}

Parameters

Name Data Type Required Default Documentation
apgPensionDeclarationId `` The unique identifier of the payroll tax return

Table Columns

The columns of the table ApgPensionDeclarationByApgPensionDeclarationId 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
apgPensionDeclarationStatus_key int32 itgen_loketnl_apgpensiondeclarationstatus_key
apgPensionDeclarationStatus_value varchar2 itgen_loketnl_apgpensiondeclarationstatus_value
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
cancelledBy_formattedName varchar2 itgen_loketnl_cancelledby_formattedname preformatted user name for displaying. <lastname>", "<initials>" "<prefix>
cancelledBy_id guid itgen_loketnl_cancelledby_id The unique identifier of an object (GUID/UUID)
cancelledBy_initials varchar2(6) itgen_loketnl_cancelledby_initials The initials of the user
cancelledBy_lastName varchar2(25) itgen_loketnl_cancelledby_lastname The last name of the user
cancelledBy_prefix varchar2(10) itgen_loketnl_cancelledby_prefix The prefix of the user
cancelledTime datetime itgen_loketnl_cancelledtime The time at which the payroll run was Cancelled by the user
creationTime datetime itgen_loketnl_creationtime The time at which the pension message was requested by the user
customerGroupNumber int32 itgen_loketnl_customergroupnumber Pension declarations will alway be grouped by its customerGroupNumber (klantgroepnummer).
externalParty_key int32 itgen_loketnl_externalparty_key
externalParty_value varchar2 itgen_loketnl_externalparty_value
id guid ID The unique identifier of an object (GUID/UUID)
messageReference varchar2 itgen_loketnl_messagereference The message reference (berichtkenmerk) to recognize the given declaration.
methodOfCreation_key int32 Method of Creation Key
methodOfCreation_value varchar2 Method of Creation Value
period_periodEndDate datetime itgen_loketnl_period_periodenddate The end date of the period
period_periodId int32 itgen_loketnl_period_periodid The periodId of the payroll period.
period_periodNumber int32 itgen_loketnl_period_periodnumber The period number of the payroll period for which the pension declaration was created. In case of a yearly tax return this value will be set to 0
period_periodStartDate datetime itgen_loketnl_period_periodstartdate The start date of the period
period_periodType_key int32 itgen_loketnl_period_periodtype_key
period_periodType_value varchar2(50) itgen_loketnl_period_periodtype_value
period_year int32 Period Year The year of the period for which the pension declaration was created.
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 run was requested by the user
sentTime datetime itgen_loketnl_senttime The time at which the pay roll run was sent.
withholdingAgentName varchar2 itgen_loketnl_withholdingagentname The withholding agent name (naam inhoudingsplichtige) for this return.

Release Notes

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