---
title: "Add a note for an employment"
method: POST
path: "/v2/providers/employers/employees/employments/{employmentId}/notes"
tags: ["Employment notes"]
---

# Add a note for an employment

`POST /v2/providers/employers/employees/employments/{employmentId}/notes`

## Request

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

__Activity name :__ <a href="https://developer.loket.nl/Activities/PostEmploymentNoteByEmploymentId" target="_blank">PostEmploymentNoteByEmploymentId</a>

__Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.

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

## Path parameters

- `employmentId` string, uuid, required

## Headers

- `Authorization` string, required
- `Accept` string, required

## Request body

- Note
  - `id` string, uuid: The unique identifier of an object (GUID/UUID)
  - `createdOn` string, date-time: The date on which the note was created
  - `createdBy` UserBasic, nullable
    - `id` string, uuid: The unique identifier of an object (GUID/UUID)
    - `initials` string: The initials of the user
    - `prefix` string, nullable: The prefix of the user
    - `lastName` string: The last name of the user
    - `formattedName` string: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
  - `accessibleBy` object: Indicates who can view this node.
    - `key` integer: The key for accessible by
    - `value` string: Description of the accessible by
  - `subject` string: subject of the note
  - `note` string, nullable: The note it self. __Note:__ This is a free text field so users can add htlm/script etc.
  - `lastModifiedOn` string, date-time: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
  - `lastModifiedBy` UserBasic, nullable
    - `id` string, uuid: The unique identifier of an object (GUID/UUID)
    - `initials` string: The initials of the user
    - `prefix` string, nullable: The prefix of the user
    - `lastName` string: The last name of the user
    - `formattedName` string: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>

## Response `201`

Created

- object: a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.
  - `version` Version
    - `obsoleteDate` string, date, nullable: The date (can be null) on which the `resourceVersion` is no longer supported/available
    - `resourceVersion` string, date: The resource version of the object in the response
  - `messages` object[]
    - `type` string: Indication of the type of message. See [the general documentation for more information](./#section/Response/Messages)
    - `description` string: Describes the message
    - `id` string, uuid, nullable: In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity
    - `code` integer: Identifying code for the message
    - `properties` string[]: An array that can contain additional information
  - `content` Note
    - `id` string, uuid: The unique identifier of an object (GUID/UUID)
    - `createdOn` string, date-time: The date on which the note was created
    - `createdBy` UserBasic, nullable
      - `id` string, uuid: The unique identifier of an object (GUID/UUID)
      - `initials` string: The initials of the user
      - `prefix` string, nullable: The prefix of the user
      - `lastName` string: The last name of the user
      - `formattedName` string: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
    - `accessibleBy` object: Indicates who can view this node.
      - `key` integer: The key for accessible by
      - `value` string: Description of the accessible by
    - `subject` string: subject of the note
    - `note` string, nullable: The note it self. __Note:__ This is a free text field so users can add htlm/script etc.
    - `lastModifiedOn` string, date-time: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
    - `lastModifiedBy` UserBasic, nullable
      - `id` string, uuid: The unique identifier of an object (GUID/UUID)
      - `initials` string: The initials of the user
      - `prefix` string, nullable: The prefix of the user
      - `lastName` string: The last name of the user
      - `formattedName` string: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/loket/apis/loket-api.md) - [All operations](https://skmtc.dev/loket/apis/loket-api/llms.txt) - [OpenAPI document](https://skmtc.dev/loket/apis/loket-api/revisions/32170564148f?raw)