Skip to main content
Die Contracts-Domäne enthält Miet-, Sollstellungs- und Dienstleistungsvertragsdaten für deine Objekte. Nutze diese Endpunkte, um zeitreihenbasierte Sollstellungspositionen, monatliche Abweichungen, Details zu Dienstleistungsverträgen und Informationen zum Mietvertragsende abzurufen.

​
contract_debits

GET /contracts/contract_debits — Mietsollstellungspositionen als Zeitreihe. Jeder Datensatz repräsentiert eine geplante Sollstellung mit einem Gültigkeitsintervall.
​
integer
erforderlich
Eindeutige Objekt-ID.
​
integer
Referenziert die Einheit in Property.property_structure.
​
integer
Zusammengesetzter Schlüssel, der einen bestimmten Mieter in einer bestimmten Einheit identifiziert.
​
integer
Zusammengesetzter Schlüssel, der einen bestimmten Mieter auf Objektebene identifiziert.
​
string
Konto, auf das die Sollstellung gebucht wird.
​
number
erforderlich
Der Sollstellungsbetrag für das Gültigkeitsintervall.
​
string
Kategorie der Sollstellung, zum Beispiel Miete oder Nebenkosten.
​
number
Nettomietanteil der Sollstellung.
​
number
Nebenkostenanteil der Sollstellung.
​
date
erforderlich
Beginn des Gültigkeitsintervalls.
​
date
Ende des Gültigkeitsintervalls.
​
integer
Tag des Monats, an dem die Sollstellung fällig ist.
​
string
Status des Sollstellungsdatensatzes.
Nutze floor_area_id, um Sollstellungsdaten mit Property.property_structure zu verknüpfen, oder floor_area_person_id/property_id_person_id, um sie mit einem bestimmten Mietverhältnis in Stakeholder.tenants zu verknüpfen.

​
contract_debit_diffs

GET /contracts/contract_debit_diffs — monatliche Abweichungen zwischen dem Sollstellungsziel und den tatsächlichen Kontobewegungen. Nutze dies, um geplante Sollstellungen mit dem realisierten Zahlungsfluss abzugleichen.
​
integer
erforderlich
Eindeutige Objekt-ID.
​
integer
Zusammengesetzter Schlüssel, der den Mieter identifiziert, auf den sich diese Abweichung bezieht.
​
string
Mieter-ID.
​
string
Konto, auf das sich die Abweichung bezieht.
​
date
erforderlich
Monat, auf den sich die Abweichung bezieht.
​
number
Netto-Abweichungsbetrag für den Zeitraum.
​
number
Steueranteil der Abweichung.
​
number
Brutto-Abweichungsbetrag inklusive Steuer.
​
string
Datum, von dem an eine Zahlungserinnerung für diese Abweichung gilt, falls vorhanden.
​
string
Manuell gesetzte Erinnerungs-Übersteuerung, falls vorhanden.

​
service_contracts

GET /contracts/service_contracts — Wartungs- und Dienstleistungsverträge.
​
integer
erforderlich
Eindeutige Objekt-ID.
​
integer
erforderlich
Identifiziert den Dienstleister. Referenziert Stakeholder.creditor.
​
string
Anzeigename des Dienstleisters.
​
integer
erforderlich
Vertrags-ID.
​
string
Lesbare Vertragsnummer.
​
string
Vertragsname.
​
string
Vertragskategorie.
​
string
Vertragstyp.
​
date
Vertragsbeginn.
​
date
Vertragsende.
​
number
Vertragswert.
​
number
Vertragswert, auf einen Jahreswert normalisiert.
​
string
Begründungscode für den Vertrag.
​
string
Freitextkommentar zur Vertragsbegründung.

​
contract_ends

GET /contracts/contract_ends — Mietvertragsenden und die Handhabung von Verlängerungen/Optionen. Nutze dies, um anstehende Vertragsabläufe, Fristen für die Ausübung von Optionen und den aktuellen Ausübungsstatus zu verfolgen.
​
integer
erforderlich
Eindeutige Objekt-ID.
​
integer
Referenziert die Einheit in Property.property_structure.
​
integer
Zusammengesetzter Schlüssel, der das Mietverhältnis identifiziert, auf das sich dieser Datensatz bezieht.
​
date
Beginn des Mietverhältnisses.
​
date
Vertragliches Ende des Mietverhältnisses.
​
date
Tatsächliches Vertragsende nach Anwendung jeglicher Optionslogik.
​
date
Neues Enddatum, falls das Mietverhältnis verlängert wurde.
​
date
Datum, an dem der Mieter aufgefordert wurde, über eine Verlängerungsoption zu entscheiden.
​
date
Frist für die Antwort des Mieters.
​
date
Datum, an dem der Mieter tatsächlich geantwortet hat.
​
string
Wie der Mieter geantwortet hat (z. B. ausgeübt, abgelehnt).
​
date
Frist, bis zu der eine Verlängerungsoption ausgeübt werden muss.
​
boolean
Ob die Option automatisch ausgeübt wird, wenn der Mieter nicht antwortet.
​
integer
Anzahl der bereits genutzten Verlängerungsoptionen.
​
integer
Anzahl der noch verfügbaren Verlängerungsoptionen.
​
integer
Verlängerungsdauer in Monaten. Beachte, dass der Feldname das zugrunde liegende Quellsystem widerspiegelt und eine Rechtschreibunregelmäßigkeit enthält (controct, nicht contract) — dies ist kein Tippfehler in dieser Dokumentation.