LOloket
Payment information separate payments

Create a new payment information SEPA separate payment record

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

Create a new payment information SEPA separate payment record for an employment.<br/>

Metadata : Not applicable for this resource.

Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.

post/v2/providers/employers/employees/employments/{employmentId}/paymentinformationsepaseparatepayments

Request

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

Path parameters

employmentIdstring uuid required

The unique identifier of the employment

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

Request body applicationjson;version=2018-01-01

idstring uuid

The unique identifier of an object (GUID/UUID)

startDatestring date

Start date of this record

NOTE : at the moment of performing a payroll run it will be checked what record is applicable for splitting from net salary at that date (based on the start- and enddate).

endDatestring date nullable

The end date of the record

ibanstring

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

amountnumber double

The amount to be split from the net salary

nameBeneficiarystring

Name of beneficiary

cityBeneficiarystring nullable

City name of beneficiary

description1string

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

description2string nullable

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

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "startDate": "2018-01-01",
  "endDate": "2018-10-23",
  "iban": "NL52ABNA0424968264",
  "amount": 32,
  "nameBeneficiary": "Ben Hur",
  "cityBeneficiary": "Rome",
  "description1": "Savings to different account",
  "description2": "from net wage"
}

Response

Created

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "startDate": "2018-01-01",
    "endDate": "2018-10-23",
    "iban": "NL52ABNA0424968264",
    "amount": 32,
    "nameBeneficiary": "Ben Hur",
    "cityBeneficiary": "Rome",
    "description1": "Savings to different account",
    "description2": "from net wage"
  }
}

Changes

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