Zum Inhalt springen
Developer

EmployeeDocumentComment

Personal5 EndpunkteTimeTracking / EmployeeDocumentComment

Alle EmployeeDocumentComment für ein einzelnes EmployeeDocument abrufen

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

Pfad-Parameter

parentIdentifierPflichtstring

Query-Parameter

idinteger
documentstring
userstring
personstring
createdstring
searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Alle EmployeeDocumentComment für ein einzelnes EmployeeDocument abrufenarray<EmployeeDocumentComment>

Felder anzeigen (6)
  • idinteger

    Primärschlüssel des Kommentars zum Mitarbeiterdokument. Interne ID.

  • userUser14

    Benutzer, der den Kommentar verfasst hat.

    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.

    • namestring

      Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.

    • usernamestring

      Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.

    • emailstring

      E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.

    • positioningeneralstring

      Freitext zur Position oder Rolle des Benutzers.

    • crm_personCRMPerson10

      CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.

    • profile_picture_urlstring

      URL des Profilbilds des Benutzers.

    • archivedboolean

      Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.

    • require2faboolean

      Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • descriptionstring

    Text des Kommentars.

  • attachmentsarray<Attachment10>
    Felder anzeigen (25)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdbyusernamestring

      Name des Benutzers, der die Datei hochgeladen hat, als Text.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googleidstring

      ID der Datei in Google Drive.

    • scopestring

      Scope, der steuert, wer den Anhang sehen kann.

    • ocr_document_typestring

      Dokumenttyp, der per OCR erkannt wurde.

    • ocr_from_namestring

      Per OCR erkannter Absendername.

    • ocr_from_companystring

      Per OCR erkanntes Absenderunternehmen.

    • ocr_from_addressstring

      Per OCR erkannte Absenderadresse.

    • ocr_from_emailstring

      Per OCR erkannte Absender-E-Mail-Adresse.

    • ocr_from_phonestring

      Per OCR erkannte Absender-Telefonnummer.

    • ocr_to_namestring

      Per OCR erkannter Name des Empfängers.

    • ocr_to_companystring

      Per OCR erkanntes Empfängerunternehmen.

    • ocr_to_addressstring

      Per OCR erkannte Empfängeradresse.

    • ocr_to_emailstring

      Per OCR erkannte E-Mail-Adresse des Empfängers.

    • ocr_to_phonestring

      Per OCR erkannte Telefonnummer des Empfängers.

    • ocr_summarystring

      Zusammenfassung des per OCR erstellten Dokuments.

    • ocr_statusstring

      OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error

    • ocr_errorstring

      Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war

    • ocr_processed_atstring (date-time)

      Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.

    • virus_checkedboolean

      1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.

    • virus_checked_atstring (date-time)

      Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/employee_documents/comment/for_parent/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 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"
  }
]

Einzelnen EmployeeDocumentComment abrufen

GET/api/employee_documents/comment/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Einzelnen EmployeeDocumentComment abrufenEmployeeDocumentComment

Felder anzeigen (6)
  • idinteger

    Primärschlüssel des Kommentars zum Mitarbeiterdokument. Interne ID.

  • userUser14

    Benutzer, der den Kommentar verfasst hat.

    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.

    • namestring

      Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.

    • usernamestring

      Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.

    • emailstring

      E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.

    • positioningeneralstring

      Freitext zur Position oder Rolle des Benutzers.

    • crm_personCRMPerson10

      CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.

    • profile_picture_urlstring

      URL des Profilbilds des Benutzers.

    • archivedboolean

      Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.

    • require2faboolean

      Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • descriptionstring

    Text des Kommentars.

  • attachmentsarray<Attachment10>
    Felder anzeigen (25)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdbyusernamestring

      Name des Benutzers, der die Datei hochgeladen hat, als Text.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googleidstring

      ID der Datei in Google Drive.

    • scopestring

      Scope, der steuert, wer den Anhang sehen kann.

    • ocr_document_typestring

      Dokumenttyp, der per OCR erkannt wurde.

    • ocr_from_namestring

      Per OCR erkannter Absendername.

    • ocr_from_companystring

      Per OCR erkanntes Absenderunternehmen.

    • ocr_from_addressstring

      Per OCR erkannte Absenderadresse.

    • ocr_from_emailstring

      Per OCR erkannte Absender-E-Mail-Adresse.

    • ocr_from_phonestring

      Per OCR erkannte Absender-Telefonnummer.

    • ocr_to_namestring

      Per OCR erkannter Name des Empfängers.

    • ocr_to_companystring

      Per OCR erkanntes Empfängerunternehmen.

    • ocr_to_addressstring

      Per OCR erkannte Empfängeradresse.

    • ocr_to_emailstring

      Per OCR erkannte E-Mail-Adresse des Empfängers.

    • ocr_to_phonestring

      Per OCR erkannte Telefonnummer des Empfängers.

    • ocr_summarystring

      Zusammenfassung des per OCR erstellten Dokuments.

    • ocr_statusstring

      OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error

    • ocr_errorstring

      Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war

    • ocr_processed_atstring (date-time)

      Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.

    • virus_checkedboolean

      1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.

    • virus_checked_atstring (date-time)

      Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/employee_documents/comment/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 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"
}

