---
title: "TotalSepaFileByPayrollRunId (Loket.nl REST)"
description: "itgen_loketnl_totalsepafilebypayrollrunid_plural"
language: en
source_language: en
translation_state: complete
canonical: https://documentation.invantive.eu/en/datamodels/loketnl/LoketNlRest.PayrollRunDownloads.TotalSepaFileByPayrollRunId
original: https://documentation.invantive.eu/en/datamodels/loketnl/LoketNlRest.PayrollRunDownloads.TotalSepaFileByPayrollRunId
updated: 2024-06-10T18:51:26Z
license: https://documentation.invantive.eu/en/
---

# TotalSepaFileByPayrollRunId: Loket.nl REST itgen_loketnl_totalsepafilebypayrollrunid_plural

`read only` `REST`

- Catalog: `LoketNlRest`
- Schema: `PayrollRunDownloads`
- Label: itgen_loketnl_totalsepafilebypayrollrunid_plural

Download a total SEPA file
__Activity name :__ GetTotalSepaFileByPayrollRunId

Returns 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.

Can only retrieve data.

## API Source

- Endpoint: `/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/totalsepafile`
- Operation: `get /providers/employers/payrolladministrations/payrollruns/{payrollrunId}/totalsepafile`

## Parameters

| Name | Data Type | Required | Default | Documentation |
|---|---|:---:|---|---|
| `batchBooking` | `` | [ ] |  | 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'  (Waarden: BtchBookgExclude, BtchBookgTrue, BtchBookgFalse) |
| `paymentType` | `` | [ ] |  | 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> ``` (Waarden: Other, Salary) |
| `payrollrunId` | `` | [x] |  | The unique identifier of the payroll run |
| `requestedExecutionDate` | `` | [x] |  | This value is used when creating the (non) sepa file to set the value of \<ReqdExctnDt\> |

## Table Columns

The columns of the table `TotalSepaFileByPayrollRunId` 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 |
|---|---|---|:---:|---|---|
| `DOCUMENT` | `blob` | Document | [ ] |  |  |



## Release Notes

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

- [Loket.nl REST](/en/release-notes/drivers?driver=loket-nl-rest)

