Loket.nl REST API Data Model
UpaPensionDeclarationResponseMessagesByUpaPensionDeclarationId |
Detail UPA pension declaration__Activity name :__ GetUpaPensionDeclarationByUpaPensionDeclarationIdDetails of UPA pension declaration
Catalog: LoketNlRest
Schema: UpaPensionDeclaration
This is a read-only table function. The loket.nl (REST) API may not support changing the data or the Invantive SQL driver for loket.nl (REST) does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the loket.nl (REST) API.
Select loket.nl (REST) API URL: /providers/employers/payrolladministrations/upapensiondeclarations/{upaPensionDeclarationId}
Insert loket.nl (REST) API URL: /providers/employers/payrolladministrations/upapensiondeclarations/{upaPensionDeclarationId}
Update loket.nl (REST) API URL: /providers/employers/payrolladministrations/upapensiondeclarations/{upaPensionDeclarationId}
Delete loket.nl (REST) API URL: /providers/employers/payrolladministrations/upapensiondeclarations/{upaPensionDeclarationId}
Field Selection Method: NotRequired
Base Path: content.responseMessages[*]
Select loket.nl (REST) API Operation: get /providers/employers/payrolladministrations/upapensiondeclarations/{upaPensionDeclarationId}
Table Function Parameters
The following parameters can be used to control the behaviour of the table function UpaPensionDeclarationResponseMessagesByUpaPensionDeclarationId. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
upaPensionDeclarationId |
guid |
☑ |
|
The unique identifier of the pension declaration. |
Table Function Columns
The columns of the table function UpaPensionDeclarationResponseMessagesByUpaPensionDeclarationId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
approvalTime |
datetime |
|
☐ |
The time at which the payroll run was approved by the user |
approvedBy_formattedName |
string |
|
☐ |
preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> |
approvedBy_id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
approvedBy_initials |
string(6) |
|
☐ |
The initials of the user |
approvedBy_lastName |
string(25) |
|
☐ |
The last name of the user |
approvedBy_prefix |
string(10) |
|
☐ |
The prefix of the user |
cancelledBy_formattedName |
string |
|
☐ |
preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> |
cancelledBy_id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
cancelledBy_initials |
string(6) |
|
☐ |
The initials of the user |
cancelledBy_lastName |
string(25) |
|
☐ |
The last name of the user |
cancelledBy_prefix |
string(10) |
|
☐ |
The prefix of the user |
cancelledTime |
datetime |
|
☐ |
The time at which the payroll run was Cancelled by the user |
citizenServiceNumber |
string(9) |
|
☐ |
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 |
string |
|
☐ |
The description of the response message |
creationTime |
datetime |
|
☐ |
The time at which the pension message was requested by the user |
datetimeOfMessageReceipt |
datetime |
|
☐ |
The date on which the original message was received by the external entity |
datetimeOfRegistration |
datetime |
|
☐ |
The date on which the response message was registered in Loket |
description |
string |
|
☐ |
The description of the response message |
descriptionFragment |
string |
|
☐ |
The description of the response message |
employeeNumber |
int32 |
|
☐ |
The employee number to uniquely identify an employee within an employer |
errorType |
string |
|
☐ |
If there is an error type then this field contain its value. |
externalParty_key |
int32 |
|
☐ |
|
externalParty_value |
string |
|
☐ |
|
id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
incomeRelationshipNumber |
int32 |
|
☐ |
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 |
|
☐ |
If there is an error type then this field contain a value. |
linePosition |
int64 |
|
☐ |
If there is an error type then this field contain a value. |
messageReference |
string |
|
☐ |
The message reference (berichtkenmerk) to recognize the given declaration. |
methodOfCreation_key |
int32 |
|
☐ |
|
methodOfCreation_value |
string |
|
☐ |
|
payrollTaxesNumber |
string(12) |
|
☐ |
The payroll tax number, loonheffingennummer, is the number that is used for the Loonaangifte for the Belastingdienst.<span style="color:red">__This field is in development and therefore not yet accessible:__ </span> |
period_periodEndDate |
datetime |
|
☐ |
The end date of the period |
period_periodId |
int32 |
|
☐ |
The periodId of the payroll period. |
period_periodNumber |
int32 |
|
☐ |
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 |
|
☐ |
The start date of the period |
period_periodType_key |
int32 |
|
☐ |
|
period_periodType_value |
string(50) |
|
☐ |
|
period_year |
int32 |
|
☐ |
The year of the period for which the pension declaration was created. |
removedBy_formattedName |
string |
|
☐ |
preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> |
removedBy_id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
removedBy_initials |
string(6) |
|
☐ |
The initials of the user |
removedBy_lastName |
string(25) |
|
☐ |
The last name of the user |
removedBy_prefix |
string(10) |
|
☐ |
The prefix of the user |
removeTime |
datetime |
|
☐ |
The time at which the pay roll run was removed. |
requestedBy_formattedName |
string |
|
☐ |
preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> |
requestedBy_id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
requestedBy_initials |
string(6) |
|
☐ |
The initials of the user |
requestedBy_lastName |
string(25) |
|
☐ |
The last name of the user |
requestedBy_prefix |
string(10) |
|
☐ |
The prefix of the user |
requestTime |
datetime |
|
☐ |
The time at which the payroll run was requested by the user |
responseStatus_key |
int32 |
|
☐ |
|
responseStatus_value |
string |
|
☐ |
|
responseType_key |
int32 |
|
☐ |
|
responseType_value |
string |
|
☐ |
|
sendingPartyNumber |
string |
|
☐ |
The number of the sending party (i.e. nummer leverancier). |
sentTime |
datetime |
|
☐ |
The time at which the pay roll run was sent. |
upaPensionDeclarationStatus_key |
int32 |
|
☐ |
|
upaPensionDeclarationStatus_value |
string |
|
☐ |
|
withholdingAgentName |
string |
|
☐ |
The withholding agent name (naam inhoudingsplichtige) for this return. |
13-05-2022 15:37 Version 22.1.40-BETA+3374