EmployeeDocumentComment einzeln aktualisieren

PUT/api/employee_documents/comment/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • dataEmployeeDocumentComment2
    Felder anzeigen (2)
    • personCRMPerson45

      Person, die den Kommentar verfasst hat.

    • descriptionstring

      Text des Kommentars.

Antworten

200EmployeeDocumentComment einzeln aktualisierenEmployeeDocumentComment

Felder anzeigen (6)
  • idinteger

    Primärschlüssel des Kommentars zum Mitarbeiterdokument. Interne ID.

  • userUser14

    Benutzer, der den Kommentar verfasst hat.

    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.

    • namestring

      Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.

    • usernamestring

      Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.

    • emailstring

      E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.

    • positioningeneralstring

      Freitext zur Position oder Rolle des Benutzers.

    • crm_personCRMPerson10

      CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.

    • profile_picture_urlstring

      URL des Profilbilds des Benutzers.

    • archivedboolean

      Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.

    • require2faboolean

      Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • descriptionstring

    Text des Kommentars.

  • attachmentsarray<Attachment10>
    Felder anzeigen (25)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdbyusernamestring

      Name des Benutzers, der die Datei hochgeladen hat, als Text.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googleidstring

      ID der Datei in Google Drive.

    • scopestring

      Scope, der steuert, wer den Anhang sehen kann.

    • ocr_document_typestring

      Dokumenttyp, der per OCR erkannt wurde.

    • ocr_from_namestring

      Per OCR erkannter Absendername.

    • ocr_from_companystring

      Per OCR erkanntes Absenderunternehmen.

    • ocr_from_addressstring

      Per OCR erkannte Absenderadresse.

    • ocr_from_emailstring

      Per OCR erkannte Absender-E-Mail-Adresse.

    • ocr_from_phonestring

      Per OCR erkannte Absender-Telefonnummer.

    • ocr_to_namestring

      Per OCR erkannter Name des Empfängers.

    • ocr_to_companystring

      Per OCR erkanntes Empfängerunternehmen.

    • ocr_to_addressstring

      Per OCR erkannte Empfängeradresse.

    • ocr_to_emailstring

      Per OCR erkannte E-Mail-Adresse des Empfängers.

    • ocr_to_phonestring

      Per OCR erkannte Telefonnummer des Empfängers.

    • ocr_summarystring

      Zusammenfassung des per OCR erstellten Dokuments.

    • ocr_statusstring

      OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error

    • ocr_errorstring

      Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war

    • ocr_processed_atstring (date-time)

      Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.

    • virus_checkedboolean

      1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.

    • virus_checked_atstring (date-time)

      Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/employee_documents/comment/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "description": "Text"
  }
}
'
Antwort 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"
}

EmployeeDocumentComment einzeln aktualisieren

PATCH/api/employee_documents/comment/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • dataEmployeeDocumentComment2
    Felder anzeigen (2)
    • personCRMPerson45

      Person, die den Kommentar verfasst hat.

    • descriptionstring

      Text des Kommentars.

Antworten

200EmployeeDocumentComment einzeln aktualisierenEmployeeDocumentComment

