service_contracts
GET /v1/contracts/service_contracts — Wartungs- und Dienstleistungsverträge.
string
erforderlich
Eindeutige Objekt-ID.
object
Gültigkeitszeitraum des Vertrags.
string
erforderlich
Identifiziert den Dienstleister. Referenziert
Stakeholder.creditors.string
Nur mit dem Grant
personal sichtbar.
Anzeigename des Dienstleisters.string
erforderlich
Vertrags-ID.
string
Lesbare Vertragsnummer.
string
Vertragsname.
string
Vertragskategorie.
string
Vertragstyp.
number
Vertragswert.
number
Vertragswert, auf einen Jahreswert normalisiert.
string
Nur mit dem Grant
personal sichtbar.
Begründungscode für den Vertrag.string
Nur mit dem Grant
personal sichtbar.
Freitextkommentar zur Vertragsbegründung.contract_debit_diffs
GET /v1/contracts/contract_debit_diffs — monatliche Abweichungen zwischen dem
Sollstellungsziel und den tatsächlichen Kontobewegungen. Damit lassen sich geplante
Sollstellungen mit dem tatsächlichen Zahlungsfluss abgleichen.
string
erforderlich
Eindeutige Objekt-ID.
object
Netto-, Steuer- und Bruttoabweichungsbetrag für den Zeitraum.
string
Personenkonto, auf das sich die Abweichung bezieht. Entspricht
Accounting.accounts.account_number — trotz ähnlich klingendem Namen nicht dasselbe wie
contract_debits.debit_type.code, und eine andere Kontoart als
contract_debits.account_number (Sachkonto).string
Mieter-ID.
date
erforderlich
Monat, auf den sich die Abweichung bezieht.
date
Datum, von dem an eine Zahlungserinnerung für diese Abweichung gilt, falls vorhanden.
boolean
Ob die Erinnerung manuell gesetzt wurde statt automatisch erzeugt.
contract_debits
GET /v1/contracts/contract_debits — Mietsollstellungspositionen als Zeitreihe. Jeder
Datensatz repräsentiert eine geplante Sollstellung mit einem Gültigkeitsintervall.
string
erforderlich
Eindeutige Objekt-ID.
integer
Referenziert die Einheit in
Property.property_structure.string
Identifiziert das Mietverhältnis, auf das sich diese Sollstellung bezieht.
integer
Zusammengesetzter Schlüssel, der den Mieter auf Objektebene identifiziert.
string
Sachkonto, auf das die Sollstellung gebucht wird. Entspricht
Accounting.accounts.account_number, nicht account_id.object
Gültigkeitsintervall der Sollstellung.
integer
Tag des Monats, an dem die Sollstellung fällig ist.
null, wenn im Quellsystem kein
Tag gesetzt ist.object
Art der Sollstellung als Code+Label-Paar (z. B. Miete oder Nebenkosten).
number
erforderlich
Der Sollstellungsbetrag für das Gültigkeitsintervall.
string
Kontengruppe aus dem Kontenmapping.
string
Status des Sollstellungsdatensatzes.
boolean
Ob die Sollstellung umsatzsteuerpflichtig ist.
boolean
Ob die Sollstellung einen Nettomietanteil enthält.
boolean
Ob die Sollstellung einen Nebenkostenanteil enthält.
contract_ends
GET /v1/contracts/contract_ends — Mietvertragsenden und die Handhabung von
Verlängerungen/Optionen. Hilfreich, um anstehende Vertragsabläufe, Fristen für die
Ausübung von Optionen und den aktuellen Ausübungsstatus zu verfolgen.
Dieser Endpunkt verlangt den Query-Parameter
property_id — eine Anfrage ohne ihn
beantwortet die API mit 400 Bad Request und "Missing required filter(s): ['property_id']". Siehe Filterung.string
erforderlich
Eindeutige Objekt-ID.
integer
Referenziert die Einheit in
Property.property_structure.string
Identifiziert das Mietverhältnis, auf das sich dieser Datensatz bezieht.
object
Beginn des Mietverhältnisses und dessen tatsächliches Ende nach Anwendung jeglicher
Optionslogik.
date
Neues Enddatum, falls das Mietverhältnis verlängert wurde.
integer
Verlängerungsdauer in Monaten.
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.
integer
Code dafür, wie der Mieter geantwortet hat.
date
Frist, bis zu der eine Verlängerungsoption ausgeübt werden muss.
integer
Vorlaufzeit in Monaten vor
option_deadline, ab der Erinnerungen ausgelöst werden.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.
boolean
Ob das Mietverhältnis gekündigt wurde.
string
Kündigungsgrund, falls
is_terminated gleich true ist.object
Status der Verlängerungsoption als Code+Label-Paar.
string[]
Freitextanmerkungen zur Verlängerungsoption. Leere Positionen werden aus dem Array
weggelassen.
index_rent
GET /v1/contracts/index_rent — Konfiguration und Zustand der Indexmietanpassung, auf
Basis eines Verbraucherpreisindex (VPI).
string
erforderlich
Eindeutige Objekt-ID.
string
Identifiziert das Mietverhältnis, auf das sich dieser Indexmietzustand bezieht.
object
Gültigkeitsintervall dieses Indexmietzustands.
object
Das angewendete Berechnungsmodell für den Index, als Code+Label-Paar.
boolean
Ob dies der aktuell gültige Indexmietzustand für das Mietverhältnis ist, im Gegensatz zu
einem historischen, überholten Zustand.
integer
Sollart-Code, auf den sich dieser Indexmietzustand bezieht. Kein Kontenbezug — entspricht
contract_debits.debit_type.code.string
Name der zugrunde liegenden Verbraucherpreisindex-Reihe, z. B. “VPI 2020”.
integer
Basisjahr, auf das die Indexreihe normalisiert ist (Index = 100).
number
Indexwert für den Kalendermonat, in dem dieser Zustand beginnt — der Basiswert, gegen
den der aktuelle Index zur Berechnung einer Änderung verglichen wird.
number
Mindest-Indexänderung, die eine Mietanpassung auslöst, in der durch
adjustment_unit
vorgegebenen Einheit.string
Einheit von
adjustment_threshold und des Indexänderungsvergleichs: "Prozent"
(prozentuale Änderung) oder "Punkte" (absolute Indexpunkte).number
Prozentsatz der Indexänderung, der tatsächlich an die Miete weitergegeben wird —
100
gibt die volle Änderung weiter, ein niedrigerer Wert nur einen Teil davon.boolean
Ob eine Mietanpassung für dieses Mietverhältnis aktuell gesperrt ist.
date
Datum, bis zu dem
is_adjustment_locked gilt.boolean
Ob eine förmliche Mitteilung an den Mieter erforderlich ist, damit die Anpassung wirksam
wird — relevant, wenn
adjustment_type datumsbasiert ist.integer
Anzahl Monate, nach denen eine Anpassung möglich wird. Wird zusammen mit
adjustment_type = "Anpassung nach Ablauf Monaten" verwendet.integer
Numerischer Periodenparameter, den
calculation_model verwendet. Einheit und genaue
Bedeutung je Modell sind im Quellsystem nicht dokumentiert.integer
Maximale Anzahl Monate, nach denen eine Neuberechnung erfolgen muss.
string
Ob die Anpassung zu einem festen Kalenderdatum (
"Anpassung zu Datum") oder nach
Ablauf einer definierten Anzahl Monate ("Anpassung nach Ablauf Monaten") ausgelöst
wird.string
Nur mit dem Grant
personal sichtbar.
Freitextkommentar.date
Beginn einer vertragsbeschnittenen Variante des Gültigkeitsintervalls.
date
Ende einer vertragsbeschnittenen Variante des Gültigkeitsintervalls.
date
Beginn des Mietverhältnisses, wie auf diesem Datensatz geführt.
date
Ende des Mietverhältnisses, wie auf diesem Datensatz geführt.