Please enable JavaScript to view this site.

Navigation: Schema: PayrollTaxReturn > Tables

PayrollTaxReturnResponseMessagesByPayrollAdministrationId

List of tax returns for an administration__Activity name :__ GetPayrollTaxReturnsByPayrollAdministrationIdA list of tax returns for an administration

Catalog: LoketNlRest

Schema: PayrollTaxReturn

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/{payrollAdministrationId}/payrolltaxreturns

Insert loket.nl (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/payrolltaxreturns

Update loket.nl (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/payrolltaxreturns

Delete loket.nl (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/payrolltaxreturns

Field Selection Method: NotRequired

Base Path: _embedded[*].responseMessages[*]

Select loket.nl (REST) API Operation: get /providers/employers/payrolladministrations/{payrollAdministrationId}/payrolltaxreturns

Table Function Parameters

The following parameters can be used to control the behaviour of the table function PayrollTaxReturnResponseMessagesByPayrollAdministrationId. 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

payrollAdministrationId

guid

 

The unique identifier of an administration

 

Table Function Columns

The columns of the table function PayrollTaxReturnResponseMessagesByPayrollAdministrationId are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

approvalTime

datetime

 

The time at which the payroll tax return 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 pay roll run was cancelled. (Annuleren)

correctionAmount

decimal

 

The amount, in euro's, of wage tax to be paid as correction for previous period(s)

dateOfReceipt

datetime

 

The date on which the response message was received

deadlineForPayment

datetime

 

The final date at which the amount is due.

emailAddressPayrollTaxReturnRunStarted

string

 

The e-mail address to which an email will be sent when the payroll tax return run is started. (Email starten)

externalIdentification

string

 

An identifier to be filled by external parties after submitting the tax return.

iban

string

 

The IBAN to which the payroll tax return should be payed. Only IBAN without spaces are accepted.

id

guid

 

The unique identifier of an object (GUID/UUID)

inTheNameOf

string

 

The name of the benificiary corresponding with the IBAN

isCorrectionMessagePriorYear

boolean

 

Indicates whether the payroll tax return is a correction message or not. A correction message is always for a prior year and no SEPA file can be downloaded for a correction message.

messageCreationTime

datetime

 

Date-time when the message was created

messageReference

string

 

The message reference (berichtkenmerk) that is used within the payroll tax return message.

methodOfCreation_key

int32

 

The key indicating how the payroll tax return run was created.

methodOfCreation_value

string

 

The value describing how the payroll tax return run was created.

paymentReference

string

 

The payment reference (betalingskenmerk) to be used when making the payment to the tax office.

payrollPeriodType_key

int32

 

 

payrollPeriodType_value

string(50)

 

 

payrollTaxReturnParty_key

int32

 

 

payrollTaxReturnParty_value

string(50)

 

 

payrollTaxReturnStatus_key

int32

 

 

payrollTaxReturnStatus_value

string

 

 

payrollTaxReturnType_key

int32

 

 

payrollTaxReturnType_value

string(50)

 

 

period_periodEndDate

datetime

 

The last day of the period for which the tax return message was created

period_periodNumber

int32

 

The period number of the payroll period for which the tax return was created. In case of a yearly tax return this value will be set to 0

period_periodStartDate

datetime

 

The first day of the period for which the tax return message was created

period_year

int32

 

The year of the period for which the tax return message was created.

periodAmount

decimal

 

The amount, in euro's, of wage tax to be paid for this period

processingFinishedTime

datetime

 

Date-time when the calculations were finished

removalTime

datetime

 

The time at which the payroll tax return run was removed (verwijderd by the user

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

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 tax return run was requested by the user

responseClass_key

int32

 

 

responseClass_value

string

 

 

responseType_key

int32

 

 

responseType_value

string

 

 

sendTime

datetime

 

The time at which the payroll tax return run message was send.

sequenceNumber

int32

 

An incremental number.

taxReturnMessageReference

string

 

The name of the party responsible for the payroll tax return

totalAmount

decimal

 

The cumulative ammount of the correctionAmount and periodAmount. Indication the total ammount to be paid for this wagetax return

wageTaxNumber

string(12)

 

The wage tax number aka Loonheffingennummer.

withholdingParty

string

 

The name of the party responsible for the payroll tax return

 

25-05-2022 14:15 Version 22.1.46-BETA+3385