Schakel JavaScript in om deze site te bekijken.

Made in EU
Loket.nl REST Forums

Loket.nl REST API Data Model

Navigatie: » Geen onderwerpen boven dit niveau «

TotalSepaFileByPayrollRunId

Download a total SEPA file__Activity name :__ GetTotalSepaFileByPayrollRunIdReturns the total SEPA payments file as a XML file. This file contains the payments of all the available SEPA payment files available for the specified payroll run.

Catalog: LoketNlRest

Schema: PayrollRunDownloads

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/payrollruns/{payrollrunId}/totalsepafile

Insert loket.nl (REST) API URL: /providers/employers/payrolladministrations/payrollruns/{payrollrunId}/totalsepafile

Update loket.nl (REST) API URL: /providers/employers/payrolladministrations/payrollruns/{payrollrunId}/totalsepafile

Delete loket.nl (REST) API URL: /providers/employers/payrolladministrations/payrollruns/{payrollrunId}/totalsepafile

Field Selection Method: NotRequired

Select loket.nl (REST) API Operation: get /providers/employers/payrolladministrations/payrollruns/{payrollrunId}/totalsepafile

Table Function Parameters

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

batchBooking

string

☐

 

Determines whether the Batch Booking \<BtchBookg\> tag is included in the SEPA file and if it is which value it is set to. By defualt this value is set to Exclude.Possible values for this parameter are:- Exclude: Do not include \<BtchBookg\> tag in SEPA file- IncludeTrue: Include \<BtchBookg\> tag in SEPA file and set it to 'True'- IncludeFalse: Include \<BtchBookg\> tag in SEPA file and set it to 'False'(Werte: BtchBookgExclude, BtchBookgTrue, BtchBookgFalse)

paymentType

string

☐

 

Indicates the type of payment for the SEPA file.In case salary is selected the following will be included in the SEPA xml file```<CtgyPurp><Cd>SALA</Cd></CtgyPurp>``` (Werte: Other, Salary)

payrollrunId

guid

☑

 

The unique identifier of the payroll run

requestedExecutionDate

datetime

☑

 

This value is used when creating the sepa file to set the value of \<ReqdExctnDt\>

 

Table Function Columns

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

Name

Data Type

Label

Required

Documentation

DOCUMENT

byte[]

 

☐

 

 

13-05-2022 15:37 Version 22.1.40-BETA+3374

X

Belangrijke Informatie over Veiligheid en Gebruik

Beoogd gebruik en beperkingen: Deze software, ontwikkeld door Invantive, is ontworpen om een verscheidenheid aan zakelijke en informatietechnologische gegevensverwerkingsfuncties te ondersteunen, zoals boekhouding, financiële rapportage en verkooprapportage. Het is belangrijk om op te merken dat deze software niet is ontworpen, getest of goedgekeurd voor gebruik in omgevingen waar een storing of defect kan leiden tot levensbedreigende situaties, ernstige fysieke schade of milieuschade. Dit omvat, maar is niet beperkt tot:

  • Nucleaire faciliteiten: de software mag niet worden gebruikt voor operaties of functies die verband houden met de controle, het onderhoud of de werking van nucleaire faciliteiten.
  • Defensie en militaire toepassingen: deze software is niet geschikt voor gebruik in defensiegerelateerde toepassingen, inclusief maar niet beperkt tot wapenbeheer, militaire strategieplanning of andere aspecten van nationale defensie.
  • Luchtvaart: de software is niet bedoeld voor gebruik in de bediening, navigatie of communicatiesystemen van vliegtuigen of luchtverkeersleidingomgevingen.
  • Gezondheidszorg en medicijnproductie: deze software mag niet worden gebruikt voor de werking van medische apparaten, de analyse van patiëntgegevens voor kritieke gezondheidsbeslissingen, farmaceutische productie of medisch onderzoek waarbij een storing of defect de gezondheid van de patiënt kan beïnvloeden.
  • Verwerking van chemische en/of gevaarlijke stoffen: deze software is niet bedoeld voor het beheer, de controle of de operationele aspecten van chemische fabrieken of faciliteiten voor de verwerking van chemische en/of gevaarlijke stoffen. Elke storing in de software die in deze omgevingen wordt gebruikt kan leiden tot gevaarlijke chemische lozingen, explosies of milieurampen.
  • Transport- en verkeerscontrolesystemen: de software mag niet worden gebruikt voor de besturing, bediening of het beheer van transportsystemen, waaronder de besturing van spoorwegsignalen, metrosystemen of verkeerslichten. Storingen in dergelijke kritieke systemen kunnen tot ernstige ongelukken leiden en de openbare veiligheid in gevaar brengen.
  • Energienetwerk- en nutsbesturingssystemen: deze software is niet ontworpen voor de besturing of bediening van energienetwerksystemen, waaronder elektrische onderstations, besturingssystemen voor hernieuwbare energie of besturingssystemen van waternutsbedrijven. Het falen van software op deze gebieden kan leiden tot aanzienlijke stroomonderbrekingen, onderbrekingen in de watervoorziening of andere storingen in openbare voorzieningen, waardoor gemeenschappen in gevaar kunnen komen en grote schade kan worden aangericht.
  • Andere omgevingen met een hoog risico: alle andere kritieke infrastructuren en omgevingen waar een storing in de software kan leiden tot aanzienlijke schade aan personen of het milieu.

Gebruikersverantwoordelijkheid: gebruikers moeten ervoor zorgen dat ze het beoogde gebruik van de software begrijpen en de software niet gebruiken in een omgeving die buiten het beoogde doel valt. Het is de verantwoordelijkheid van de gebruiker om de geschiktheid van de software voor de beoogde toepassing te beoordelen, vooral in scenario's die een risico kunnen vormen voor leven, gezondheid en/of milieu.

Afwijzing van aansprakelijkheid: Invantive wijst elke verantwoordelijkheid af voor schade, letsel of wettelijke gevolgen die voortvloeien uit het gebruik of misbruik van deze software in verboden en/of onbedoelde toepassingen.
  
Disclaimer