property_id ist der Verknüpfungsschlüssel, den sich Property mit jeder anderen Domäne teilt
— das komplette domänenübergreifende Diagramm sowie die Schlüsselreferenz stehen in der
Datenmodell-Übersicht. Das Diagramm unten zeigt die
Property-internen Verknüpfungen (durchgezogen) zusammen mit jeder Kante, die von außen auf
eine Property-Tabelle zeigt (gestrichelt).
properties
GET /v1/property/properties — Objekt-Stammdaten: Adresse, Nutzungsart und Koordinaten.
string
erforderlich
Eindeutige Objektkennung.
string[]
Eingangs-/Straßenbezeichnungen des Objekts, bis zu fünf. Leere Einträge werden weggelassen.
object
Verwaltungsmandat für dieses Objekt.
string
Objektnummer der buchenden Einheit, unter der dieses Objekt bucht. Ein verifizierter,
selbstreferenzierender Fremdschlüssel auf
property_id — gegen eine andere Zeile desselben
Endpunkts auflösen.string
Objektbezeichnung.
string
Postleitzahl.
string
Ort, bereinigt.
string
Land. Aktuell bei allen Objekten immer leer.
integer
Baujahr.
number
Geografische Länge.
number
Geografische Breite.
string
Bundesland.
string
Nutzungsart des Objekts.
string
Objektkategorie: Mietobjekt, Hauptbuchhaltung, Mandant oder Verwaltung.
string
Steuermodell-Code. Für diesen Code existiert keine dokumentierte Label-Zuordnung.
string
Link zum verknüpften Dokument im DMS.
property_structure
GET /v1/property/property_structure — jeder Strukturbestandteil eines Objekts, flach als
eine Zeile pro Bestandteil: das Objekt selbst, ein Gebäude, ein Gebäudeteil/Eingang, eine
Etage oder eine Fläche/Mieteinheit.
string
erforderlich
Eindeutige Objektkennung.
string
Kostenstellen-Geschäftscode dieser Zeile. Matcht
accounts.account_number, nicht
accounts.account_id — die vollständige Schlüsselreferenz steht in der
Übersicht.integer
Kennzeichnet eine Fläche. Nur befüllt für Zeilen, die eine Fläche/Mieteinheit darstellen.
object[]
Position des Bestandteils in der Objekt-Strukturhierarchie, als geordnete Liste von
{name, type}-Ebenen. Leere Ebenen werden weggelassen.object
Um welche Art Strukturbestandteil es sich bei dieser Zeile handelt.
object
Mandatszeitraum für diesen Bestandteil.
object
Gültigkeitszeitraum der Fläche.
object
Kombiniertes Aktiv-Fenster über die zugrundeliegenden Quellzeiträume.
boolean
Ob diese Zeile aus einem echten Beteiligungskreis stammt, mandantenunabhängig.
boolean
Ob diese Zeile zur Kern-Gebäudestruktur des Objekts gehört (Gebäude, Gebäudeteil oder
Etage) statt zu einer Fläche.
string
Ebene der Kern-Gebäudestruktur: Gebäude, Gebäudeteil oder Etage.
null, wenn
is_core_structure false ist.string
Objektname.
string
Kostenstellenbezeichnung.
string
Flächennummer.
string
Adresse dieses Bestandteils.
string
Eingangsbezeichnung.
string
Gebäudeteilbezeichnung.
string
Etagenbezeichnung.
string
Flächenbezeichnung.
string
Lageangabe.
string
Nutzungsart der Fläche.
boolean
Ob diese Fläche von der Vermarktung ausgeschlossen ist.
number
Sollmiete je Quadratmeter.
number
Marktmiete je Quadratmeter.
string
Heizungsart.
string
Leerstandsgrund-Code.
string
Nur mit dem Grant
personal sichtbar.
Freitext-Kommentar zum Leerstandsgrund.date
Beginn des Leerstands.
string
URL eines Fotos der Fläche.
number
Flächengröße in Quadratmetern.
number
Sollmiete gesamt.
number
Marktmiete gesamt.
string
Link zum verknüpften Dokument im DMS.
property_creditor_services
GET /v1/property/property_creditor_services — welche Kreditoren (Dienstleister) einem
Objekt nach Gewerk zugeordnet sind.
string
erforderlich
Eindeutige Objektkennung.
string
erforderlich
Kennzeichnet den Kreditor. Siehe
Stakeholder.creditors.object
Ob dieser Kreditor das Gewerk für das Objekt exklusiv hält.
string
Das Gewerk, das diese Zuordnung abdeckt.
technical_objects
GET /v1/property/technical_objects — technische Anlagen und Geräte mit Standort-,
Wartungs- und Prüfinformationen.
string
erforderlich
Eindeutige Objektkennung.
string
Für die Anlage zuständiger Kreditor, sofern vorhanden.
integer
Fläche, in der sich die Anlage befindet, sofern auf dieser Ebene zugeordnet.
integer
erforderlich
Eindeutige Kennung der technischen Anlage.
string
Geschäftsnummer der technischen Anlage.
string
Bezeichnung der technischen Anlage.
string
Typ/Kategorie der Anlage.
string
Nur mit dem Grant
personal sichtbar.
Für die Anlage zuständiger Mitarbeiter.date
Einbau-/Herstellungsdatum.
date
Datum der letzten Prüfung.
date
Datum der letzten Wartung.
string
Nur mit dem Grant
personal sichtbar.
Freitext-Kommentar.boolean
Ob es sich um einen Zähler handelt.
boolean
Ob die Anlage wartungspflichtig ist.
string
Wartungstyp-Code.
string
Für die Wartung zuständiger Kreditor.
string
Nur mit dem Grant
personal sichtbar.
Name des Wartungskreditors.boolean
Ob die Anlage prüfungspflichtig ist.
string
Prüfungstyp-Code.
boolean
Ob die Anlage außer Betrieb ist.
string
Servicevertrag, der diese Anlage abdeckt, sofern vorhanden. Siehe
Contracts.service_contracts.string
Fremdschlüssel auf
property_structure. Nur gesetzt für Zeilen ohne floor_area_id — wo
floor_area_id gesetzt ist, ist das bereits der Verknüpfungspfad zur Fläche und dieses Feld
bleibt leer.object
Garantiezeitraum, sofern erfasst.