PawwDeclarationsByPayrollAdministrationId__embeddedResponseMessages: Loket.nl REST itgen_loketnl_pawwdeclarationsbypayrolladministrationid__embeddedresponsemessages_plural
read only REST
- Catalog:
LoketNlRest - Schema:
PawwDeclaration - Label: itgen_loketnl_pawwdeclarationsbypayrolladministrationid__embeddedresponsemessages_plural
List of Paww declarations Activity name : GetPawwDeclarationsByPayrollAdministrationId
A list of Paww declarations for an administration
Can only retrieve data.
API Source
- Endpoint:
/providers/employers/payrolladministrations/{payrollAdministrationId}/pawwdeclarations - Operation:
get /providers/employers/payrolladministrations/{payrollAdministrationId}/pawwdeclarations
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
payroll |
`` | The unique identifier of an administration |
Table Columns
The columns of the table PawwDeclarationsByPayrollAdministrationId__embeddedResponseMessages 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 |
|---|---|---|---|---|---|
approval |
datetime |
Approval Time | The time at which the payroll run was approved by the user | ||
approved |
varchar2 |
Approved by Formatted Name | preformatted user name for displaying. <lastname>", "<initials>" "<prefix> | ||
approved |
guid |
Approved by ID | The unique identifier of an object (GUID/UUID) | ||
approved |
varchar2 |
Approved by Initials | The initials of the user | ||
approved |
varchar2 |
Approved by Last Name | The last name of the user | ||
approved |
varchar2 |
Approved by Prefix | The prefix of the user | ||
cancelled |
varchar2 |
itgen_loketnl_cancelledby_formattedname | preformatted user name for displaying. <lastname>", "<initials>" "<prefix> | ||
cancelled |
guid |
itgen_loketnl_cancelledby_id | The unique identifier of an object (GUID/UUID) | ||
cancelled |
varchar2 |
itgen_loketnl_cancelledby_initials | The initials of the user | ||
cancelled |
varchar2 |
itgen_loketnl_cancelledby_lastname | The last name of the user | ||
cancelled |
varchar2 |
itgen_loketnl_cancelledby_prefix | The prefix of the user | ||
cancelled |
datetime |
itgen_loketnl_cancelledtime | The time at which the payroll run was Cancelled by the user | ||
citizen |
varchar2 |
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 | ||
creation |
datetime |
itgen_loketnl_creationtime | The time at which the paww message was requested by the user | ||
datetime |
datetime |
itgen_loketnl_datetimeofmessagereceipt | The date on which the original message was received by the external entity | ||
datetime |
datetime |
itgen_loketnl_datetimeofregistration | The date on which the response message was registered in Loket | ||
description |
varchar2 |
Description | The description of the response message | ||
description |
varchar2 |
itgen_loketnl_descriptionfragment | The description of the response message | ||
employee |
int32 |
Employee Number | The employee number to uniquely identify an employee within an employer | ||
error |
varchar2 |
itgen_loketnl_errortype | If there is an error type then this field contain its value. | ||
external |
int32 |
itgen_loketnl_externalparty_key | |||
external |
varchar2 |
itgen_loketnl_externalparty_value | |||
id |
guid |
ID | The unique identifier of an object (GUID/UUID) | ||
income |
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. | ||
line |
int64 |
itgen_loketnl_linenumber | If there is an error type then this field contain a value. | ||
line |
int64 |
itgen_loketnl_lineposition | If there is an error type then this field contain a value. | ||
message |
varchar2 |
itgen_loketnl_messagereference | The message reference (berichtkenmerk) to recognize the given declaration. | ||
method |
int32 |
Method of Creation Key | |||
method |
varchar2 |
Method of Creation Value | |||
paww |
int32 |
itgen_loketnl_pawwdeclarationstatus_key | |||
paww |
varchar2 |
itgen_loketnl_pawwdeclarationstatus_value | |||
payroll |
varchar2 |
itgen_loketnl_payrolltaxesnumber | The payroll tax number, loonheffingennummer, is the number that is used for the Loonaangifte for the Belastingdienst. | ||
period_ |
datetime |
itgen_loketnl_period_periodenddate | The end date of the period | ||
period_ |
int32 |
itgen_loketnl_period_periodid | The periodId of the payroll period. | ||
period_ |
int32 |
itgen_loketnl_period_periodnumber | The period number of the payroll period for which the paww declaration was created. In case of a yearly tax return this value will be set to 0 | ||
period_ |
datetime |
itgen_loketnl_period_periodstartdate | The start date of the period | ||
period_ |
int32 |
itgen_loketnl_period_periodtype_key | |||
period_ |
varchar2 |
itgen_loketnl_period_periodtype_value | |||
period_ |
int32 |
Period Year | The year of the period for which the paww declaration was created. | ||
removed |
varchar2 |
Removed by Name | preformatted user name for displaying. <lastname>", "<initials>" "<prefix> | ||
removed |
guid |
Removed by ID | The unique identifier of an object (GUID/UUID) | ||
removed |
varchar2 |
Removed by Initials | The initials of the user | ||
removed |
varchar2 |
Removed by Last Name | The last name of the user | ||
removed |
varchar2 |
Removed by Prefix | The prefix of the user | ||
remove |
datetime |
Remove Time | The time at which the pay roll run was removed. | ||
requested |
varchar2 |
Requested by Formatted Name | preformated user name for displaying. <lastname>", "<initials>" "<prefix> | ||
requested |
guid |
Requested by ID | The unique identifier of an object (GUID/UUID) | ||
requested |
varchar2 |
Requested by Initials | The initials of the user | ||
requested |
varchar2 |
Requested by Last Name | The last name of the user | ||
requested |
varchar2 |
Requested by Prefix | The prefix of the user | ||
request |
datetime |
Request Time | The time at which the payroll run was requested by the user | ||
response |
int32 |
itgen_loketnl_responsestatus_key | |||
response |
varchar2 |
itgen_loketnl_responsestatus_value | |||
response |
int32 |
itgen_loketnl_responsetype_key | |||
response |
varchar2 |
itgen_loketnl_responsetype_value | |||
sending |
varchar2 |
itgen_loketnl_sendingpartynumber | The number of the sending party (i.e. nummer leverancier). | ||
sent |
datetime |
itgen_loketnl_senttime | The time at which the pay roll run was sent. | ||
withholding |
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: