Skip to main content

Document types

Every document uploaded to etg24 requires an explicit classification type (e.g. lease contract, assembly protocol, utility bill, maintenance invoice). Because document hierarchies can be tailored to portal-specific filing conventions, the API exposes dynamic, machine-readable type mappings rather than a static enumeration.

Retrieving active type mappings

Query the Property Management v2 endpoint documents.typemappings:

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

The endpoint returns an object mapping each external document type to its underlying node classes and default target filing category:

{
"contract": {
"etg24:Contract": {
"category": { "id": "cat_01J8...", "title": "Contracts" }
}
},
"invoice": {
"etg24:IncomingInvoice": {
"category": { "id": "cat_02K9...", "title": "Invoices" }
}
}
}
  • Top-level keys: The valid type identifiers to supply in document upload commands.
  • Node mappings: Internal domain classes that determine extraction schemas and indexing behavior.
  • Category: The target folder or digital archive where matching documents are automatically organized.

Deprecated types are automatically filtered

The response excludes legacy or deprecated types, ensuring your integration only references active upload targets. We recommend fetching this mapping dynamically at service startup or caching it with a reasonable TTL rather than hardcoding string constants in client code.

Reference

For parameter specifications and response structures, see the Property Management v2 reference.

Custom document classifications

If your organization requires custom document classifications or specialized filing structures for specific property portfolios, contact our team to configure tailored type mappings for your portal.