Skip to main content

Document types

Documents on etg24 have a type, and the type is required when creating new documents. The available types differ per portal and are configured together with customers — so instead of a static list, the API provides a machine-readable mapping.

Fetch the type mappings

Query the V2 endpoint documents.typemappings:

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

The response maps each document type to its node types and the target category:

{
"contract": {
"etg24:Contract": {
"category": {"id": "", "title": "Contracts"}
}
},
"invoice": {
"etg24:IncomingInvoice": {
"category": {"id": "", "title": "Invoices"}
}
}
}
  • The top-level keys are the document types you pass when creating documents.
  • Each type maps to one or more node types (the internal document classes).
  • The category tells you where documents of that type are filed (the title is present when the category exists).

Deprecated types are excluded

The response excludes deprecated types — you only see the types that are currently valid for uploads. Treat the result as the live source of truth and re-fetch it when your integration starts, not once per release.

The full reference

The generated endpoint page documents the complete response schema: List document type mappings.

New types are negotiated

Document types are configured per portal together with customers. If you need a type that does not exist yet, reach out to us — new types can be created on demand.