# PayrollAdministrationTaxReturns This is a read-only view. The Loket.nl REST API may not support changing the data, or the Invantive UniversalSQL driver for Loket.nl REST does not support it. In the latter case, use the table NativePlatformScalarRequests to upload data to the Loket.nl REST API. - Catalog: `LoketNlRest` - Schema: `Views` ## View Columns The columns of the view `PayrollAdministrationTaxReturns` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `epr_address_city` | `string(24)` | City | ☐ | City of the address | | `epr_address_country_isoCode` | `string(2)` | Country ISO Code | ☐ | The ISO 3166-1 alpha-2 value for the country | | `epr_address_country_key` | `int32` | Country Key | ☐ | The key for the country. Possible values can be aquired via the metadata endpoint | | `epr_address_country_value` | `string(50)` | Country Value | ☐ | The name of the country | | `epr_address_furtherIndication_key` | `int32` | Address Further Indication Key | ☐ | The key of the further indication. Possible values can be aquired via the metadata endpoint | | `epr_address_furtherIndication_value` | `string` | Address Further Indication Value | ☐ | The description of the further indication, the possible values are "WW" and "AB" | | `epr_address_houseNumber` | `int32` | House Number | ☐ | House number of the address | | `epr_address_houseNumberAddition` | `string(4)` | House Number Addition | ☐ | An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number. | | `epr_address_location` | `string(35)` | Location | ☐ | The location like to further specify the address | | `epr_address_postalCode` | `string(9)` | Postal Code | ☐ | The postal code of the address | | `epr_address_province_key` | `int32` | Address Province Key | ☐ | The key for the province. Possible values can be aquired via the metadata endpoint | | `epr_address_province_value` | `string(50)` | Address Province Value | ☐ | The name of the province. Only the Dutch provices are supported and not translated | | `epr_address_street` | `string(24)` | Street | ☐ | Streetname of the address | | `epr_branch_key` | `int32` | Branch Key | ☐ | The key of the branch. Possible values can be aquired via the metadata endpoint | | `epr_branch_value` | `string(50)` | Branch Value | ☐ | Description of the branch. Branch is only available in Dutch | | `epr_chamberOfCommerceNumber` | `string(35)` | Chamber of Commerce Number | ☐ | Chamber of commerce number. In Dutch "Kamer van koophandel" number | | `epr_companyName` | `string(70)` | Company Name | ☐ | Company name | | `epr_contact_function` | `string(50)` | Contact Person Position | ☐ | The job title/function of the contact of the employer | | `epr_contact_name` | `string(50)` | Contact Person Name | ☐ | Name of the contact of the employer | | `epr_contact_phoneNumber` | `string(15)` | Phone Number | ☐ | The general phone number of the employer | | `epr_contactInformation_emailAddress` | `string(255)` | Contact Details Email Address | ☐ | The email address of the employer | | `epr_contactInformation_faxNumber` | `string(15)` | Contact Information Fax Number | ☐ | The fax number of the employer | | `epr_contactInformation_phoneNumber` | `string(15)` | Contact Details Telephone Number | ☐ | The telephone number of the employer | | `epr_contactInformation_website` | `string(255)` | Contact Information Website | ☐ | The website of the employer | | `epr_deviatingPostalAddress_city` | `string(24)` | Deviating Postal Address City | ☐ | City of the address | | `epr_deviatingPostalAddress_country_isoCode` | `string(2)` | Deviating Postal Address Country ISO Code | ☐ | The ISO 3166-1 alpha-2 value for the country | | `epr_deviatingPostalAddress_country_key` | `int32` | Deviating Postal Address Country Key | ☐ | The key for the country. Possible values can be aquired by the metadata endpoint | | `epr_deviatingPostalAddress_country_value` | `string(50)` | Deviating Postal Address Country Value | ☐ | The name of the country | | `epr_deviatingPostalAddress_furtherIndication_key` | `int32` | Deviating Postal Address Further Indication Key | ☐ | The key of the further indication. Possible values can be aquired by the metadata endpoint | | `epr_deviatingPostalAddress_furtherIndication_value` | `string` | Deviating Postal Address Further Indication Value | ☐ | The description of the further indication, the possible values are "WW" and "AB" | | `epr_deviatingPostalAddress_houseNumber` | `int32` | Deviating Postal Address House Number | ☐ | House number of the address | | `epr_deviatingPostalAddress_houseNumberAddition` | `string(4)` | Deviating Postal Address House Number Addition | ☐ | An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number. | | `epr_deviatingPostalAddress_location` | `string(35)` | Deviating Postal Address Location | ☐ | The location like to further specify the address | | `epr_deviatingPostalAddress_poBox` | `int32` | Deviating Postal Address PO Box | ☐ | Post office box | | `epr_deviatingPostalAddress_postalCode` | `string(9)` | Deviating Postal Address Postal Code | ☐ | The postal code of the address, only nullable if country is not The Netherlands (NL). | | `epr_deviatingPostalAddress_street` | `string(24)` | Deviating Postal Address Street | ☐ | Streetname of the address | | `epr_employerLogo` | `string` | Employer Logo | ☐ | The location of the logo of the employer. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output. | | `epr_employerNumber` | `int32` | Employer Number | ☐ | The employer number is used in various overviews and exports to identify a specific employer in Loket (please note: this is not the identifier used in the REST API). | | `epr_id` | `guid` | ID | ☐ | The unique identifier of an object (GUID/UUID) | | `epr_legalForm_key` | `int32` | Legal Form Key | ☐ | The key of the legal form. Possible values can be aquired via the metadata endpoint | | `epr_legalForm_value` | `string(50)` | Legal Form Value | ☐ | Description of the legal form. Possible values are the legel forms supported by Dutch law | | `epr_providerLogo` | `string` | Provider Logo | ☐ | This logo is displayed in the interface of loket.nl. if null no deviating logo is present and the normal provider logo should be used (aquire the URL to the logo via ../v2/providers) | | `epr_providerSettings_administrationNumber` | `string(15)` | | ☐ | A free field that is most commonly used to store the Debtors Number the provider uses for the employer. This field is used as a key field in some of the existing SOAP webservices. | | `epr_providerSettings_groupCode` | `int32` | | ☐ | The groupcode is used for grouping employers. It is used for filtering output and processes (only include employers in group 40 in this report). | | `epr_providerSettings_parentEmployerForConsolidatedOverviews` | `int32` | | ☐ | This field is used to link employers in order to generate reports containing the information of all the linked employers. By applying this method, infinite amount of employers can be linked. | | `epr_providerSettings_sendEmailWhenSalarySlipIsAvailable` | `boolean` | | ☐ | Indicates whether an e-mail should be sent to an employee if a salary slip becomes available in the employee portal (loket.nl's "werknemer.loket") | | `epr_sbi_key` | `int32` | SBI Key | ☐ | The key of the SBI code. Possible values can be aquired via the metadata endpoint | | `epr_sbi_sbiCode` | `string(32)` | SBI Code | ☐ | Possible values are the values from the Dutch SBI 2008 | | `epr_sbi_value` | `string(255)` | SBI Value | ☐ | Description of the SBI code | | `trn_approvalTime` | `datetime` | Approval Time | ☐ | The time at which the payroll tax return run was approved by the user | | `trn_approvedBy_formattedName` | `string` | Approved By Formatted Name | ☐ | preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> | | `trn_approvedBy_id` | `guid` | Approved By ID | ☐ | The unique identifier of an object (GUID/UUID) | | `trn_approvedBy_initials` | `string(6)` | Approved By Initials | ☐ | The initials of the user | | `trn_approvedBy_lastName` | `string(25)` | Approved By Last Name | ☐ | The last name of the user | | `trn_approvedBy_prefix` | `string(10)` | Approved By Name Prefix | ☐ | The prefix of the user | | `trn_canBeResend` | `boolean` | | ☐ | Indicates whether the payroll tax return can be resend to the tax authorities. | | `trn_cancelledBy_formattedName` | `string` | | ☐ | preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> | | `trn_cancelledBy_id` | `guid` | | ☐ | The unique identifier of an object (GUID/UUID) | | `trn_cancelledBy_initials` | `string(6)` | | ☐ | The initials of the user | | `trn_cancelledBy_lastName` | `string(25)` | | ☐ | The last name of the user | | `trn_cancelledBy_prefix` | `string(10)` | | ☐ | The prefix of the user | | `trn_cancelledTime` | `datetime` | | ☐ | The time at which the pay roll run was cancelled. (Annuleren) | | `trn_correctionAmount` | `decimal` | Correction Amount | ☐ | The amount, in euro's, of wage tax to be paid as correction for previous period(s) | | `trn_deadlineForPayment` | `datetime` | | ☐ | The final date at which the amount is due. | | `trn_emailAddressPayrollTaxReturnRunStarted` | `string` | | ☐ | The e-mail address to which an email will be sent when the payroll tax return run is started. (Email starten) | | `trn_externalIdentification` | `string` | | ☐ | An identifier to be filled by external parties after submitting the tax return. | | `trn_iban` | `string` | IBAN | ☐ | The IBAN to which the payroll tax return should be payed. Only IBAN without spaces are accepted. | | `trn_id` | `guid` | ID | ☐ | The unique identifier of an object (GUID/UUID) | | `trn_initiateIdealPayment_key` | `int32` | | ☐ | | | `trn_initiateIdealPayment_value` | `string` | | ☐ | | | `trn_inTheNameOf` | `string` | In the Name Of | ☐ | The name of the benificiary corresponding with the IBAN | | `trn_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. | | `trn_messageCreationTime` | `datetime` | | ☐ | Date-time when the message was created | | `trn_messageReference` | `string` | | ☐ | The message reference (berichtkenmerk) that is used within the payroll tax return message. | | `trn_methodOfCreation_key` | `int32` | Creation Method Key | ☐ | The key indicating how the payroll tax return run was created. | | `trn_methodOfCreation_value` | `string` | Creation Method Value | ☐ | The value describing how the payroll tax return run was created. | | `trn_paymentReference` | `string` | Payment Reference | ☐ | The payment reference (betalingskenmerk) to be used when making the payment to the tax office. | | `trn_payrollPeriodType_key` | `int32` | Payroll Processing Period Type Key | ☐ | | | `trn_payrollPeriodType_value` | `string(50)` | Payroll Processing Period Type Value | ☐ | | | `trn_payrollTaxReturnParty_key` | `int32` | | ☐ | | | `trn_payrollTaxReturnParty_value` | `string(50)` | | ☐ | | | `trn_payrollTaxReturnStatus_key` | `int32` | | ☐ | | | `trn_payrollTaxReturnStatus_value` | `string` | | ☐ | | | `trn_payrollTaxReturnType_key` | `int32` | | ☐ | | | `trn_payrollTaxReturnType_value` | `string(50)` | | ☐ | | | `trn_period_periodEndDate` | `datetime` | | ☐ | The last day of the period for which the tax return message was created | | `trn_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 | | `trn_period_periodStartDate` | `datetime` | | ☐ | The first day of the period for which the tax return message was created | | `trn_period_year` | `int32` | Period Year | ☐ | The year of the period for which the tax return message was created. | | `trn_periodAmount` | `decimal` | Period Amount | ☐ | The amount, in euro's, of wage tax to be paid for this period | | `trn_processingFinishedTime` | `datetime` | Processing Time | ☐ | Date-time when the calculations were finished | | `trn_removalTime` | `datetime` | | ☐ | The time at which the payroll tax return run was removed (verwijderd by the user | | `trn_removedBy_formattedName` | `string` | Deleted By Name | ☐ | preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> | | `trn_removedBy_id` | `guid` | Deleted By ID | ☐ | The unique identifier of an object (GUID/UUID) | | `trn_removedBy_initials` | `string(6)` | Deleted By Initials | ☐ | The initials of the user | | `trn_removedBy_lastName` | `string(25)` | Deleted By Last Name | ☐ | The last name of the user | | `trn_removedBy_prefix` | `string(10)` | Deleted By Name Prefix | ☐ | The prefix of the user | | `trn_requestedBy_formattedName` | `string` | Requested By Formatted Name | ☐ | preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> | | `trn_requestedBy_id` | `guid` | Requested By ID | ☐ | The unique identifier of an object (GUID/UUID) | | `trn_requestedBy_initials` | `string(6)` | Requested By Initials | ☐ | The initials of the user | | `trn_requestedBy_lastName` | `string(25)` | Requested By Last Name | ☐ | The last name of the user | | `trn_requestedBy_prefix` | `string(10)` | Requested By Name Prefix | ☐ | The prefix of the user | | `trn_requestTime` | `datetime` | Request Time | ☐ | The time at which the payroll tax return run was requested by the user | | `trn_sendTime` | `datetime` | | ☐ | The time at which the payroll tax return run message was send. | | `trn_sequenceNumber` | `int32` | Sequence Number | ☐ | An incremental number. | | `trn_taxReturnMessageReference` | `string` | | ☐ | The name of the party responsible for the payroll tax return | | `trn_totalAmount` | `decimal` | Total Amount | ☐ | The cumulative ammount of the correctionAmount and periodAmount. Indication the total ammount to be paid for this wagetax return | | `trn_wageTaxNumber` | `string(12)` | | ☐ | The wage tax number aka Loonheffingennummer. | | `trn_withholdingParty` | `string` | | ☐ | The name of the party responsible for the payroll tax return |