invantive documentation
Invantive Support ForumsLog In / Sign Up

UpaPensionDeclarationResponseMessagesByUpaPensionDeclarationId: Loket.nl REST itgen_loketnl_upapensiondeclarationresponsemessagesbyupapensiondeclarationid_plural

read only REST

  • Catalog: LoketNlRest
  • Schema: UpaPensionDeclaration
  • Label: itgen_loketnl_upapensiondeclarationresponsemessagesbyupapensiondeclarationid_plural

Detail UPA pension declaration Activity name : GetUpaPensionDeclarationByUpaPensionDeclarationId

Details of UPA pension declaration

Can only retrieve data.

API Source

  • Endpoint: /providers/employers/payrolladministrations/upapensiondeclarations/{upaPensionDeclarationId}
  • Operation: get /providers/employers/payrolladministrations/upapensiondeclarations/{upaPensionDeclarationId}

Parameters

Name Data Type Required Default Documentation
upaPensionDeclarationId `` The unique identifier of the pension declaration.

Table Columns

The columns of the table UpaPensionDeclarationResponseMessagesByUpaPensionDeclarationId 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
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
citizenServiceNumber varchar2(9) Social Security Number The social security number of the employee used in communication with the Dutch tax authorities. The number has to be a valid Dutch citizen service number (BSN).
code varchar2 Code The description of the response message
creationTime datetime itgen_loketnl_creationtime The time at which the pension message was requested by the user
datetimeOfMessageReceipt datetime itgen_loketnl_datetimeofmessagereceipt The date on which the original message was received by the external entity
datetimeOfRegistration datetime itgen_loketnl_datetimeofregistration The date on which the response message was registered in Loket
description varchar2 Description The description of the response message
descriptionFragment varchar2 itgen_loketnl_descriptionfragment The description of the response message
employeeNumber int32 Employee Number The employee number to uniquely identify an employee within an employer
errorType varchar2 itgen_loketnl_errortype If there is an error type then this field contain its value.
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)
incomeRelationshipNumber int32 itgen_loketnl_incomerelationshipnumber The income relationship number that is required in the tax return. Together with the citizen service number (burgerservicenummer, BSN) and wage tax number, the income relationship number uniquely identifies an employment.
lineNumber int64 itgen_loketnl_linenumber If there is an error type then this field contain a value.
linePosition int64 itgen_loketnl_lineposition If there is an error type then this field contain a value.
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
payrollTaxesNumber varchar2(12) itgen_loketnl_payrolltaxesnumber The payroll tax number, loonheffingennummer, is the number that is used for the Loonaangifte for the Belastingdienst.
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 payroll run was requested by the user
responseStatus_key int32 itgen_loketnl_responsestatus_key
responseStatus_value varchar2 itgen_loketnl_responsestatus_value
responseType_key int32 itgen_loketnl_responsetype_key
responseType_value varchar2 itgen_loketnl_responsetype_value
sendingPartyNumber varchar2 itgen_loketnl_sendingpartynumber The number of the sending party (i.e. nummer leverancier).
sentTime datetime itgen_loketnl_senttime The time at which the pay roll run was sent.
upaPensionDeclarationStatus_key int32 itgen_loketnl_upapensiondeclarationstatus_key
upaPensionDeclarationStatus_value varchar2 itgen_loketnl_upapensiondeclarationstatus_value
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: