EmployeeDocumentComment

Staff5 EndpointsTimeTracking / EmployeeDocumentComment

Get all EmployeeDocumentComment for a single EmployeeDocument

GET/api/employee_documents/comment/for_parent/{parentIdentifier}

Path parameters

parentIdentifierrequiredstring

Query parameters

`id`integer
`document`string
`user`string
`person`string
`created`string
`searchString`string	text to search for in the list
`orderFieldName`string	name of the order field
`orderFieldSort`string	sorting modeAllowed: `DESCASC`
`page`integer	page of the list
`pageSize`integer	number of entries for each page
`withMaxPageNumber`string	returns the number of pages available as a header if this is set

Responses

200Get all EmployeeDocumentComment for a single EmployeeDocumentarray<EmployeeDocumentComment>

Show fields (6)

idinteger
Primary key of the employee document comment. Internal ID.
userUser14
Login user who wrote the comment.
Show fields (10)
- idinteger
  Primary key of the user. Internal ID of the login user.
- namestring
  Display name of the user. Shown in the UI and in audit entries.
- usernamestring
  Login name of the user. Must be unique across all users.
- emailstring
  E-mail address of the user. Used for login notifications, password resets and as a login alias.
- positioningeneralstring
  Free text describing the position or role of the user.
- crm_personCRMPerson10
  CRM person linked to this login user. Connects the login account with the person record.
- profile_picture_urlstring
  URL of the profile picture of the user.
- archivedboolean
  Marks the user as archived. Archived users are kept for history and are not active.
- require2faboolean
  Two-factor authentication is required for this user.
- search_stringstring
  Text that the entity can be searched by.
descriptionstring
Text of the comment.
attachmentsarray<Attachment10>
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/employee_documents/comment/for_parent/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/employee_documents/comment/for_parent/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/employee_documents/comment/for_parent/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/employee_documents/comment/for_parent/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/employee_documents/comment/for_parent/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/employee_documents/comment/for_parent/42")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/employee_documents/comment/for_parent/42"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/time_tracking_employee_document_comment_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/time_tracking_employee_document.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await TimeTrackingEmployeeDocumentCommentController.getAllForParent(TimeTrackingEmployeeDocument.fromJson({}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

[
  {
    "id": 42,
    "description": "Text",
    "user": {
      "id": 42,
      "name": "Beispiel",
      "username": "lena.hartmann@example.org",
      "email": "lena.hartmann@example.org",
      "profile_picture_url": "https://vynst.de",
      "positioningeneral": "string",
      "archived": true,
      "require2fa": true,
      "search_string": "string"
    },
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  }
]

Get a single EmployeeDocumentComment

GET/api/employee_documents/comment/{id}

Path parameters

idrequiredstring

Responses

200Get a single EmployeeDocumentCommentEmployeeDocumentComment

Show fields (6)

idinteger
Primary key of the employee document comment. Internal ID.
userUser14
Login user who wrote the comment.
Show fields (10)
- idinteger
  Primary key of the user. Internal ID of the login user.
- namestring
  Display name of the user. Shown in the UI and in audit entries.
- usernamestring
  Login name of the user. Must be unique across all users.
- emailstring
  E-mail address of the user. Used for login notifications, password resets and as a login alias.
- positioningeneralstring
  Free text describing the position or role of the user.
- crm_personCRMPerson10
  CRM person linked to this login user. Connects the login account with the person record.
- profile_picture_urlstring
  URL of the profile picture of the user.
- archivedboolean
  Marks the user as archived. Archived users are kept for history and are not active.
- require2faboolean
  Two-factor authentication is required for this user.
- search_stringstring
  Text that the entity can be searched by.
descriptionstring
Text of the comment.
attachmentsarray<Attachment10>
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/employee_documents/comment/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/employee_documents/comment/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/employee_documents/comment/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/employee_documents/comment/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/employee_documents/comment/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/employee_documents/comment/42")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/employee_documents/comment/42"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/time_tracking_employee_document_comment_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await TimeTrackingEmployeeDocumentCommentController.get('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "description": "Text",
  "user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "attachments": [
    {
      "id": 42,
      "ocr_from_name": "Beispiel",
      "ocr_from_email": "lena.hartmann@example.org",
      "ocr_from_phone": "+49 511 123456",
      "ocr_to_name": "Beispiel",
      "ocr_to_email": "lena.hartmann@example.org",
      "ocr_to_phone": "+49 511 123456",
      "filename": "string",
      "filesize": "string",
      "mimetype": "string"
    }
  ],
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Update a single EmployeeDocumentComment

PUT/api/employee_documents/comment/{id}

Path parameters

idrequiredstring

Request body application/json

dataEmployeeDocumentComment2
Show fields (2)
- personCRMPerson45
  Person who wrote the comment.
- descriptionstring
  Text of the comment.

Responses

200Update a single EmployeeDocumentCommentEmployeeDocumentComment

Show fields (6)

idinteger
Primary key of the employee document comment. Internal ID.
userUser14
Login user who wrote the comment.
Show fields (10)
- idinteger
  Primary key of the user. Internal ID of the login user.
- namestring
  Display name of the user. Shown in the UI and in audit entries.
- usernamestring
  Login name of the user. Must be unique across all users.
- emailstring
  E-mail address of the user. Used for login notifications, password resets and as a login alias.
- positioningeneralstring
  Free text describing the position or role of the user.
- crm_personCRMPerson10
  CRM person linked to this login user. Connects the login account with the person record.
- profile_picture_urlstring
  URL of the profile picture of the user.
- archivedboolean
  Marks the user as archived. Archived users are kept for history and are not active.
- require2faboolean
  Two-factor authentication is required for this user.
- search_stringstring
  Text that the entity can be searched by.
descriptionstring
Text of the comment.
attachmentsarray<Attachment10>
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

curl --request PUT \
  --url https://your-instance.iw-erp.de/api/employee_documents/comment/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "description": "Text"
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({data: {description: 'Text'}})
};

fetch('https://your-instance.iw-erp.de/api/employee_documents/comment/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/employee_documents/comment/42"

payload = { "data": { "description": "Text" } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://your-instance.iw-erp.de/api/employee_documents/comment/42', [
  'body' => '{"data":{"description":"Text"}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Put,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/employee_documents/comment/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"description\":\"Text\"}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"description\":\"Text\"}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/employee_documents/comment/42")
  .put(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/employee_documents/comment/42"

	payload := strings.NewReader("{\"data\":{\"description\":\"Text\"}}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/time_tracking_employee_document_comment_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/time_tracking_employee_document_comment.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await TimeTrackingEmployeeDocumentCommentController.put(TimeTrackingEmployeeDocumentComment.fromJson({
  "description": "Text"
}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "description": "Text",
  "user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "attachments": [
    {
      "id": 42,
      "ocr_from_name": "Beispiel",
      "ocr_from_email": "lena.hartmann@example.org",
      "ocr_from_phone": "+49 511 123456",
      "ocr_to_name": "Beispiel",
      "ocr_to_email": "lena.hartmann@example.org",
      "ocr_to_phone": "+49 511 123456",
      "filename": "string",
      "filesize": "string",
      "mimetype": "string"
    }
  ],
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Update a single EmployeeDocumentComment

PATCH/api/employee_documents/comment/{id}

Path parameters

idrequiredstring

Request body application/json

dataEmployeeDocumentComment2
Show fields (2)
- personCRMPerson45
  Person who wrote the comment.
- descriptionstring
  Text of the comment.

Responses

200Update a single EmployeeDocumentCommentEmployeeDocumentComment

Show fields (6)

idinteger
Primary key of the employee document comment. Internal ID.
userUser14
Login user who wrote the comment.
Show fields (10)
- idinteger
  Primary key of the user. Internal ID of the login user.
- namestring
  Display name of the user. Shown in the UI and in audit entries.
- usernamestring
  Login name of the user. Must be unique across all users.
- emailstring
  E-mail address of the user. Used for login notifications, password resets and as a login alias.
- positioningeneralstring
  Free text describing the position or role of the user.
- crm_personCRMPerson10
  CRM person linked to this login user. Connects the login account with the person record.
- profile_picture_urlstring
  URL of the profile picture of the user.
- archivedboolean
  Marks the user as archived. Archived users are kept for history and are not active.
- require2faboolean
  Two-factor authentication is required for this user.
- search_stringstring
  Text that the entity can be searched by.
descriptionstring
Text of the comment.
attachmentsarray<Attachment10>
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/employee_documents/comment/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "description": "Text"
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({data: {description: 'Text'}})
};

fetch('https://your-instance.iw-erp.de/api/employee_documents/comment/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/employee_documents/comment/42"

payload = { "data": { "description": "Text" } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://your-instance.iw-erp.de/api/employee_documents/comment/42', [
  'body' => '{"data":{"description":"Text"}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Patch,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/employee_documents/comment/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"description\":\"Text\"}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"description\":\"Text\"}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/employee_documents/comment/42")
  .patch(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/employee_documents/comment/42"

	payload := strings.NewReader("{\"data\":{\"description\":\"Text\"}}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with package:http (no controller in the iw_erp_api package)

import 'dart:convert';
import 'package:http/http.dart' as http;

final response = await http.patch(
  Uri.parse('https://your-instance.iw-erp.de/api/employee_documents/comment/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({
    "data": {
      "description": "Text"
    }
  }),
);
print(response.body);

Response 200 application/json

{
  "id": 42,
  "description": "Text",
  "user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "attachments": [
    {
      "id": 42,
      "ocr_from_name": "Beispiel",
      "ocr_from_email": "lena.hartmann@example.org",
      "ocr_from_phone": "+49 511 123456",
      "ocr_to_name": "Beispiel",
      "ocr_to_email": "lena.hartmann@example.org",
      "ocr_to_phone": "+49 511 123456",
      "filename": "string",
      "filesize": "string",
      "mimetype": "string"
    }
  ],
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Create a single EmployeeDocumentComment

POST/api/employee_documents/comment/{parentIdentifier}

Path parameters

parentIdentifierrequiredstring

Request body application/json

dataEmployeeDocumentComment2
Show fields (2)
- personCRMPerson45
  Person who wrote the comment.
- descriptionstring
  Text of the comment.

Responses

200Create a single EmployeeDocumentCommentEmployeeDocumentComment

Show fields (6)

idinteger
Primary key of the employee document comment. Internal ID.
userUser14
Login user who wrote the comment.
Show fields (10)
- idinteger
  Primary key of the user. Internal ID of the login user.
- namestring
  Display name of the user. Shown in the UI and in audit entries.
- usernamestring
  Login name of the user. Must be unique across all users.
- emailstring
  E-mail address of the user. Used for login notifications, password resets and as a login alias.
- positioningeneralstring
  Free text describing the position or role of the user.
- crm_personCRMPerson10
  CRM person linked to this login user. Connects the login account with the person record.
- profile_picture_urlstring
  URL of the profile picture of the user.
- archivedboolean
  Marks the user as archived. Archived users are kept for history and are not active.
- require2faboolean
  Two-factor authentication is required for this user.
- search_stringstring
  Text that the entity can be searched by.
descriptionstring
Text of the comment.
attachmentsarray<Attachment10>
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/employee_documents/comment/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "description": "Text"
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({data: {description: 'Text'}})
};

fetch('https://your-instance.iw-erp.de/api/employee_documents/comment/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/employee_documents/comment/42"

payload = { "data": { "description": "Text" } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/employee_documents/comment/42', [
  'body' => '{"data":{"description":"Text"}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/employee_documents/comment/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"description\":\"Text\"}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"description\":\"Text\"}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/employee_documents/comment/42")
  .post(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/employee_documents/comment/42"

	payload := strings.NewReader("{\"data\":{\"description\":\"Text\"}}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/time_tracking_employee_document_comment_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/time_tracking_employee_document.dart';
import 'package:iw_erp_api/model/time_tracking_employee_document_comment.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await TimeTrackingEmployeeDocumentCommentController.post(TimeTrackingEmployeeDocument.fromJson({
  "description": "Text"
}), TimeTrackingEmployeeDocumentComment.fromJson({
  "description": "Text"
}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "description": "Text",
  "user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "attachments": [
    {
      "id": 42,
      "ocr_from_name": "Beispiel",
      "ocr_from_email": "lena.hartmann@example.org",
      "ocr_from_phone": "+49 511 123456",
      "ocr_to_name": "Beispiel",
      "ocr_to_email": "lena.hartmann@example.org",
      "ocr_to_phone": "+49 511 123456",
      "filename": "string",
      "filesize": "string",
      "mimetype": "string"
    }
  ],
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}