Please enable JavaScript to view this site.

Navigation: Schema: PaymentInformation > Tables

PaymentInformationSepaByEmploymentId

Get a list of payment information sepa__Activity name :__ GetPaymentInformationSepaByEmploymentIdGet a list of payment information for SEPA bank accounts (IBAN's) for an employment.For a specific payroll component, the record indicates to which IBAN payments will be made. This includes, but is not limited to, the payment of wages for an employment.For each payroll component there can only be one payment information record per employment.

Catalog: LoketNlRest

Schema: PaymentInformation

Retrieve: true

Insert: true

Update: false

Delete: false

Select loket.nl (REST) API URL: /providers/employers/employees/employments/{employmentId}/paymentinformationsepa

Insert loket.nl (REST) API URL: /providers/employers/employees/employments/{employmentId}/paymentinformationsepa

Update loket.nl (REST) API URL: /providers/employers/employees/employments/{employmentId}/paymentinformationsepa

Delete loket.nl (REST) API URL: /providers/employers/employees/employments/{employmentId}/paymentinformationsepa

Field Selection Method: NotRequired

Base Path: _embedded[*]

Select loket.nl (REST) API Operation: get /providers/employers/employees/employments/{employmentId}/paymentinformationsepa

Insert loket.nl (REST) API Operation: post /providers/employers/employees/employments/{employmentId}/paymentinformationsepa

Table Function Parameters

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

employmentId

guid

 

The unique identifier of the employment

 

Table Function Columns

The columns of the table function PaymentInformationSepaByEmploymentId 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.

Name

Data Type

Label

Required

Documentation

beneficiary_city

string(24)

 

City name of beneficiary.

beneficiary_name

string(70)

 

Name of beneficiary.

bic

string(11)

 

BIC /SWIFT code. Only applicable for a non-Dutch IBAN

description1

string(32)

 

Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.

description2

string(32)

 

Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.

iban

string(35)

 

International Bank Account Number (IBAN). Only IBAN without spaces are accepted.

id

guid

 

The unique identifier of an object (GUID/UUID)

payrollComponent_description

string(50)

 

 

payrollComponent_key

int32

 

 

visibleOnPayslip

boolean

 

Indicates whether the payment-component is visible on a payslip.

 

25-05-2022 14:15 Version 22.1.46-BETA+3385