Felder anzeigen (6)
  • idinteger

    Primärschlüssel des Kommentars zum Mitarbeiterdokument. Interne ID.

  • userUser14

    Benutzer, der den Kommentar verfasst hat.

    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.

    • namestring

      Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.

    • usernamestring

      Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.

    • emailstring

      E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.

    • positioningeneralstring

      Freitext zur Position oder Rolle des Benutzers.

    • crm_personCRMPerson10

      CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.

    • profile_picture_urlstring

      URL des Profilbilds des Benutzers.

    • archivedboolean

      Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.

    • require2faboolean

      Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • descriptionstring

    Text des Kommentars.

  • attachmentsarray<Attachment10>
    Felder anzeigen (25)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdbyusernamestring

      Name des Benutzers, der die Datei hochgeladen hat, als Text.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googleidstring

      ID der Datei in Google Drive.

    • scopestring

      Scope, der steuert, wer den Anhang sehen kann.

    • ocr_document_typestring

      Dokumenttyp, der per OCR erkannt wurde.

    • ocr_from_namestring

      Per OCR erkannter Absendername.

    • ocr_from_companystring

      Per OCR erkanntes Absenderunternehmen.

    • ocr_from_addressstring

      Per OCR erkannte Absenderadresse.

    • ocr_from_emailstring

      Per OCR erkannte Absender-E-Mail-Adresse.

    • ocr_from_phonestring

      Per OCR erkannte Absender-Telefonnummer.

    • ocr_to_namestring

      Per OCR erkannter Name des Empfängers.

    • ocr_to_companystring

      Per OCR erkanntes Empfängerunternehmen.

    • ocr_to_addressstring

      Per OCR erkannte Empfängeradresse.

    • ocr_to_emailstring

      Per OCR erkannte E-Mail-Adresse des Empfängers.

    • ocr_to_phonestring

      Per OCR erkannte Telefonnummer des Empfängers.

    • ocr_summarystring

      Zusammenfassung des per OCR erstellten Dokuments.

    • ocr_statusstring

      OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error

    • ocr_errorstring

      Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war

    • ocr_processed_atstring (date-time)

      Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.

    • virus_checkedboolean

      1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.

    • virus_checked_atstring (date-time)

      Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/employee_documents/comment/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "description": "Text"
  }
}
'
Antwort 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"
}

Einzelnen EmployeeDocumentComment anlegen

POST/api/employee_documents/comment/{parentIdentifier}

Pfad-Parameter

parentIdentifierPflichtstring

Request-Body application/json

  • dataEmployeeDocumentComment2
    Felder anzeigen (2)
    • personCRMPerson45

      Person, die den Kommentar verfasst hat.

    • descriptionstring

      Text des Kommentars.

Antworten

200Einzelnen EmployeeDocumentComment anlegenEmployeeDocumentComment

Felder anzeigen (6)
  • idinteger

    Primärschlüssel des Kommentars zum Mitarbeiterdokument. Interne ID.

  • userUser14

    Benutzer, der den Kommentar verfasst hat.

    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.

    • namestring

      Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.

    • usernamestring

      Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.

    • emailstring

      E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.

    • positioningeneralstring

      Freitext zur Position oder Rolle des Benutzers.

    • crm_personCRMPerson10

      CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.

    • profile_picture_urlstring

      URL des Profilbilds des Benutzers.

    • archivedboolean

      Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.

    • require2faboolean

      Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • descriptionstring

    Text des Kommentars.

  • attachmentsarray<Attachment10>
    Felder anzeigen (25)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdbyusernamestring

      Name des Benutzers, der die Datei hochgeladen hat, als Text.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googleidstring

      ID der Datei in Google Drive.

    • scopestring

      Scope, der steuert, wer den Anhang sehen kann.

    • ocr_document_typestring

      Dokumenttyp, der per OCR erkannt wurde.

    • ocr_from_namestring

      Per OCR erkannter Absendername.

    • ocr_from_companystring

      Per OCR erkanntes Absenderunternehmen.

    • ocr_from_addressstring

      Per OCR erkannte Absenderadresse.

    • ocr_from_emailstring

      Per OCR erkannte Absender-E-Mail-Adresse.

    • ocr_from_phonestring

      Per OCR erkannte Absender-Telefonnummer.

    • ocr_to_namestring

      Per OCR erkannter Name des Empfängers.

    • ocr_to_companystring

      Per OCR erkanntes Empfängerunternehmen.

    • ocr_to_addressstring

      Per OCR erkannte Empfängeradresse.

    • ocr_to_emailstring

      Per OCR erkannte E-Mail-Adresse des Empfängers.

    • ocr_to_phonestring

      Per OCR erkannte Telefonnummer des Empfängers.

    • ocr_summarystring

      Zusammenfassung des per OCR erstellten Dokuments.

    • ocr_statusstring

      OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error

    • ocr_errorstring

      Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war

    • ocr_processed_atstring (date-time)

      Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.

    • virus_checkedboolean

      1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.

    • virus_checked_atstring (date-time)

      Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/employee_documents/comment/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "description": "Text"
  }
}
'
Antwort 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"
}