LOloket
Payment information non-SEPA

Get a list of payment information non-SEPA

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

Get a list of payment information for non-SEPA bank accounts for an employment. These are payments to be performed that will NOT be based on an IBAN (which is the standard), so this is mostly useful for foreign payments that are not based within a SEPA-country.

For a specific payroll component, the record indicates to which account 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.

get/v2/providers/employers/employees/employments/{employmentId}/paymentinformationnonsepa

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/employees/employments/{employmentId}/paymentinformationnonsepa
  • Auth
    none required

Path parameters

employmentIdstring uuid required

The unique identifier of the employment

Query parameters

filterstring
Example:cancellationPeriodTimeUnit.key eq 4

Filter the collection

orderBystring
Example:-companyName,address.houseNumber

Order the collection on one or more fields

pageNumberinteger
Example:2

Specifies which page should be returned

pageSizeinteger
Example:20

Specifies the number of objects per page

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

totalSizeinteger

Total number of records, taking into account the given filter.

pageSizeinteger

Number of records in the response

totalPagesinteger

Number of pages available

currentPageinteger

Current page returned in the response

Example response

{
  "totalSize": 650,
  "pageSize": 250,
  "totalPages": 3,
  "currentPage": 2,
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "_embedded": [
    {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "payrollComponent": {
        "key": 260,
        "value": "NETTOLOON"
      },
      "bankAccountNumber": "0403830171874018",
      "beneficiary": {
        "name": "Ben Hur",
        "city": "Rome",
        "address": "Via Roma 3",
        "country": {
          "key": 1,
          "value": "Netherlands",
          "isoCode": "NL"
        }
      },
      "bank": {
        "bankIdentifierCode": "AUDFDE21",
        "name": "Ben Hur",
        "city": "Rome",
        "address": "Via Roma 3",
        "country": {
          "key": 1,
          "value": "Netherlands",
          "isoCode": "NL"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 6 revisions of this API.