invantive documentation
Invantive Support ForumsLog In / Sign Up

PayrollAdministrationTaxReturns: Loket.nl REST Payroll Administration Tax Returns

read only

  • Catalog: LoketNlRest
  • Schema: Views
  • Label: Payroll Administration Tax Returns

Can only retrieve data.

Table Columns

The columns of the table PayrollAdministrationTaxReturns 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
epr_address_city varchar2(24) City City of the address
epr_address_country_isoCode varchar2(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 varchar2(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 varchar2 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 varchar2(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 varchar2(35) Location The location like to further specify the address
epr_address_postalCode varchar2(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 varchar2(50) Address Province Value The name of the province. Only the Dutch provices are supported and not translated
epr_address_street varchar2(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 varchar2(50) Branch Value Description of the branch. Branch is only available in Dutch
epr_chamberOfCommerceNumber varchar2(35) Chamber of Commerce Number Chamber of commerce number. In Dutch "Kamer van koophandel" number
epr_companyName varchar2(70) Company Name Name of the company
epr_contact_function varchar2(50) Contact Function The job title/function of the contact of the employer
epr_contact_name varchar2(50) Contact Name Name of the contact of the employer
epr_contact_phoneNumber varchar2(15) Phone Number The general phone number of the employer
epr_contactInformation_emailAddress varchar2(255) Contact Information Email Address The email address of the employer
epr_contactInformation_faxNumber varchar2(15) Contact Information Fax Number The fax number of the employer
epr_contactInformation_phoneNumber varchar2(15) Contact Information Phone Number The telephone number of the employer
epr_contactInformation_website varchar2(255) Contact Information Website The website of the employer
epr_deviatingPostalAddress_city varchar2(24) Deviating Postal Address City City of the address
epr_deviatingPostalAddress_country_isoCode varchar2(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 varchar2(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 varchar2 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 varchar2(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 varchar2(35) Deviating Postal Address Location The location like to further specify the address
epr_deviatingPostalAddress_poBox int32 Deviating Postal Address Post Office Box Post office box
epr_deviatingPostalAddress_postalCode varchar2(9) Deviating Postal Address Postal Code The postal code of the address, only nullable if country is not The Netherlands (NL).
epr_deviatingPostalAddress_street varchar2(24) Deviating Postal Address Street Streetname of the address
epr_employerLogo varchar2 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 varchar2(50) Legal Form Value Description of the legal form. Possible values are the legel forms supported by Dutch law
epr_providerLogo varchar2 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 varchar2(15) itgen_loketnl_providersettings_administrationnumber 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 itgen_loketnl_providersettings_groupcode 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 itgen_loketnl_providersettings_parentemployerforconsolidatedoverviews 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 char itgen_loketnl_providersettings_sendemailwhensalaryslipisavailable 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 varchar2(32) SBI Code Possible values are the values from the Dutch SBI 2008
epr_sbi_value varchar2(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 varchar2 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 varchar2(6) Approved by Initials The initials of the user
trn_approvedBy_lastName varchar2(25) Approved by Last Name The last name of the user
trn_approvedBy_prefix varchar2(10) Approved by Prefix The prefix of the user
trn_canBeResend char itgen_loketnl_canberesend Indicates whether the payroll tax return can be resend to the tax authorities.
trn_cancelledBy_formattedName varchar2 itgen_loketnl_cancelledby_formattedname preformatted user name for displaying. <lastname>", "<initials>" "<prefix>
trn_cancelledBy_id guid itgen_loketnl_cancelledby_id The unique identifier of an object (GUID/UUID)
trn_cancelledBy_initials varchar2(6) itgen_loketnl_cancelledby_initials The initials of the user
trn_cancelledBy_lastName varchar2(25) itgen_loketnl_cancelledby_lastname The last name of the user
trn_cancelledBy_prefix varchar2(10) itgen_loketnl_cancelledby_prefix The prefix of the user
trn_cancelledTime datetime itgen_loketnl_cancelledtime 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 itgen_loketnl_deadlineforpayment The final date at which the amount is due.
trn_emailAddressPayrollTaxReturnRunStarted varchar2 itgen_loketnl_emailaddresspayrolltaxreturnrunstarted The e-mail address to which an email will be sent when the payroll tax return run is started. (Email starten)
trn_externalIdentification varchar2 itgen_loketnl_externalidentification An identifier to be filled by external parties after submitting the tax return.
trn_iban varchar2 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 itgen_loketnl_initiateidealpayment_key
trn_initiateIdealPayment_value varchar2 itgen_loketnl_initiateidealpayment_value
trn_inTheNameOf varchar2 In the Name of The name of the benificiary corresponding with the IBAN
trn_isCorrectionMessagePriorYear char itgen_loketnl_iscorrectionmessageprioryear 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 itgen_loketnl_messagecreationtime Date-time when the message was created
trn_messageReference varchar2 itgen_loketnl_messagereference The message reference (berichtkenmerk) that is used within the payroll tax return message.
trn_methodOfCreation_key int32 Method of Creation Key The key indicating how the payroll tax return run was created.
trn_methodOfCreation_value varchar2 Method of Creation Value The value describing how the payroll tax return run was created.
trn_paymentReference varchar2 Payment Reference The payment reference (betalingskenmerk) to be used when making the payment to the tax office.
trn_payrollPeriodType_key int32 Payroll Period Type Key
trn_payrollPeriodType_value varchar2(50) Payroll Period Type Value
trn_payrollTaxReturnParty_key int32 itgen_loketnl_payrolltaxreturnparty_key
trn_payrollTaxReturnParty_value varchar2(50) itgen_loketnl_payrolltaxreturnparty_value
trn_payrollTaxReturnStatus_key int32 itgen_loketnl_payrolltaxreturnstatus_key
trn_payrollTaxReturnStatus_value varchar2 itgen_loketnl_payrolltaxreturnstatus_value
trn_payrollTaxReturnType_key int32 itgen_loketnl_payrolltaxreturntype_key
trn_payrollTaxReturnType_value varchar2(50) itgen_loketnl_payrolltaxreturntype_value
trn_period_periodEndDate datetime itgen_loketnl_period_periodenddate The last day of the period for which the tax return message was created
trn_period_periodNumber int32 itgen_loketnl_period_periodnumber 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 itgen_loketnl_period_periodstartdate 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 Finished Time Date-time when the calculations were finished
trn_removalTime datetime itgen_loketnl_removaltime The time at which the payroll tax return run was removed (verwijderd by the user
trn_removedBy_formattedName varchar2 Removed by Name preformated user name for displaying. <lastname>", "<initials>" "<prefix>
trn_removedBy_id guid Removed by ID The unique identifier of an object (GUID/UUID)
trn_removedBy_initials varchar2(6) Removed by Initials The initials of the user
trn_removedBy_lastName varchar2(25) Removed by Last Name The last name of the user
trn_removedBy_prefix varchar2(10) Removed by Prefix The prefix of the user
trn_requestedBy_formattedName varchar2 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 varchar2(6) Requested by Initials The initials of the user
trn_requestedBy_lastName varchar2(25) Requested by Last Name The last name of the user
trn_requestedBy_prefix varchar2(10) Requested by 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 itgen_loketnl_sendtime The time at which the payroll tax return run message was send.
trn_sequenceNumber int32 Sequence Number An incremental number.
trn_taxReturnMessageReference varchar2 itgen_loketnl_taxreturnmessagereference 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 varchar2(12) itgen_loketnl_wagetaxnumber The wage tax number aka Loonheffingennummer.
trn_withholdingParty varchar2 itgen_loketnl_withholdingparty The name of the party responsible for the payroll tax return

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: