Sign in

v3

latestOpenAPI 3.1.02026-07-311,0939714.5 MB
Payroll run downloads

Download a total SEPA file

Activity name : <a href="https://developer.loket-ontw.nl/Activities/GetTotalSepaFileByPayrollRunId" target="_blank">GetTotalSepaFileByPayrollRunId</a>

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.

get/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/totalsepafile

Path parameters

payrollrunIdstring uuid required

The unique identifier of the payroll run

Query parameters

paymentType'Other' | 'Salary'

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>
batchBooking'BtchBookgExclude' | 'BtchBookgTrue' | 'BtchBookgFalse'

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'
requestedExecutionDatestring date required

This value is used when creating the (non) sepa file to set the value of <ReqdExctnDt>

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Response

OK