LOloket
Attachment of earnings

Create a new attachment of earnings record

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

Create a new attachment of earnings record for an employment.

Metadata : Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the URL

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

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

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/employees/employments/{employmentId}/attachmentsofearnings
  • 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

endDatestring date nullable

The end date of the record

descriptionPayslipstring

This value is shown on the payslip to identify the attachment.

fixedPaymentPerPayrollPeriodnumber double nullable

Set a fixed sum to be payed every payroll period.

Note: If left empty the "available" earnings will be calculated in the payroll run by subtracting the protected earnings threshold (beslagvrijevoet) from the netwage. This method can lead to variable payments per payroll period.

ibanstring

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

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",
  "descriptionPayslip": "payment to creditor x",
  "creditor": {
    "type": {
      "key": 1,
      "value": "Preferente schuldeiser"
    }
  },
  "totalAmount": {
    "owed": 320,
    "paid": {
      "inApprovedPayrollRuns": 50
    }
  },
  "fixedPaymentPerPayrollPeriod": 50,
  "iban": "NL52ABNA0424968264",
  "beneficiary": {
    "name": "Ben Hur",
    "city": "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",
    "descriptionPayslip": "payment to creditor x",
    "creditor": {
      "type": {
        "key": 1,
        "value": "Preferente schuldeiser"
      }
    },
    "totalAmount": {
      "owed": 320,
      "paid": {
        "inApprovedPayrollRuns": 50
      }
    },
    "fixedPaymentPerPayrollPeriod": 50,
    "iban": "NL52ABNA0424968264",
    "beneficiary": {
      "name": "Ben Hur",
      "city": "Rome"
    },
    "description1": "Savings to different account",
    "description2": "from net wage"
  }
}

Changes

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