Dokumenttypen

Jedes Dokument auf etg24 besitzt einen definierten Klassifizierungstyp (z. B. Mietvertrag, Versammlungsprotokoll, Energieausweis, Handwerkerrechnung), der beim Hochladen zwingend angegeben werden muss. Da Ablagestrukturen je nach Verwaltung und Liegenschaft individuell konfiguriert werden können, stellt die API anstelle einer statischen Liste ein dynamisches, maschinenlesbares Mapping bereit.

Aktive Typ-Mappings abfragen

Frage den Property Management v2 Endpunkt documents.typemappings ab:

curl -s "https://api.etg24.de/propertymanagement/v2/query/documents.typemappings" \
  -H "Authorization: Bearer DEIN_API_KEY"

Die Antwort liefert ein Objekt, das jeden Dokumenttyp auf seine internen Node-Klassen und die standardmäßige Ablagekategorie abbildet:

{
  "contract": {
    "etg24:Contract": {
      "category": { "id": "cat_01J8...", "title": "Verträge" }
    }
  },
  "invoice": {
    "etg24:IncomingInvoice": {
      "category": { "id": "cat_02K9...", "title": "Rechnungen" }
    }
  }
}

• Schlüssel der obersten Ebene: Die gültigen type-Parameter, die du bei Upload-Befehlen übergibst.
• Node-Typen: Interne Dokumentklassen, die Extraktionsschemas und Such-Indexierung steuern.
• Kategorie: Der Zielordner in der digitalen Akte, in dem das Dokument automatisch abgelegt wird.

Veraltete Typen werden automatisch gefiltert

Die Antwort schließt veraltete oder nicht mehr aktive Dokumenttypen automatisch aus. Wir empfehlen, dieses Mapping beim Start deines Services dynamisch abzurufen oder mit einer angemessenen Gültigkeitsdauer (TTL) im Cache zu halten, statt feste String-Konstanten im Code zu verdrahten.

Referenz

Die vollständige Spezifikation des Antwortschemas findest du in der Property Management v2 Referenz.