Loket.nl REST API Data Model
SepaFileBySepaFileId |
Download a SEPA file__Activity name :__ GetSepaFileBySepaFileIdReturns the specified SEPA payments file as a XML file.
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/sepafiles/{sepafileId}
Insert loket.nl (REST) API URL: /providers/employers/payrolladministrations/payrollruns/sepafiles/{sepafileId}
Update loket.nl (REST) API URL: /providers/employers/payrolladministrations/payrollruns/sepafiles/{sepafileId}
Delete loket.nl (REST) API URL: /providers/employers/payrolladministrations/payrollruns/sepafiles/{sepafileId}
Field Selection Method: NotRequired
Select loket.nl (REST) API Operation: get /providers/employers/payrolladministrations/payrollruns/sepafiles/{sepafileId}
Table Function Parameters
The following parameters can be used to control the behaviour of the table function SepaFileBySepaFileId. 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) |
requestedExecutionDate |
datetime |
☑ |
|
This value is used when creating the sepa file to set the value of \<ReqdExctnDt\> |
sepafileId |
guid |
☑ |
|
Sepa file ID |
Table Function Columns
The columns of the table function SepaFileBySepaFileId 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
