Skip to main content

Dokumenttypen

Dokumente auf etg24 haben einen Typ, und der Typ ist beim Anlegen neuer Dokumente Pflicht. Die verfügbaren Typen unterscheiden sich pro Portal und werden gemeinsam mit Kunden konfiguriert – deshalb stellt die API statt einer statischen Liste ein maschinenlesbares Mapping bereit.

Die Typ-Zuordnungen abrufen

Frage den V2-Endpoint documents.typemappings ab:

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

Die Antwort bildet jeden Dokumenttyp auf seine Node-Typen und die Zielkategorie ab:

{
"contract": {
"etg24:Contract": {
"category": {"id": "", "title": "Verträge"}
}
},
"invoice": {
"etg24:IncomingInvoice": {
"category": {"id": "", "title": "Rechnungen"}
}
}
}
  • Die Schlüssel der obersten Ebene sind die Dokumenttypen, die du beim Anlegen von Dokumenten übergibst.
  • Jeder Typ bildet auf einen oder mehrere Node-Typen ab (die internen Dokumentklassen).
  • Die category zeigt, wo Dokumente dieses Typs abgelegt werden (der Titel ist vorhanden, wenn die Kategorie existiert).

Veraltete Typen sind ausgeschlossen

Die Antwort schließt veraltete Typen aus – du siehst nur die Typen, die aktuell für Uploads gültig sind. Behandle das Ergebnis als lebende Quelle der Wahrheit und rufe es beim Start deiner Integration neu ab, nicht einmal pro Release.

Die vollständige Referenz

Die generierte Endpoint-Seite dokumentiert das komplette Antwort-Schema: List document type mappings.

Neue Typen werden vereinbart

Dokumenttypen werden pro Portal gemeinsam mit Kunden konfiguriert. Brauchst du einen Typ, den es noch nicht gibt, kontaktiere uns – neue Typen können auf Anfrage angelegt werden.