ZeroImmo

ZeroImmo: MCP-Doku

Für Agenten als Text: llms.txt (Übersicht) und llms-full.txt (alles, mit Eingaben jeder Funktion).

Was ist ZeroImmo?

ZeroImmo ist eine Plattform für private Vermieter in Deutschland, ohne Abo; alle eigenen Funktionen sind kostenlos, nur optionale Zusatzleistungen kosten Guthaben (Abschnitt „Preise und Guthaben“): Immobilien und Einheiten, Mietverträge, Mieten und offene Posten, Bankabgleich, Rechnungen, Dokumente, Nebenkosten-, Heizkosten- und WEG-Abrechnung, Zähler, Steuer (Anlage V und AfA), Kaufpreisaufteilung nach der BMF-Arbeitshilfe, Schreiben an Mieter, Aufgaben und Fahrten.

ZeroImmo hat eine eingebaute KI in der Web-App. Daneben arbeitest du mit deinem eigenen Agenten (zum Beispiel Claude, Codex, Antigravity oder Langdock) über MCP oder die REST-API; dieser Zugang ist kostenlos. Diese Doku sagt deinem Agenten, was er tun kann. Sie wird aus dem Code erzeugt und passt immer zur laufenden Version.

Verbinden

Claude Code

claude mcp add --transport http zeroimmo https://zeroimmo.de/api/mcp --header "Authorization: Bearer vos_…"

Codex (~/.codex/config.toml; den Token vorher als Umgebungsvariable ZEROIMMO_TOKEN setzen)

[mcp_servers.zeroimmo]
url = "https://zeroimmo.de/api/mcp"
bearer_token_env_var = "ZEROIMMO_TOKEN"

Antigravity mit Login-Fenster (global in ~/.gemini/config/mcp_config.json, für ein Projekt in .agents/mcp_config.json; danach „Authenticate“, siehe oben)

{
  "mcpServers": {
    "zeroimmo": {
      "serverUrl": "https://zeroimmo.de/api/mcp"
    }
  }
}

Antigravity mit Token (dieselbe Datei)

{
  "mcpServers": {
    "zeroimmo": {
      "serverUrl": "https://zeroimmo.de/api/mcp",
      "headers": { "Authorization": "Bearer vos_…" }
    }
  }
}

Cursor und andere Clients ohne Login-Fenster: die Server-URL eintragen und als Authentifizierung einen API-Key im Header Authorization: Bearer wählen.

Ein neues Konto einrichten

Ein leeres Konto richtet der Agent in dieser Reihenfolge ein. get_started zeigt, was schon da ist und welche Schritte fehlen; der Prompt einrichten führt durch den Ablauf. Ein Platzhalter wie <propertyId> steht für die ID aus dem Ergebnis eines vorigen Schritts.

1. Immobilie anlegen mit `create_property`

{
  "name": "Lindenstraße 5",
  "propertyType": "multi_family",
  "street": "Lindenstraße",
  "houseNumber": "5",
  "postalCode": "10115",
  "city": "Berlin"
}

Eine Eigentumswohnung, ein Einfamilienhaus, eine Garage oder ein Stellplatz ist selbst die Einheit: propertyType "condominium" (usw.) mit firstUnit: { "areasValidFrom": "2024-01-01", "livingAreaSqm": "68,5" }; dann entfällt create_unit. Ergebnis: propertyId (und unitId).

2. Einheiten anlegen: je Wohnung, Gewerbeeinheit, Garage oder Stellplatz mit `create_unit`

{
  "propertyId": "<propertyId>",
  "label": "EG links",
  "unitType": "apartment",
  "areasValidFrom": "2024-01-01",
  "livingAreaSqm": "74,5",
  "rooms": 3
}

Fläche in m² als Zahl oder Text („74,5“), Wohnfläche oder Nutzfläche ist Pflicht; areasValidFrom ist der Tag, ab dem die Fläche gilt. Ergebnis: unitId.

3. Mieter und Mitmieter anlegen mit `create_person`

{
  "firstName": "Erika",
  "lastName": "Musterfrau",
  "email": "erika@example.org"
}

Eine Firma: kind "legal" und companyName. Ergebnis: personId.

4. Mietvertrag anlegen mit `create_lease`

{
  "unitId": "<unitId>",
  "startDate": "2024-03-01",
  "parties": [
    {
      "personId": "<personId>",
      "role": "main_tenant"
    }
  ],
  "rent": [
    {
      "kind": "base_rent",
      "amountCents": 75000
    },
    {
      "kind": "operating_prepayment",
      "amountCents": 15000
    },
    {
      "kind": "heating_prepayment",
      "amountCents": 8000
    }
  ],
  "deposit": {
    "agreedCents": 225000
  }
}

Beträge in ganzen Cent (75000 = 750,00 €). Genau ein Hauptmieter; weitere Mieter mit role co_tenant. Befristet: fixedTerm true und endDate. Ergebnis: leaseId.

5. Mietkonto anlegen, damit Kontoauszüge abgeglichen werden können mit `create_bank_account` (optional)

{
  "iban": "DE89370400440532013000",
  "name": "Mietkonto"
}

Ergebnis: bankAccountId. Kontoauszüge (CSV, camt.053) liest danach import_bank_file ein.

6. Ältere Monate eines Mietvertrags nachbuchen (laufende Monate bucht ZeroImmo täglich selbst) mit `generate_monthly_charges` (optional)

{
  "leaseId": "<leaseId>",
  "month": "2026-01",
  "bookingDate": "2026-01-01"
}

Nur für einen Monat vor der Erfassung, den der Vermieter bestätigt; je Vertrag, wiederholbar, legt nichts doppelt an.

Vermieterdaten

Mietverträge, Schreiben, Abrechnungen und die Link-Mails nehmen Name, Anschrift, die E-Mail-Adresse für Antworten und das Mietkonto aus den Vermieterdaten. Dein Agent pflegt sie selbst; im Web stehen sie unter Einstellungen → Vermieterdaten.

So arbeitet dein Agent

Rechte und Freigaben

Datensparmodus

Ist er an (Standard), sieht der Agent Personen nur als Pseudonym („Person 3f2a9c1d“) und keine Kontaktdaten. Braucht eine Aufgabe die echten Daten, ruft er reveal_personal_data mit einem Zweck auf, höchstens 30-mal pro Stunde je Token. Notizen zur Vermietung an Angehörige und zur Nutzung von Einheiten sowie Namen von Steuerberatern bleiben in diesem Modus verborgen. Für den Versand von Links sieht er eine gekürzte Adresse (recipientHint, zum Beispiel „an***@example.org“): die ersten Buchstaben und die Domain, damit du die Empfänger bestätigen kannst. get_profile zeigt deine eigene Anmeldung (Nutzer-ID, Kontoname, Anmelde-E-Mail) auch in diesem Modus: Das sind keine Daten deiner Mieter oder Bewerber.

Originaldateien (hochgeladene Dokumente, Fotos, Schreiben, Abrechnungen, Übergabeprotokolle, Verträge) lassen sich nicht pseudonymisieren. In diesem Modus gibt get_document_download_url deshalb keinen Download-Link heraus. Dein Agent liest Dokumente mit get_document_content: Text mit verborgenen Namen und Kontaktdaten, Bilder nur mit allowImages: true. Braucht eine Aufgabe wirklich die Datei selbst, ruft er get_document_download_url mit original: true auf. Jeder solche Abruf wird protokolliert, und der Dateiname im Link ist neutral („dokument-…“). Für Nachweise von Bewerbern gilt dasselbe mit get_applicant_document_download_url (Dateiname „unterlage-…“). Antworten von Bewerbern zeigt get_applicant_household in diesem Modus ohne Namen, Anschrift und Kontaktdaten. Den vollständigen Kontoexport kann dein Agent mit start_account_export (original: true) nach deiner ausdrücklichen Freigabe anfordern und die ZIP-Teile mit get_account_export_part über denselben Zugang herunterladen. Auch im Datensparmodus enthält dieser Export ungekürzte Originaldaten. Der Download im Web verlangt weiterhin die erneute Passworteingabe.

Regeln für Daten

Dateien hochladen

ZeroImmo prüft jede Datei am Inhalt, nicht am Namen. Was nicht passt, lehnt es mit einem deutschen Grund und einem nächsten Schritt ab; gespeichert wird dann nichts.

Zwei Wege, mit denselben Prüfungen und Ergebnissen:

Beispiel: create_upload_link, PUT, finalize_upload

{ "purpose": "invoice", "filename": "rechnung-scan.pdf", "sizeBytes": 8123456, "mimeType": "application/pdf" }

# dann, mit uploadUrl und headers aus der Antwort:
curl -X PUT -H "Content-Type: application/pdf" --data-binary @rechnung-scan.pdf "<uploadUrl>"

{ "uploadId": "<uploadId>", "purpose": "invoice" }

Cashflow und wirtschaftlicher Vermieterbericht

Die neuen Cashflow-Funktionen sind im Web unter Cashflow, Konten und Bankumsätze (Stand „Alle“) sowie per MCP/REST bedienbar. Keine eigene KI nötig: Klassifikationen, Aufteilungen und Auszugsabdeckung lassen sich manuell pflegen. Keine Automatisierungs-Vollmacht wird dadurch erweitert.

Mieteingang, Rückstände, Mahnwesen, Indexmiete und Briefe

ZeroImmo bucht die Miete jedes Vertrags täglich selbst (Sollstellung). Ob sie bezahlt ist, zeigt get_rent_income je Vertrag und Monat; im Web ist das die Seite Finanzen → Mieteingang.

Mahnwesen (Erinnerung, 1. und 2. Mahnung): im Web die Seite Bestand → Mahnwesen. ZeroImmo schlägt nur vor: Jedes Schreiben und jeden Versand bestätigst du; nichts wird automatisch erstellt oder versendet.

Für Mietverträge mit Indexmiete rechnet ZeroImmo die Anpassung aus dem Verbraucherpreisindex für Deutschland (Destatis-Tabelle 61111-0002, nur endgültige Werte; Quelle: Statistisches Bundesamt (Destatis)). Im Web: Bestand → Indexmieten und die Karte im Mietvertrag. Erstellt und versendet wird nur nach deinem OK; die neue Miete trägt ZeroImmo zum Wirksamkeitsdatum selbst ein.

Freie Briefe und Vorlagen: im Web Bestand → Briefversand → „Neuen Brief schreiben“ und „Vorlagen“. Ein freier Brief hat eigenen Betreff und Text, an die Mieter eines Mietverhältnisses oder an eine freie Anschrift in Deutschland (Handwerker, Hausverwaltung, Behörde, früherer Mieter).

Entwürfe (ADR-0138): Jedes Schreiben ist nach create_letter ein Entwurf, bis es versendet ist (E-Mail, Post über ZeroImmo, „Selbst versendet“). Erst dann zählt es (z. B. als Mahnstufe) und bleibt unverändert erhalten. Im Web: Briefversand → Entwurf öffnen, mit Vorschau, Textteilen und den Versandwegen.

Steuer (Anlage V)

ZeroImmo rechnet aus den Eingaben des Nutzers, berät aber nicht (keine Steuerberatung). Dein Agent trägt ein, was der Nutzer sagt, und entscheidet keine Steuerfrage: weder die Nutzung, noch den Schlüssel, die ortsübliche Miete oder die Totalüberschussprognose.

Kaufpreisaufteilung (Bereich Kauf): preview_purchase_price_split teilt einen Kaufpreis nach der Arbeitshilfe des Bundesfinanzministeriums auf Gebäude und Grund und Boden auf, mit denselben Zahlen wie die Original-Excel. Vorher liefert get_purchase_price_split_options die Grundstücksarten und das Bodenrichtwert-Portal je Bundesland, get_purchase_price_split_prefill die Werte einer Immobilie. Kaufpreis und Bodenrichtwert nennt immer der Nutzer; dein Agent schätzt sie nicht. save_purchase_price_split speichert die Berechnung, das PDF für das Finanzamt öffnet der Nutzer über pdfUrl in der Web-App. Das Ergebnis ist eine Berechnung, keine Steuerberatung; in die AfA übernimmt es der Nutzer selbst.

Restnutzungsdauer (Bereich Kauf): preview_remaining_useful_life schätzt nach dem Modell der ImmoWertV 2021 (Anlage 2), ob ein Gebäude eine kürzere Restnutzungsdauer als die gesetzliche haben kann, und zeigt den möglichen Steuereffekt. Die Antworten zu den Modernisierungen gibt der Nutzer; get_rnd_prefill liefert Baujahr, Art und AfA-Basis einer Immobilie. Das ist eine Indikation, kein Gutachten: Das Finanzamt erkennt eine kürzere Nutzungsdauer nur mit einem Gutachten an, und der Bundesrat hat zum Jahressteuergesetz 2026 eine Einschränkung vorgeschlagen. Eine kostenlose Ersteinschätzung durch den Partner gutachten.org fragt der Nutzer selbst in der Web-App an (Kauf → Restnutzungsdauer, mit Einwilligung); dort stehen auch Korrektur und Zurückziehen. list_rnd_requests zeigt seine Anfragen mit Kennung und Versandstatus. Die Angaben zum Gebäude (Baujahr, Modernisierungen, Kernsanierung) sind dieselben wie unter Vermögen.

Gebäudecheck (Bereich Kauf): Den Digitalen Gebäudecheck bucht und bezahlt der Nutzer in der Web-App (99 €) und lädt dort die Besichtigungsfotos je Bereich hoch. list_building_checks zeigt seine Checks mit Status, get_building_check_report liefert einen fertigen Zustandsbericht als Markdown mit festem Aufbau. Die Einstufungen stammen aus festen Prüfregeln, nicht von deinem Agenten; gib sie unverändert wieder. Ein Zustandsbericht aus Fotos, kein Gutachten.

Zahlungseingänge, die keine Miete sind

Nicht jeder Eingang ist Miete oder Kaution: ein öffentlicher Zuschuss (z. B. KfW), Guthabenzinsen aus einem Bausparvertrag, eine Versicherungsleistung, das Entgelt für eine Werbefläche oder eine Garage ohne Mietvertrag, oder ein Guthaben aus einer Abrechnung (Strom, Wasser). ZeroImmo bucht solche Eingänge direkt aus dem Kontoauszug, ohne Beleg (Quelle „Zahlungseingang (ohne Beleg)“).

Laufende Abbuchungen buchen

Viele Kosten haben keinen Beleg je Zahlung: Versicherungsbeiträge, Grundsteuer, Hausgeld, Abschläge für Strom und Wasser, Kontoführung. ZeroImmo bucht sie direkt aus der Abbuchung als Ausgabe (Quelle „Bankabbuchung (ohne Beleg)“). Danach zählen sie wie jede gebuchte Rechnung: in der Nebenkostenabrechnung, wenn umlegbar (nach Leistungszeitraum), und in der Steuerübersicht (am Tag der Zahlung).

Wichtig: Eine hochgeladene Datei (zum Beispiel ein CSV-Auszug oder eine Liste der Umsätze als Dokument) oder eine Notiz ist keine Buchung. Sag dem Nutzer nie, Kosten seien „zugeordnet“ oder „gebucht“, solange list_invoices sie nicht mit status: booked zeigt. Leg keine Zusammenfassungen von Kontoumsätzen als Dokument ab, um Kosten zu erfassen.

Regeln schlagen nur vor (ADR-0186): Modus auto gibt es nicht mehr und wird abgelehnt. Passende Abbuchungen zeigen die gespeicherte Aufteilung als Vorschlag; gebucht wird erst, wenn der Nutzer übernimmt (oder nach seiner Freigabe des genauen Laufs mit apply_booking_rules).

Vermietung (Board, Interessenten, Besichtigungen)

Unter „Vermietung“ steht jeder Interessent als Karte auf einem Board, von der Anfrage bis zum Mietvertrag: Anfrage, zur Besichtigung eingeladen, Besichtigung geplant, besichtigt, Selbstauskunft, engere Wahl, Mietvertrag, übergeben, abgesagt. Dein Agent führt das Board für dich.

Bewerber (Mieterselbstauskunft)

Interessenten füllen die Mieterselbstauskunft auf dem eigenen Handy aus (Fragen nach dem Muster der Datenschutzbehörden). Dein Agent kann fast alles, was du unter „Vermietung“ auf der Karte eines Interessenten kannst: einladen, Angaben und Nachweise lesen, annehmen und absagen, die Fragen anpassen. Löschen machst du im Web. Entscheiden tust du; dein Agent trägt deine Entscheidung ein.

Mietvertrag erstellen und unterschreiben lassen

Dein Agent erstellt den Mietvertrag aus deiner Vorlage und den Stammdaten, du unterschreibst als Vermieter elektronisch, und die Mieter unterschreiben per Link auf dem eigenen Handy. Der Workflow mietvertrag führt durch den Ablauf.

Schriftform (Indexmiete, Staffelmiete, Zeitmietvertrag, feste Laufzeit oder Kündigungsverzicht über ein Jahr, Leerstellen im Vertrag): Eine elektronische Unterschrift reicht dann nicht, auch nicht über den Agenten. Der Vertrag wird zweimal ausgedruckt und von allen eigenhändig unterschrieben; dein Agent lädt den Scan mit upload_signed_contract hoch (PDF, JPEG oder PNG, bis 3 MB als Base64, bis 50 MB über create_upload_link mit purpose document), nachdem du im Chat bestätigt hast, dass alle unterschrieben haben. Danach bekommst du eine Hinweis-Mail; eine falsche Datei ziehst du auf der Vertragsseite zurück.

Vorlagen: list_contract_templates zeigt deine eigenen Vorlagen und die geltende mit allen Abschnitten und Platzhaltern. save_contract_template legt die Vorlage des Kontos, einer Immobilie oder einer Einheit an oder ersetzt sie (immer mit der ganzen Abschnittsliste; Pflichtabschnitte bleiben an, die Bedingungen der Standardabschnitte bleiben fest), delete_contract_template entfernt sie, dann gilt wieder die nächstgrößere. URLs, Webadressen, E-Mail-Adressen und IBANs sind in Vorlagen und Vertragsangaben auch über den Agenten erlaubt. Inhalte bleiben Klartext; HTML und Skripte werden abgelehnt. In Vorlagen sind nur bekannte Platzhalter erlaubt. {{konto}} übernimmt weiterhin das Mietkonto aus den Vermieterdaten. Nach jeder Änderung einer Vorlage durch deinen Agenten bekommst du eine Hinweis-Mail, und das Ergebnis enthält die vorige Fassung (previous), mit der dein Agent die Änderung rückgängig macht. Erzeugte Verträge behalten ihren eingefrorenen Text. Die Standardvorlage ist ein Muster (Beta) und keine Rechtsberatung: Du prüfst deine Vorlage.

Unterschrift per Link (Mietvertrag, Übergabe)

Mieter unterschreiben Mietvertrag oder Übergabeprotokoll auf dem eigenen Handy. Dein Agent bereitet die Links vor, liest den Stand und verschickt die Links, wenn du im Chat zustimmst.

Schutz beim Versand durch den Agenten (Unterschrift und Selbstauskunft):

Übergabeprotokoll mit dem Agenten

Dein Agent nimmt das Übergabeprotokoll (Einzug, Auszug oder Begehung) mit dir vor Ort auf: Du gehst durch die Wohnung und sagst, was du siehst, er trägt es ein. Dann unterschreibst du als Vermieter mit deinem Namen, der Mieter vor Ort oder per Link, und ZeroImmo schließt das Protokoll ab und schickt es den Mietern. Der Prompt uebergabeprotokoll führt durch den Ablauf.

Heizkosten vom Messdienst

Rechnet ein Messdienst (ista, Techem, Brunata-Metrona, Minol, Kalo oder ein örtlicher Dienst) Heizung und Warmwasser ab, übernimmt ZeroImmo seine Beträge je Nutzer statt eines festen Betrags je Wohnung. Der Workflow heizkosten-messdienst beschreibt den Ablauf.

Dauerhafte Belegaufträge und Rückfragen

Community

Im ZeroImmo-Forum tauschen sich Vermieter aus. Dein Agent kann dort lesen und, wenn du es willst, für dich schreiben. Er handelt als du, unter deinem Nickname, nicht als dein Vermieterkonto.

Preise und Guthaben

ZeroImmo hat kein Abo. Alle eigenen Funktionen sind kostenlos: Verwaltung, Anlage V, Nebenkostenabrechnung, DATEV-Export, vollständiger Export, Hochladen, der Zugang über MCP und REST und das Verbinden und Lesen eines E-Mail-Postfachs (Outlook, Gmail). Kostenpflichtig sind nur optionale Zusatzleistungen; sie werden aus dem vorausbezahlten Guthaben des Kontos abgebucht. Alle Preise sind Endpreise inklusive 19 % USt.

Grenzen

Workflows

Funktionen

Einstieg und Anleitung

  • get_started Loslegen · lesen · liest · Werkzeug

    Call first after connecting or when the account appears empty.

  • get_guide Anleitung · lesen · liest · Werkzeug

    Agent guide, one section per call.

  • get_profile Verbundenes Konto · lesen · liest · Werkzeug

    Returns which ZeroImmo account this connection acts for: id (stable for this user in this account, unchanged after a reconnection, a token refresh or changed…

Externe Importquellen

  • save_connector_source Externe Importquelle beschreiben und steuern · schreiben · ändert oder entfernt

    Legt eine kundeneigene Mail-, Datei-, Kalender- oder sonstige Importquelle an oder pausiert sie.

  • list_connector_sources Importquellen und Fortschritt finden · lesen · liest

    Listet konfigurierte externe Quellen und ihren bestätigten Fortschritt mit nextOffset.

  • get_connector_source Importquelle und Herkunftsverlauf prüfen · lesen · liest

    Liest Importquelle, revisionsgeschützten Cursor und paginierten Verlauf der tatsächlich verknüpften Fachdatensätze. nextOffset fortsetzen.

  • commit_connector_batch Importübergabe und Fortschritt atomar bestätigen · schreiben · ändert oder entfernt

    Bestätigt höchstens 50 externe Versionen mit Inhaltsfingerabdruck und vorhandenen kanonischen Dokument-/Rechnungs-/Vorgangs-IDs.

Wartung und Folgevorgänge

  • save_maintenance_schedule Wartungsregel anlegen oder bearbeiten · schreiben · ändert oder entfernt

    Speichert eine belegte wiederkehrende Wartung mit Objekt, optionaler Einheit/Kontakt/Originalbeleg, nächstem Termin und Monatsabstand. expectedRevision=null …

  • list_maintenance_schedules Wartungsregeln finden · lesen · liest

    Listet wiederkehrende Wartungen mit nächstem Termin, Pause und Bearbeitungsrevision. nextOffset fortsetzen.

  • get_maintenance_schedule Wartungsregel und erzeugte Vorgänge lesen · lesen · liest

    Liest eine Wartungsregel und ihren vollständigen paginierten Termin-/Vorgangsverlauf. nextOffset fortsetzen.

  • generate_maintenance_due Fällige Wartungsvorgänge vorbereiten · schreiben · ändert oder entfernt

    Bereitet fällige Wartungstermine bis through als Vorgänge mit gemeinsamen Aufgaben vor: pro Aufruf höchstens 100 Vorgänge und 24 künftige Termine je Regel; b…

  • create_case_successor Verknüpften Folgevorgang ausdrücklich anlegen · schreiben · ändert oder entfernt

    Übernimmt den validierten Kontext (Objekte, Einheiten, Mietverträge, Kontakte mit Rollen, Belege) in einen ausdrücklich gewünschten Folgevorgang.

Vorgänge und eigene Vorlagen

  • list_cases Vorgänge suchen · lesen · liest

    Findet Vorgänge mit Status, Startdatum, Objekt- und Kontaktfiltern. nextOffset vollständig fortsetzen.

  • get_case Vorgang, nächste Schritte und Nachweise lesen · lesen · liest

    Lädt Vorgangsangaben und eine vollständige Seite des gewählten Abschnitts (steps, refs, attachments, history oder relations). nextOffset bei demselben Abschn…

  • create_case Eigenen Vorgang oder Vorgang aus Vorlage anlegen · schreiben · ändert oder entfernt

    Legt einen Vorgang mit eigenem Startdatum, mehreren Kontakten, Objektbezügen, vorhandenen Dokumenten und eigenen Aufgaben an.

  • update_case Vorgangsangaben und Verknüpfungen bearbeiten · schreiben · ändert oder entfernt

    Ändert Titel, Beschreibung, Start und Termin sowie die vollständige Liste der gewünschten Kontextbezüge. expectedRevision vorher mit get_case lesen.

  • save_case_step Eigenen Vorgangsschritt anlegen oder bearbeiten · schreiben · ändert oder entfernt

    Verwendet eine kanonische Aufgabe für jeden Schritt.

  • set_case_step_status Vorgangsschritt mit tatsächlichem Ergebnis aktualisieren · schreiben · ändert oder entfernt

    Erledigt, öffnet oder überspringt einen Schritt mit Grund und optionalem kanonischem Fachbeleg.

  • transition_case Vorgang warten lassen, fortsetzen oder abschließen · schreiben · ändert oder entfernt

    Erlaubt: offen → wartend/abgeschlossen/abgebrochen; wartend → offen/wartend (neuer Prüftermin)/abgeschlossen/abgebrochen; abgeschlossen oder abgebrochen → nu…

  • reorder_case_steps Schritte gemeinsam umordnen · schreiben · ändert oder entfernt

    Ordnet sämtliche vorhandenen Schritte genau einmal um und erhält deren Abhängigkeiten.

  • save_case_template Eigene Vorgangsvorlage versionieren · schreiben · ändert oder entfernt

    Speichert eine kontoeigene Vorlage als unveränderliche neue Version.

  • list_case_templates Eigene Vorlagen und Beispiele finden · lesen · liest

    Listet aktuelle kontoeigene Vorlagen mit Versions-ID und Schrittzahl sowie ausdrücklich unverbindliche Beispielabläufe.

  • get_case_template Unveränderliche Vorgangsvorlage vollständig lesen · lesen · liest

    Liest die gewählte kontoeigene Vorlagenversion samt seitenweisen Originalschritten. nextOffset fortsetzen; spätere Vorlagenänderungen verändern diese Version…

  • store_case_report Vorgangsbericht mit Quellenverzeichnis ablegen · schreiben · legt an

    Erfasst den Vorgang und den vollständigen begrenzten Verlauf in einer konsistenten Datenbankansicht und legt PDF plus CSV desselben Stands ab.

  • list_context_candidates Vorhandene Fachdatensätze zum Verknüpfen suchen · lesen · liest

    Sucht Objekte, Einheiten, Mietverträge, Kontakte, Dokumente, Rechnungen, Kautionen, Darlehen, Übergaben oder Abrechnungen innerhalb des Kontos. nextOffset fo…

  • list_tasks_page Aufgaben vollständig und nach Vorgang suchen · lesen · liest

    Listet Aufgaben aller unterstützten Status mit Suche, Terminfilter, Vorgangsbezug, vollständiger Trefferzahl und nextOffset.

Automatisierung und Rückfragen

  • get_automation_status Automatisierungsstatus · lesen · liest

    Zeigt Bindung und versionierte Vollmacht dieses Zugangs, unterstützte Belegautomatisierung und letzten Tagesabgleich.

  • get_invoice_review_state Rechnungswarnungen und genaue Prüffreigabe lesen · lesen · liest

    Liest aktuelle Auslesefehler, verbleibende Warnungen, Rechnungsrevision, Warnungsfingerabdruck und vorhandene Freigaben.

  • approve_invoice_warnings Genau geprüften Rechnungssonderfall freigeben · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Dokumentiert die ausdrückliche Prüfung einer konkreten verbleibenden Warnung durch den Kontoinhaber.

  • request_receipt_reprocessing Vorhandene Rechnung ausdrücklich erneut bearbeiten lassen · schreiben · ändert oder entfernt

    Erzeugt eine dauerhafte Neubearbeitungsabsicht für eine vorhandene ungebuchte Rechnung unter einer bestehenden aktiven Belegvollmacht.

  • list_automation_jobs Arbeitsaufträge auflisten · lesen · liest

    Listet dauerhafte Belegaufträge mit Verarbeitungsstand, Rechnungsrevision, Versuchen und Ausführungsfrist. nextCursor als after für die nächste Seite übergeben.

  • get_automation_job Arbeitsauftrag prüfen · lesen · liest

    Liest Auftrag, gespeicherte Schritte, Ergebnisse, Rückfragen und Benachrichtigungen.

  • claim_automation_job Arbeitsauftrag übernehmen · schreiben · ändert oder entfernt

    Übernimmt atomar einen fälligen Belegauftrag für diesen Zugang und seine Ausführung; ohne Arbeit kommt null zurück. policyVersion, id, leaseGeneration und so…

  • renew_automation_lease Ausführungserlaubnis verlängern · schreiben · ändert oder entfernt

    Verlängert nur eine noch gültige Ausführung nach erneuter Prüfung von Zugang, Mitgliedschaft, Vollmachtsversion und Laufzeitbindung.

  • finish_automation_job Arbeitsauftrag abschließen · schreiben · ändert oder entfernt

    Beantragt completed, retry, reconciling oder failed für die aktuelle Ausführung.

  • request_automation_input Rückfrage speichern · schreiben · versendet an Dritte

    Speichert eine Rückfrage zum aktuellen Auftrag und Bearbeitungsstand, gibt die Ausführung frei und wartet. questionKey verhindert doppelte Fragen.

  • answer_automation_question Rückfrage beantworten · schreiben · ändert oder entfernt

    Speichert die Antwort des Owners auf eine Rückfrage mit genau ihrer Revision über eine andere berechtigte Sitzung.

  • resume_automation_job Arbeitsauftrag fortsetzen · schreiben · ändert oder entfernt

    Setzt einen Auftrag nach berechtigter Antwort fort und prüft Rechnung sowie Vollmacht erneut.

  • create_automation_policy Automatisierungsauftrag entwerfen · schreiben · legt an

    Entwirft eine inaktive Belegvollmacht für einen separaten Owner-Zugang und seine Ausführung, begrenzt durch bestehende Rechte und Laufzeit.

  • revise_automation_policy Automatisierungsauftrag ändern · schreiben · ändert oder entfernt

    Erstellt eine neue unveränderliche Vollmachtsversion und pausiert den Auftrag.

  • list_automation_policies Automatisierungsaufträge prüfen · lesen · liest

    Listet Automatisierungsvollmachten des Kontos mit Bindung, Version und Status.

  • set_automation_policy_status Automatisierungsauftrag aktivieren oder stoppen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Aktiviert, pausiert oder widerruft die konkrete Belegvollmachtsversion nach separater Owner-Freigabe.

  • pause_automation_policy Automatisierungsauftrag sofort pausieren · schreiben · ändert oder entfernt

    Pausiert eine Owner-Vollmacht sofort über eine andere berechtigte Sitzung.

  • cancel_automation_job Arbeitsauftrag abbrechen · schreiben · ändert oder entfernt

    Der Owner bricht unerledigte Belegarbeit ab, ohne Buchungsnachweise zu löschen.

  • reconcile_automation_job Angehaltenen Auftrag klären · schreiben · ändert oder entfernt

    Der Owner klärt einen angehaltenen Belegauftrag nach Prüfung gespeicherter Wirkungen.

  • reconcile_automation_notification Unklaren Mailausgang klären · schreiben · ändert oder entfernt

    Der Owner klärt einen ungewissen Rückfrage-Mailversand anhand tatsächlicher Anbieternachweise. accepted vermerkt Annahme; not_sent erlaubt einen bewussten ne…

Bestand

  • get_overview Überblick · lesen · liest · Werkzeug

    Overview: properties with unit counts, this month's rent (target; paid = by payment + by credit, no cash; received), inbox counts, leases in arrears (bank-pr…

  • list_properties Immobilien · lesen · liest · Werkzeug

    All properties with address, type, unit count and units let today.

  • find_properties Immobilien filtern · lesen · liest

    The properties like list_properties (unitCount, dwellingCount = flats and commercial, letCount, vacantCount = the real vacancy, ownUseCount, houseId, soldOn)…

  • get_property Immobilie · lesen · liest · Werkzeug

    One property with its units (areas, lettable, let today, usageToday).

  • list_units Einheiten · lesen · liest · Werkzeug

    All lettable units of all properties (id, label, property).

  • get_unit_area_history Flächenhistorie · lesen · liest

    Versioned living/usable/heated areas of a unit.

  • create_property Immobilie anlegen · schreiben · legt an · Werkzeug

    Creates a property: the first step on an empty account.

  • update_property Immobilie ändern · schreiben · ändert oder entfernt

    Updates name, address and details of a property, and the month its operating-cost settlement period starts (settlementPeriodStartMonth).

  • create_unit Einheit anlegen · schreiben · legt an · Werkzeug

    Adds a unit (flat, shop, garage, …) to a property, with its living or usable area in m² (a number or German text like "74,5") valid from areasValidFrom; room…

  • change_unit_area Fläche ändern · schreiben · ändert oder entfernt

    New area version of a unit from a date (history stays).

  • update_unit Einheit ändern · schreiben · ändert oder entfernt

    Updates a unit's master data: label, type, floor/location, rooms, what is let with it.

  • set_unit_facts Einheit ergänzen · schreiben · ändert oder entfernt

    Changes only the given details of a unit (floor, rooms, what is let with it; null clears a detail, "" too for text) and keeps everything else, unlike update_…

  • restore_unit Einheit wiederherstellen · schreiben · ändert oder entfernt

    Brings an archived unit back into lists and the lease wizard.

  • archive_property Immobilie archivieren · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Archives a property: it leaves the lists, its history stays.

  • get_property_sale Verkauf einer Immobilie: Stand und Vorschau · lesen · liest

    Before a sale: the tenancies that run today with the deposit held and the open Hausgeld plans, i.e. what record_property_sale would touch.

  • record_property_sale Verkauf einer Immobilie eintragen · schreiben · ändert oder entfernt

    Records that a property was sold (not a broker request). soldOn = day of the transfer of ownership, not in the future.

  • undo_property_sale Verkauf zurücknehmen · schreiben · ändert oder entfernt

    Takes a recorded sale back: the tenancies that passed to the buyer run again (a fixed-term lease needs its agreed end entered again), deposits handed to the …

  • restore_property Immobilie wiederherstellen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Brings an archived property (archive_property) back into the lists, with its units as they were; units archived on their own stay archived (restore_unit).

  • archive_unit Einheit archivieren · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Archives a unit that is no longer let (e.g. merged or converted): it leaves lists and the lease wizard, its history stays.

  • get_landlord_data Vermieterdaten · lesen · liest

    The landlords of the account (Vermieterdaten: a private person, a GbR, a GmbH …) with name, address, reply e-mail address, phone, Steuernummer and rent accou…

  • save_landlord_data Vermieterdaten speichern · schreiben · ändert oder entfernt

    Creates a landlord (without ownerEntityId; kind natural_person needs lastName, gbr/gmbh/other need companyName) or changes one (ownerEntityId from get_landlo…

  • assign_property_owner Vermieter einer Immobilie zuordnen · schreiben · ändert oder entfernt

    Sets which landlord lets a property (propertyId from list_properties, ownerEntityId from get_landlord_data): its contracts, letters and link mails then use t…

Personen

  • search_persons Personen suchen · lesen · liest · Werkzeug

    Tenants, co-tenants and other contacts; empty query lists the most recent.

  • get_person Person · lesen · liest

    One person with contact data and leases. plannedAddress: an address change noted for a later day (validFrom; from a lease: leaseId), null when none. formerAd…

  • reveal_personal_data Kontaktdaten einer Person · lesen · liest · Werkzeug

    Returns the real name, e-mail, phone, address and IBANs of one person.

  • create_person Person anlegen · schreiben · legt an · Werkzeug

    Creates a tenant or contact: a natural person (lastName required) or a company (kind "legal" with companyName).

  • update_person Person ändern · schreiben · ändert oder entfernt

    Updates a person's name and contact data.

  • cancel_person_address_change Vorgemerkten Anschriftswechsel zurücknehmen · schreiben · ändert oder entfernt

    Takes back the address change noted for a later day (get_person: plannedAddress), e.g. the move into the rented unit at the start of a lease.

  • erase_person Person löschen oder anonymisieren · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    DSGVO Art. 17: erases a person's data.

Mietverträge

  • list_leases Mietverträge · lesen · liest · Werkzeug

    All leases with unit, property, tenants, status, dates and monthly total (cents).

  • get_lease Mietvertrag · lesen · liest · Werkzeug

    Lease details: parties, rent components with history, occupancy (persons), allocation agreements and deposit.

  • create_lease Mietvertrag anlegen · schreiben · legt an · Werkzeug

    Lease for a unit (unitId from list_units): startDate, endDate if fixed or ended, one main_tenant (personId), rent in cents (base_rent required), optional dep…

  • activate_lease Entwurf wirksam machen · schreiben · ändert oder entfernt

    Makes a draft lease (create_lease with draft: true) effective when its contract was signed outside ZeroImmo: rent is posted from the start, the deposit becom…

  • move_tenants_to_unit_address Anschrift der Mieter auf die Mietwohnung ändern · schreiben · ändert oder entfernt

    After create_lease or for a running lease, when the user confirmed the day: from validFrom (usually the start of the lease) the address of the main tenant an…

  • discard_draft_lease Entwurf verwerfen · schreiben · ändert oder entfernt

    Throws away a draft lease whose contract will not be signed: it leaves all lists, the unit is free again, an unsigned contract and its signing links end.

  • update_lease_data Vertragsdaten ändern · schreiben · ändert oder entfernt

    Corrects a lease's contract number, payment reference, due day (n-th business day, applies to charges not yet posted) and notes.

  • add_lease_party Vertragspartei nachtragen · schreiben · legt an

    Adds an existing person to a lease from a date: co_tenant (Mitmieter), resident (Bewohner), guarantor (Bürge) or contact.

  • end_lease_party Vertragspartei austragen · schreiben · ändert oder entfernt

    Takes a party (not the main tenant) off a lease after its last day, e.g. a co-tenant who moved out. partyId comes from get_lease.

  • change_occupancy Personen im Haushalt ändern · schreiben · ändert oder entfernt

    Sets the number of persons in the household from a date (operating costs by persons use it).

  • change_rent Miete ändern · schreiben · ändert oder entfernt

    New version of a rent component (base rent, prepayment, …) from a date, with a reason.

  • check_rent_increase Mieterhöhung prüfen · lesen · liest

    Checks a rent increase to the local comparative rent (§ 558 BGB) for a request sent today (receipt assumed after three days of post): the base rent unchanged…

  • accept_rent_increase Zustimmung zur Mieterhöhung eintragen · schreiben · ändert oder entfernt

    The tenants consented to a rent increase request (the letter must be recorded as sent): enters the new base rent from the date in the letter.

  • end_lease Mietvertrag beenden · schreiben · ändert oder entfernt

    Records a notice (noticeBy tenant/landlord) or a termination agreement (mutual) and the last day of the tenancy (endDate, inclusive); also changes an existin…

  • withdraw_lease_termination Kündigung zurücknehmen · schreiben · ändert oder entfernt

    The notice was withdrawn: an open-ended lease runs on without end date and rent is charged again.

  • change_lease_start Mietbeginn ändern · schreiben · ändert oder entfernt

    Corrects the first day of a lease (also back-dated).

  • cancel_lease Mietvertrag stornieren · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Cancels a wrongly created lease: it leaves all lists and figures, automatically posted rent is credited, the unit is free again, open tasks are dismissed.

Vermietung (Board, Interessenten, Besichtigungen)

  • list_letting_board Vermietung: Board · lesen · liest

    The letting board: every prospect card of the account (or of one unit), with its column (stage): inquiry (Anfrage), viewing_invited (Zur Besichtigung eingela…

  • get_letting_prospect Vermietung: Interessent · lesen · liest

    One prospect card in full: contact data, note, column, household summary and every viewing (Berlin date and time, duration, status planned/done/cancelled/no_…

  • add_letting_prospect Vermietung: Interessent anlegen · schreiben · legt an

    Puts a prospect on the letting board for a unit (unitId from list_letting_board or list_units): at least one of name, e-mail address or phone number; source …

  • update_letting_prospect Vermietung: Interessent ändern · schreiben · ändert oder entfernt

    Changes a card's name, e-mail address, phone number, source or note; null clears a field (at least one of name, e-mail and phone stays).

  • move_letting_prospect Vermietung: Karte verschieben · schreiben · ändert oder entfernt

    Moves a card to a column: inquiry (Anfrage), viewing_invited (Zur Besichtigung eingeladen), viewing_booked (Besichtigung geplant), viewed (Besichtigt), self_…

  • delete_letting_prospect Vermietung: Interessent löschen · schreiben · ändert oder entfernt

    Deletes a card without household with its viewings, at once and for good.

  • schedule_letting_viewing Vermietung: Besichtigung eintragen · schreiben · legt an

    Enters a viewing for a prospect card (Berlin date and time, duration in minutes, default 30, a note such as the meeting point).

  • update_letting_viewing Vermietung: Besichtigung ändern · schreiben · ändert oder entfernt

    Moves a viewing (date, time, duration), changes its note, or sets its status: planned, done, cancelled, no_show. done moves an early card to viewed.

  • delete_letting_viewing Vermietung: Besichtigung löschen · schreiben · ändert oder entfernt

    Deletes a viewing entered by mistake (a cancelled one: status cancelled instead).

  • list_viewing_times Vermietung: Besichtigungszeiten · lesen · liest

    The viewing times from today on (or of one unit): Berlin date, from–to, minutes per slot, persons per slot, the note for prospects, and every slot with the c…

  • add_viewing_times Vermietung: Besichtigungszeiten anlegen · schreiben · legt an

    Adds viewing times for a unit (Berlin time, at most twelve hours a day, not overlapping other times of the unit), cut into slots of slotMinutes (default 20):…

  • delete_viewing_times Vermietung: Besichtigungszeiten löschen · schreiben · ändert oder entfernt

    Deletes viewing times; refused while a planned viewing is booked in them (cancel those first with update_letting_viewing, status cancelled).

  • prepare_viewing_invitation Vermietung: Buchungslink erstellen · schreiben · legt an

    Makes a booking link for a prospect card (before the self-disclosure; the unit needs free viewing times) and returns it with a short German message the landl…

  • send_viewing_invitation Vermietung: Buchungslink per E-Mail senden · schreiben · versendet an Dritte

    Mails a new booking link to the prospect card's e-mail address through ZeroImmo (a designed mail with the button "Termin wählen"; replies go to the landlord'…

  • send_viewing_invitation_sms Vermietung: Buchungslink per SMS senden · schreiben · versendet an Dritte

    Sends a new booking link by SMS through ZeroImmo to the prospect card's mobile number and pays it from the account's credit (0,19 € per SMS part; the text fi…

  • send_letting_rejection Vermietung: absagen und Absage mailen · schreiben · versendet an Dritte

    Declines a card without household (column rejected: planned viewings cancelled, booking link revoked, deleted after six months) and mails the prospect a poli…

  • get_credit_balance Guthaben: Stand · lesen · liest

    The account's prepaid credit for extra services with third-party costs (first: SMS at 0,19 € per SMS part of 160 characters, incl. 19 % VAT) and the latest b…

  • get_ai_usage KI-Verbrauch dieses Monats lesen · lesen · liest

    Zeigt, was die eingebaute ZeroImmo-KI und die Kartendienste (Mapbox) in diesem Kalendermonat gekostet haben: cents (genau, inkl. USt), calls, je Zweck (byPur…

  • get_ai_settings KI-Einstellungen lesen · lesen · liest

    Liest die KI-Einstellungen des Kontos: mode "off" (keine KI- und Kartendienst-Aufrufe, auch keine Streckenberechnung) oder "on_click" (nur wenn der Nutzer si…

  • update_ai_settings KI-Einstellungen ändern · schreiben · ändert oder entfernt

    Ändert Modus und/oder Monatsbudget der eingebauten KI und der Kartendienste: mode "off" schaltet sofort alle bezahlten Aufrufe ab (Web und MCP), "on_click" e…

Bewerber (Mieterselbstauskunft)

  • prepare_applicant_invitation Selbstauskunft: Einladung vorbereiten · schreiben · legt an

    Prepares the tenant self-disclosure for a prospect who said they want to rent a unit (stage B): a household with its main applicant and a link that is NOT se…

  • update_applicant_contact Bewerber: Name, E-Mail, Handy korrigieren · schreiben · ändert oder entfernt

    Corrects or completes the name, e-mail address and mobile number (one of the two is needed) of an invited person (main or co-applicant) before they submitted…

  • send_applicant_invitation Selbstauskunft: Einladung versenden · schreiben · versendet an Dritte

    Mails a prepared self-disclosure link to the applicant (applicantId from prepare_applicant_invitation or list_applicants) through ZeroImmo.

  • request_applicant_documents Selbstauskunft: Unterlagen anfordern · schreiben · versendet an Dritte

    Asks every applicant of a household for the documents (stage C: proof of income, or the public body's; an own tenancy credit report only if the applicant wan…

  • list_applicants Selbstauskunft: Bewerber einer Einheit · lesen · liest

    Households applying for a unit, newest first: status (offen, engere Wahl, abgesagt, angenommen, zurückgezogen), each applicant's id, name and e-mail address …

  • get_applicant_household Selbstauskunft: Haushalt mit allen Angaben · lesen · liest

    One applicant household in full (applicationId from list_applicants): status, the invitation (warm rent, move-in, WBS and pets asked), every applicant with r…

  • get_applicant_document_download_url Selbstauskunft: Nachweis herunterladen · lesen · liest

    Short-lived (60 s) download URL of a proof an applicant uploaded (income proof, WBS, own tenancy credit report, the public body's confirmation; documentId fr…

  • accept_applicant_household Selbstauskunft: Haushalt annehmen · schreiben · ändert oder entfernt

    Enters the landlord's decision to let the unit to this household (applicationId from list_applicants; status offen or engere Wahl, every applicant submitted …

  • reject_applicant_household Selbstauskunft: Haushalt absagen · schreiben · ändert oder entfernt

    Enters the landlord's decision against this household (applicationId from list_applicants; status offen or engere Wahl): the status becomes abgesagt, open li…

  • link_lease_to_applicant_household Selbstauskunft: Mietvertrag zuordnen · schreiben · ändert oder entfernt

    Links the lease made for an accepted household (leaseId from create_lease, same unit) to the household, as the web's lease wizard does: the household's answe…

  • get_applicant_rejection Selbstauskunft: Absagetext · lesen · liest

    For a rejected household (reject_applicant_household or the web UI): recipients, subject and a neutral text without reasons (AGG).

  • set_applicant_retention_hold Selbstauskunft: Aufbewahrung über die Löschfrist · schreiben · ändert oder entfernt

    Keeps a household (applicationId from list_applicants; not an accepted one) past its automatic deletion until a date, for a concrete dispute: a complaint or …

  • clear_applicant_retention_hold Selbstauskunft: Aufbewahrung beenden · schreiben · ändert oder entfernt

    Ends the retention hold of a household (applicationId from list_applicants) once the dispute is over: the normal deletion rules apply again at once, so a hou…

  • get_self_disclosure_questions Selbstauskunft: Fragen des Kontos · lesen · liest

    The questions the account's self-disclosure asks applicants (ADR-0066): the fixed minimal set, each standard question of the data protection authorities' sam…

  • set_self_disclosure_standard_questions Selbstauskunft: Standardfragen an- und abschalten · schreiben · ändert oder entfernt

    Switches standard questions of the self-disclosure (the data protection authorities' sample) off (skip) or back on (ask), by key from get_self_disclosure_que…

  • add_self_disclosure_question Selbstauskunft: Eigene Frage hinzufügen · schreiben · ändert oder entfernt

    Adds one of the landlord's own questions to the self-disclosure (at most 10): stage b (self-disclosure) or c (documents), type yes_no, text (answer up to 500…

  • update_self_disclosure_question Selbstauskunft: Eigene Frage ändern · schreiben · ändert oder entfernt

    Changes one of the landlord's own questions (questionId from get_self_disclosure_questions): any of stage, type, label, help (empty text removes it), options…

  • delete_self_disclosure_question Selbstauskunft: Eigene Frage löschen · schreiben · ändert oder entfernt

    Deletes one of the landlord's own questions (questionId from get_self_disclosure_questions).

Verträge: Mietvertrag erstellen, unterschreiben und Vorlagen; Vertragszentrum (Versicherungen, Wartung, Dienstleister mit Kündigungstermin)

  • list_contracts Verträge (Versicherungen, Wartung, Dienstleister) · lesen · liest

    The landlord's recurring contracts of the Vertragszentrum (insurances, maintenance, caretaker, cleaning, garden, winter service, common electricity, cable, s…

  • get_contract Vertrag ansehen · lesen · liest

    One contract of the Vertragszentrum (list_contracts): all fields, the next notice date, the document, the payments of the year (the partner's expenses by inv…

  • save_contract Vertrag anlegen oder ändern · schreiben · ändert oder entfernt

    Creates a contract (without contractId) or changes one (all fields are written; read get_contract first).

  • cancel_contract Vertrag gekündigt zum · schreiben · ändert oder entfernt

    Records that the contract was cancelled to cancelledTo (the day it ends): its notice deadline closes and the contract shows 'endet am'; after that day the da…

  • archive_contract Vertrag ablegen · schreiben · ändert oder entfernt

    Files a contract that has ended (status archived): it leaves the running list and its open deadlines close.

  • get_contract_setup Mietvertrag: was gebraucht wird · lesen · liest

    Before creating the lease contract document of a lease: which template applies (unit, property, account or the ZeroImmo standard), what the contract takes fr…

  • preview_lease_contract Mietvertrag: Vorschau · lesen · liest

    Without contractId: renders the contract text from the applicable template, the master data and the answers, with missing placeholders, problems that block g…

  • generate_lease_contract Mietvertrag erzeugen · schreiben · ändert oder entfernt

    Generates the lease contract document of a lease like the web app does: the text from the applicable template, the master data and the landlord's answers is …

  • sign_lease_contract_as_landlord Mietvertrag als Vermieter unterschreiben · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Applies the landlord's simple electronic signature to a generated lease contract without written form: the landlord's name (from the Vermieterdaten as printe…

  • upload_signed_contract Unterschriebenen Mietvertrag hochladen · schreiben · ändert oder entfernt

    Stores the scan or photo of a generated lease contract that every party signed in ink (PDF, JPEG or PNG; base64 up to 3 MB, up to 50 MB with create_upload_li…

  • list_contract_templates Mietvertragsvorlagen · lesen · liest

    The landlord's own lease contract templates (for the account, a property or a unit; the most specific applies, else the ZeroImmo standard, a sample to adapt …

  • save_contract_template Mietvertragsvorlage speichern · schreiben · ändert oder entfernt

    Creates or replaces the landlord's lease contract template of one scope (without propertyId and unitId: the account's; with propertyId: that property's; with…

  • delete_contract_template Mietvertragsvorlage entfernen · schreiben · ändert oder entfernt

    Removes the landlord's own lease contract template of one scope (without propertyId and unitId: the account's); the next broader one applies again (unit → pr…

Unterschrift per Link (Mietvertrag, Übergabe)

  • prepare_signature_request Unterschrift per Link vorbereiten · schreiben · legt an

    Prepares the signing links for the tenants of a lease contract or a handover protocol.

  • send_signature_request Unterschrift per Link versenden · schreiben · versendet an Dritte

    Sends prepared signing links of a lease contract or a handover protocol to tenants by e-mail.

  • resend_signature_request Unterschriftslink erneut senden · schreiben · versendet an Dritte

    Resends one contract or handover signing request with a new link; the old link stops working only after successful delivery.

  • get_signature_status Unterschriften per Link: Stand · lesen · liest

    The lease's contracts and handover protocols with their signing requests per tenant: prepared (not sent yet), pending (sent, link open), done, declined (with…

  • revoke_signature_request Unterschrifts-Link zurückziehen · schreiben · ändert oder entfernt

    Revokes a signing link of a lease contract or handover protocol that is prepared or sent and not yet signed or declined (requestId from get_signature_status)…

Übergabeprotokoll (Einzug, Auszug, Begehung)

  • list_handover_protocols Übergabeprotokolle eines Mietvertrags · lesen · liest

    The handover protocols (Übergabeprotokolle) of a lease, newest first: protocolId, kind (move_in Einzug, move_out Auszug, inspection Begehung), day, status (d…

  • get_handover_protocol Übergabeprotokoll lesen · lesen · liest

    Everything in one handover protocol: general data (landlord name, attendees, remarks, tenant absent), the tenants of the lease on that day (hasEmail and reci…

  • start_handover_protocol Übergabeprotokoll starten · schreiben · legt an

    Starts a handover protocol (Übergabeprotokoll) for a lease as a draft: move_in (Einzug), move_out (Auszug: takes over the rooms and elements of the unit's la…

  • update_handover_general Übergabeprotokoll: Allgemeines · schreiben · ändert oder entfernt

    Changes the general data of a draft protocol that nobody signed yet: day (heldOn), landlord name (the name the landlord signs with; one line, no link), atten…

  • upsert_handover_room Übergabeprotokoll: Raum anlegen oder ändern · schreiben · ändert oder entfernt

    Adds a room to a draft protocol nobody signed yet (without roomId; name required) or renames it and sets its remark (with roomId; only what you pass changes,…

  • delete_handover_room Übergabeprotokoll: Raum entfernen · schreiben · ändert oder entfernt

    Removes a room with its elements and photos from a draft protocol nobody signed yet (e.g. a default room the flat does not have).

  • upsert_handover_item Übergabeprotokoll: Bereich erfassen · schreiben · ändert oder entfernt

    Records an element of a room (Bereich, e.g. Boden, Fenster, Heizkörper) in a draft protocol nobody signed yet: with itemId it changes it, without itemId it a…

  • delete_handover_item Übergabeprotokoll: Bereich entfernen · schreiben · ändert oder entfernt

    Removes an element (Bereich) with its photos from a room of a draft protocol nobody signed yet.

  • add_handover_photo Übergabeprotokoll: Foto hinzufügen · schreiben · legt an

    Adds a photo to a draft protocol nobody signed yet: to an element (itemId), a room (roomId) or the protocol as a whole, with an optional caption; or, with me…

  • delete_handover_photo Übergabeprotokoll: Foto entfernen · schreiben · ändert oder entfernt

    Removes a photo (photoId from get_handover_protocol) from a draft protocol nobody signed yet.

  • record_handover_meter Übergabeprotokoll: Zählerstand erfassen · schreiben · ändert oder entfernt

    Records a meter reading in a handover protocol.

  • delete_handover_meter_entry Übergabeprotokoll: Zählereintrag entfernen · schreiben · ändert oder entfernt

    Removes a meter entry (with its photo link) from a draft protocol nobody signed yet.

  • upsert_handover_keys Übergabeprotokoll: Schlüssel erfassen · schreiben · ändert oder entfernt

    Records the keys handed over in a draft protocol nobody signed yet: per key type (e.g. Haustür, Wohnungstür, Briefkasten, Keller, Garage) the count and optio…

  • delete_handover_draft Übergabeprotokoll-Entwurf löschen · schreiben · ändert oder entfernt

    Deletes a draft protocol that nobody signed (e.g. started by mistake or twice).

  • sign_handover_protocol_as_landlord Übergabeprotokoll als Vermieter unterschreiben · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Signs a draft handover protocol as the landlord with his name: a simple electronic signature (einfache elektronische Signatur) without a drawn image, for exa…

  • reset_handover_signatures Unterschriften des Übergabeprotokolls zurücksetzen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Removes every signature (landlord, tenants, witnesses; on site, by link or with the name) of a draft protocol so its content can be changed again; everyone s…

  • finalize_handover_protocol Übergabeprotokoll abschließen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Finalizes a signed handover protocol: confirms the meter readings that were booked as provisional when entered and books any that have a value and an assigne…

  • send_handover_protocol Übergabeprotokoll an die Mieter senden · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · versendet an Dritte

    Mails the final protocol's archived PDF, unchanged, to the stored e-mail addresses of the lease's tenants on the handover day (tenants in get_handover_protoc…

Miete, Mieteingang, Kaution und offene Posten

  • get_lease_ledger Mieterkonto · lesen · liest

    Rent ledger of a lease: charges, payments, credits, reversals, open items and balance.

  • get_arrears Rückstände · lesen · liest · Werkzeug

    Past-due rent per lease (cents): overdueCents bank-proven; unverifiedCents not arrears.

  • get_rent_income Mieteingang · lesen · liest

    Mieteingang je Mietvertrag und Monat (month YYYY-MM, default aktueller Monat, oder from/to bis 36 Monate; Filter propertyId, unitId, status).

  • generate_monthly_charges Sollstellung · schreiben · legt an

    Posts (nachbuchen) the rent charges of ONE lease for one month, or for month..toMonth (at most 24 months), e.g. older months missing after a lease was record…

  • book_payment Zahlung buchen · schreiben · legt an

    Records a tenant payment that did NOT come through an imported bank statement (cents) and allocates it: paymentChannel is required (cash, other_account, bank…

  • list_deposits Kautionen · lesen · liest

    Deposit tracker: every deposit with lease, unit, tenants, kind, where it sits (bank account or heldAt), agreed/paid/held/open/interest/withheld/refunded (cen…

  • record_deposit_transaction Kaution buchen · schreiben · legt an

    Records a deposit payment, interest, withholding or refund for a lease (positive cents; does not execute a bank transfer).

  • set_deposit_custody Verwahrort der Kaution festlegen · schreiben · ändert oder entfernt

    Sets where a lease's deposit sits: kind (cash, bank_guarantee, pledged_savings, surety), for cash the bankAccountId of the account holding it (list_bank_acco…

  • settle_deposit Kaution auszahlen oder einbehalten · schreiben · legt an

    Settles a lease's deposit in one step: refundCents paid out to the tenant and/or withholdingCents kept (each may be partial, e.g. 130000 out and 30000 kept; …

  • reverse_deposit_transaction Kautionsbuchung stornieren · schreiben · ändert oder entfernt

    Cancels one deposit booking (transactionId from get_lease deposit.transactions) by a reversal booking dated today; the original stays in the history.

  • reverse_ledger_entry Buchung stornieren · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Reverses a ledger entry (charge, payment or credit) with a reason.

  • write_off_charge Forderung abschreiben · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Writes off the open rest of a charge with a reason.

Bank, Abbuchungen und Buchungsregeln

  • list_bank_inbox Bankumsätze (Inbox) · lesen · liest

    The one bank inbox, newest first: state open (not or not fully assigned), suggested (open with exactly one proposal), done, private, hidden or all; filters d…

  • accept_bank_proposals Vorschläge bei Bankumsätzen übernehmen · schreiben · ändert oder entfernt

    Books the proposal of open bank movements (list_bank_inbox, state suggested), up to 100: each item names the movement and the proposal.key you showed the user.

  • list_bank Bank · lesen · liest

    Bank accounts and up to 500 transactions, optionally open/booked/ignored. open excludes booked rent and fully consumed sources (status partial = partly assig…

  • create_bank_account Bankkonto anlegen · schreiben · legt an · Werkzeug

    Adds a bank account by IBAN (e.g. the rent account), so statements can be imported (import_bank_file) and payments matched to leases.

  • import_bank_file Kontoauszug importieren · schreiben · legt an

    Imports a bank statement: camt.053 (XML) or the bank's CSV export (file name must end in .csv; bankAccountId required for CSV), base64, max 3 MB; larger file…

  • record_manual_payment Zahlung von Hand erfassen · schreiben · legt an

    Records a payment without a bank file, on one of the owner's bank accounts (list_bank): direction in (received) or out (paid), bookingDate (not in the future…

  • delete_manual_payment Von Hand erfasste Zahlung löschen · schreiben · ändert oder entfernt

    Deletes a payment entered by hand (record_manual_payment) while it is not linked to anything (unlink it first).

  • match_bank_transaction Zahlung zuordnen · schreiben · ändert oder entfernt

    Books a whole unused incoming transaction on a rent account as a lease payment.

  • set_bank_transaction_ignored Umsatz ignorieren · schreiben · ändert oder entfernt

    Marks a bank transaction as ignored (or back to open).

  • list_open_bank_debits Offene Abbuchungen · lesen · liest

    Open outgoing bank transactions (debits) that are not booked as an expense or linked to an invoice yet, newest first, with a suggestion for each: from a matc…

  • book_bank_debit_as_expense Abbuchung als Ausgabe buchen · schreiben · ändert oder entfernt

    Books open outgoing bank transactions (from list_open_bank_debits) as booked expenses WITHOUT a receipt: recurring debits such as insurance premiums, Grundst…

  • list_open_bank_credits Offene Zahlungseingänge · lesen · liest

    Open incoming bank transactions with nothing linked yet (no rent, deposit, receipt or classification), newest first, each with the payer's last booked split …

  • book_bank_credit Zahlungseingang als Einnahme oder Erstattung buchen · schreiben · ändert oder entfernt

    Books open incoming bank transactions (from list_open_bank_credits) that are not rent or a deposit, WITHOUT a receipt: a public subsidy, building savings int…

  • set_bank_private Kontobewegung als privat markieren · schreiben · ändert oder entfernt

    Marks bank transactions as private (private: true, default) or takes the mark away (private: false): money that has nothing to do with the letting, e.g. a su…

  • remove_bank_movements Kontobewegungen entfernen · schreiben · ändert oder entfernt

    Removes bank transactions (ADR-0186 D4), one or up to 500, with a reason: privat (no letting money, e.g. private payments on a mixed account found with list_…

  • restore_bank_movement Entfernte Kontobewegung wiederherstellen · schreiben · ändert oder entfernt

    Brings a removed bank transaction (list_bank_inbox state removed) back as an open movement (ADR-0186 D4).

  • undo_bank_movement Zuordnungen einer Kontobewegung rückgängig machen · schreiben · ändert oder entfernt

    Undoes every target of one bank transaction, so it is open again and can get a new target ("Ziel ändern"): a rent payment or a refund to a tenant is reversed…

  • change_bank_target Ziel einer Kontobewegung ändern · schreiben · ändert oder entfernt

    Gives a movement that already has a target another one in ONE step: every target is undone (like undo_bank_movement) and the new one booked: rent (whole amou…

  • preview_bank_import_revocation Import zurücknehmen: Vorschau · lesen · liest

    Shows what taking back a bank statement import (wrong file, wrong account) would do: how many movements, how many with targets (rent, receipts, deposit booki…

  • revoke_bank_import Import zurücknehmen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Takes back a bank statement import (ADR-0145): every target of its movements is undone (rent payments and deposit bookings reversed, receipts booked from a m…

  • list_booking_rules Buchungsregeln · lesen · liest

    The account's booking rules for recurring bank debits (direction out) and credits (direction in): match (counterparty IBAN and/or name, optional words in the…

  • list_private_rules Regeln „immer privat“ · lesen · liest

    The account's "immer privat" rules: name, matchIban or matchName, mode (suggest or auto).

  • list_rule_offers Vorschläge für Regeln · lesen · liest

    Offers for rules after the second equal booking: kind private (a payee marked private twice), debit (two debits of a payee booked as expenses), credit (two c…

  • list_dismissed_rule_offers Abgelehnte Regelvorschläge · lesen · liest

    Offers the user answered with "Nein, nicht mehr fragen" (kind private, debit, credit or loan, label = payee, supplier or loan, dismissedAt). restore_rule_off…

  • restore_rule_offer Abgelehnten Regelvorschlag zurückholen · schreiben · ändert oder entfernt

    Undoes a "Nein, nicht mehr fragen" (dismissalId from list_dismissed_rule_offers): the offer shows again in list_rule_offers once its condition holds.

  • preview_classification_conversion Einordnungen mit Steuerwirkung · lesen · liest

    Bank movements only classified as interest, operating_cost or other_income: the cash view counts them, the tax view (Anlage V) does not.

  • convert_classifications Einordnungen als Belege übernehmen · schreiben · ändert oder entfernt

    Turns classified movements (preview_classification_conversion) into receipts: an expense for a debit (interest → Schuldzinsen, principal → Tilgung, private →…

  • create_private_rule Regel „immer privat“ anlegen · schreiben · legt an

    Creates an "immer privat" rule for a payee (IBAN or words of the name): mode suggest shows "Vorschlag: privat" on its open movements (suggest only since ADR-…

  • delete_private_rule Regel „immer privat“ löschen · schreiben · ändert oder entfernt

    Deletes an "immer privat" rule (list_private_rules).

  • create_booking_rule Buchungsregel anlegen · schreiben · legt an

    Creates a booking rule for recurring debits: match by counterparty IBAN and/or name (+ optional words in the payment reference; every given criterion must fi…

  • update_booking_rule Buchungsregel ändern · schreiben · ändert oder entfernt

    Replaces a booking rule completely (name, match, mode, supplier, service-period rule, lines; give every field again, list_booking_rules shows the current ones).

  • delete_booking_rule Buchungsregel löschen · schreiben · ändert oder entfernt

    Deletes a booking rule.

  • apply_booking_rules Regeln auf offene Umsätze anwenden · schreiben · ändert oder entfernt

    Books the open debits that match the account's booking rules as expenses (like book_bank_debit_as_expense, with the rule id), at most 100 per call. apply fal…

Cashflow und wirtschaftlicher Bericht

  • list_finance_bank Alle Bankumsätze seitenweise prüfen · lesen · liest

    Zeigt Bankumsätze mit gemeinsamem Verbrauch und freiem Rest über Miet-, Rechnungs-, Kautions- und Transferbezüge.

  • get_rent_balance_state Anfangssaldo und auszahlbares Mieterguthaben prüfen · lesen · liest

    Liest den historischen Mietkontostart, dessen revision, den Forderungssaldo und das verfügbare Mieterguthaben.

  • create_rent_installment_plan Ratenplan für bestehende Mietforderungen vorbereiten · schreiben · ändert oder entfernt

    Plant ausschließlich vorhandene vollständige offene Forderungsreste des ursprünglichen Mietkontos.

  • get_rent_installment_plan Ratenverfolgung und tatsächlichen Forderungsfortschritt prüfen · lesen · liest

    Vergleicht vereinbarte Raten mit den aktuellen ursprünglichen Forderungen. asOf bestimmt nur die fälligen Planraten; die Forderungsansicht ist aktuell.

  • list_rent_installment_plans Ratenpläne eines Mietvertrags finden · lesen · liest

    Listet Entwürfe, dokumentierte Vereinbarungen und beendete Verfolgungen eines Mietvertrags mit nextOffset.

  • record_rent_installment_agreement Tatsächlich getroffene Ratenvereinbarung dokumentieren · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Dokumentiert eine bereits getroffene Vereinbarung mit Quelle und optionalem Originaldokument.

  • end_rent_installment_tracking Ratenverfolgung mit Grund beenden · schreiben · ändert oder entfernt

    Beendet nur die technische Verfolgung und zugehörige offene Prüftermine.

  • set_rent_opening_balance Historischen Mietanfangssaldo erfassen oder korrigieren · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Übernimmt einen belegten Forderungssaldo vor dem genannten Monatsanfang: positiv = Forderung, negativ = Guthaben, 0 = ausgeglichen.

  • record_tenant_credit_refund Erfolgte Mieterguthaben-Rückzahlung zuordnen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Ordnet einen tatsächlichen Bankausgang dem verfügbaren Mieterguthaben zu und vermindert die Verbindlichkeit im bestehenden Mietkonto.

  • list_finance_reports Aktive Finanzberichte finden · lesen · liest

    Listet alle noch verfügbaren Berichtsstände dieses Kontos mit reportId und Ablauf.

  • list_finance_coverage Auszugszeiträume und Salden prüfen · lesen · liest

    Listet gespeicherte Auszüge und manuell bestätigte Abdeckungen eines Bankkontos mit Datum, Salden und zurückgenommenen Bestätigungen. confirmedBy sagt, wer b…

  • revoke_finance_coverage Unzutreffende Auszugsabdeckung zurücknehmen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Nimmt eine falsche Auszugsabdeckung mit Grund zurück.

  • list_finance_links Bankbezüge und Korrekturverlauf prüfen · lesen · liest

    Zeigt alle Miet-, Rechnungs-, Kautions-, Transfer- und Abgleichbezüge eines Bankumsatzes einschließlich zurückgenommener Relationen. nextOffset vollständig f…

  • get_finance_bank Finanzbezüge eines Bankumsatzes prüfen · lesen · liest

    Lädt Bankumsatz, Konto, freie Centbeträge, Klassifikationen und Transfer-/Abgleichbezüge. fingerprint schützt neue Zuordnungen vor Änderungen; bei Konflikt n…

  • list_finance_sources Manuelle Zahlungsquellen abgleichen · lesen · liest

    Zeigt manuelle Miet-/Kautionszahlungen ohne direkten Bankbezug und ihren unabgeglichenen Rest.

  • classify_finance_bank Freie Bankbeträge wirtschaftlich einordnen · schreiben · ändert oder entfernt

    Ersetzt Klassifikationen des freien Bankteils; fingerprint vorher mit get_finance_bank laden. lines=[] entfernt die Einordnung.

  • reconcile_finance_source Manuelle Zahlung mit Bankquelle verbinden · schreiben · ändert oder entfernt

    Verbindet einen Teil einer bestehenden manuellen Miet-/Kautionszahlung mit einer Bankbewegung.

  • reverse_finance_relation Transfer oder Zahlungsabgleich zurücknehmen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Nimmt Transfer-/Abgleichrelation mit Grund zurück; Bankbewegungen und Zahlungen bleiben erhalten.

  • allocate_bank_receipt Mieteingang auf mehrere Verträge aufteilen · schreiben · ändert oder entfernt

    Bucht gewählte Teilbeträge eines Eingangs auf einem Mietkonto auf einen oder mehrere Verträge.

  • update_finance_account Kontonutzung und Eigentümer pflegen · schreiben · ändert oder entfernt

    Ändert Namen, Zweck und aktuelle finanzielle Eigentümerzuordnung, bei Mietkonten mixedUse (auch privat genutzt: automatische Zuordnung nur mit IBAN, Name ode…

  • confirm_finance_coverage Kontoauszugsabdeckung bestätigen · schreiben · ändert oder entfernt

    Speichert vom Nutzer am Originalauszug bestätigte Datumsabdeckung und Salden.

  • get_finance_current Aktuelle Finanzlage und Monatswerte lesen · lesen · liest

    Liest ohne Speichern die aktuelle Finanzlage (Zahlungssicht) mit revision, asOf, Qualität (summary.complete; Hinweise mit severity info machen sie nicht vorl…

  • create_finance_report Wirtschaftlichen Vermieterbericht erfassen · schreiben · legt an

    Erfasst unveränderlichen konsistenten Berichtsstand: Bankcash, aktuelle offene Mieten und Rechnungen getrennt; kein Steuerbericht, Eigentümerzuordnung beim E…

  • get_finance_report Eingefrorenen Finanzbericht durchblättern · lesen · liest

    Liest Zusammenfassung, Zeilen und Hinweise ausschließlich aus reportId. nextOffset bis null fortsetzen, auch für Hinweise.

  • store_finance_report Vermieterbericht als Datei ablegen · schreiben · legt an

    Legt bestehenden Berichtsstand als vollständige CSV oder PDF im Archiv ab; PDF höchstens 5.000 Zeilen/Hinweise, größere Berichte als CSV.

Darlehen, Vermögen und Bewertungen

  • list_loans Datierte Darlehensstände finden · lesen · liest

    Listet Darlehensbeobachtungen bis asOf mit Datum, Restschuld, Rate, Zinsbindung und expliziten Objektanteilen.

  • get_loan Darlehen, Quellen und Verlauf prüfen · lesen · liest

    Liest einen Darlehensstand, die aktuelle Bearbeitungsrevision, datierte Historie und ausdrücklich zugeordnete Bank-Zins-/Tilgungsbeträge. actuals umfassen nu…

  • save_loan_observation Belegten Darlehensstand erfassen · schreiben · ändert oder entfernt

    Legt ein Darlehen oder einen neuen unveränderlichen datierten Stand an. expectedRevision=null beim Anlegen, sonst aktuelle get_loan.revision.

  • set_loan_auto_rates Darlehensraten automatisch buchen (abgeschaltet) · schreiben · ändert oder entfernt

    Abgeschaltet (ADR-0186): Darlehensraten werden nur vorgeschlagen (list_open_bank_debits, source loan) und erst nach dem OK des Nutzers mit book_bank_debit_as…

  • get_loan_interest_check Zinsabgleich mit der Bescheinigung · lesen · liest

    Für ein Darlehen und Jahr: gebuchte Zinsen aus den Raten (Belege mit loanId, Kategorie Schuldzinsen, Rechnungsdatum im Jahr), die Zinsen laut Bescheinigung d…

  • save_loan_interest_statement Zinsen laut Bescheinigung erfassen · schreiben · ändert oder entfernt

    Speichert die Zinsen eines Jahres laut Zinsbescheinigung der Bank (ersetzt einen früheren Wert) und gibt den Abgleich zurück (wie get_loan_interest_check).

  • apply_loan_interest_difference Zinsdifferenz ausgleichen · schreiben · ändert oder entfernt

    Gleicht die Differenz zwischen gebuchten Zinsen und Bescheinigung in der letzten Rate des Jahres aus: Zins + Differenz, Tilgung − Differenz (gleiches Objekt)…

  • get_loan_scenario Explizites Darlehensszenario berechnen · lesen · liest

    Berechnet ein begrenztes monatliches Festzins-Szenario ab dem belegten Restschulddatum.

  • get_portfolio_finance Objektwerte und zugeordnete Schulden überblicken · lesen · liest

    Zeigt den jeweils letzten datierten Objektwert (valuation.source: comparison_approach = automatischer Vergleichswert mit Spanne, automatic_income_approach = …

  • record_property_valuation Eigene datierte Objektschätzung speichern · schreiben · ändert oder entfernt

    Speichert eine eigene belegte Wertspanne als neue Beobachtung.

  • confirm_debt_inventory Vollständigkeit des Schuldenbestands bestätigen · schreiben · ändert oder entfernt

    Speichert die ausdrückliche Nutzerbestätigung, dass zum genannten Datum alle relevanten Darlehen erfasst sind. fingerprint aus get_portfolio_finance.

  • get_wealth_overview Vermögen: automatische Quartalsbewertungen je Objekt · lesen · liest

    Zeigt je Objekt die Bewertungsangaben (profile mit revision), was für die automatische Quartalsbewertung noch fehlt (missing), den Wertverlauf (history mit s…

  • save_valuation_profile Bewertungsangaben eines Objekts speichern · schreiben · ändert oder entfernt

    Speichert die Angaben für die automatische Quartalsbewertung (Vergleichswert) als neue Revision (expectedRevision aus get_wealth_overview, null beim ersten M…

  • request_property_valuation Objekt jetzt neu bewerten · schreiben · ändert oder entfernt

    Berechnet sofort den Vergleichswert aus den aktuellen Marktdaten des Ortes und speichert ihn (nur wenn sich Wert oder Marktquartal geändert haben).

Rechnungen und Ausgaben

  • list_invoices Rechnungen · lesen · liest

    Legacy array of invoices and expenses, newest first (at most 500); use list_invoices_page for complete traversal.

  • list_invoices_page Rechnungen seitenweise · lesen · liest

    Alle Rechnungen und Ausgaben seitenweise: dieselben Felder wie list_invoices, absteigend nach createdAt und id.

  • get_invoice Rechnung · lesen · liest

    Invoice or expense with supplier, amounts (cents), allocations to properties, its bank payments (payments: one or several, each with the part of the invoice …

  • list_expense_catalogs Kostenarten und Steuerkategorien · lesen · liest

    Operating-cost types (BetrKV) and tax categories with their ids; incomeCategories (Anlage V line in hint) for book_bank_credit.

  • upload_invoice Rechnung hochladen · schreiben · legt an · Werkzeug

    Uploads an invoice: base64 up to 3 MB, or create_upload_link + finalize_upload up to 50 MB.

  • create_invoice Rechnung ohne Beleg erfassen · schreiben · legt an

    Creates an invoice without a file (a lost receipt, a bill only seen online): supplierName, invoiceDate and grossCents required, the other fields as in update…

  • submit_invoice_reading Rechnung auslesen · schreiben · legt an · Werkzeug

    Prefills empty header fields of a detected invoice from get_document_content (documentId from get_invoice).

  • update_invoice Rechnungsdaten · schreiben · ändert oder entfernt

    Sets or confirms the invoice header (supplier, number, date, amounts in cents or German text, service period, dueDate: printed due date, omit = keep, null = …

  • set_invoice_allocations Rechnung zuordnen · schreiben · ändert oder entfernt

    Splits an invoice into lines (property, unit, amount, cost type, allocable, tax category, §82b years); book=true books it.

  • set_invoice_private Beleg als privat markieren · schreiben · ändert oder entfernt

    Marks a whole receipt private, without property: scope income_tax = 'Privat – für die Einkommensteuer' (the owner's private tax return, e.g. a donation, insu…

  • book_invoice Rechnung buchen · schreiben · ändert oder entfernt

    Books an assigned invoice.

  • link_invoice_payment Zahlung zur Rechnung · schreiben · ändert oder entfernt

    Links bank payments to an invoice: the outflow date counts for the tax year (R-TAX-02).

  • refresh_bank_matching Bankumsätze abgleichen · schreiben · ändert oder entfernt

    Runs the shared matching rules over the open bank transactions (at most 500, newest first) against rent charges, recorded invoices and manual payments, and l…

  • find_expense_for_receipt Gebuchte Ausgabe zu einem Beleg finden · lesen · liest

    For an uploaded receipt (invoice not yet booked): expenses already booked from a bank debit without receipt that it most likely documents (match exact: same …

  • merge_receipt_into_expense Beleg an gebuchte Ausgabe anhängen · schreiben · ändert oder entfernt

    A receipt uploaded as an invoice (not booked) that documents an expense already booked from a bank debit without receipt: moves the receipt's document onto t…

  • undo_receipt_attach Automatisch angehängten Beleg wieder trennen · schreiben · ändert oder entfernt

    Undoes an automatic attach (R-DOC-08: autoAttached of upload_invoice or submit_invoice_reading): the expense is without receipt (Beleg folgt) again and the r…

  • set_receipt_expected Beleg folgt / kein Beleg nötig · schreiben · ändert oder entfernt

    Marks expenses without a document as Beleg folgt (true: on the list Beleg fehlt, list_invoices receiptMissing) or kein Beleg nötig (false: the bank statement…

  • set_invoice_paid_otherwise Rechnung als bezahlt markieren (ohne Kontoauszug) · schreiben · ändert oder entfernt

    Für Zahlungen, die in keinem importierten Kontoauszug stehen (Kreditkarte, PayPal, bar): paid=true markiert den offenen Rest der Rechnung als bezahlt am Tag …

  • set_invoices_paid_otherwise Mehrere Rechnungen als bezahlt markieren (ohne Kontoauszug) · schreiben · ändert oder entfernt

    Marks up to 200 booked invoices as paid on their invoice date (today if that is in the future), for payments that are in no imported statement (private accou…

  • unbook_invoice Rechnungsbuchung aufheben · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Returns a booked invoice to 'assigned'.

  • get_receipt_proposal Buchungsvorschlag einer Rechnung lesen · lesen · liest

    Liest den Buchungsvorschlag, den der Eigentümer auf der Rechnungsseite sieht: Objekt, Kostenart, umlegbar (nach BetrKV-Katalog, nie geschätzt), steuerliche E…

  • propose_receipt_booking Buchungsvorschlag für den Eigentümer hinterlegen · schreiben · ändert oder entfernt

    Du liest den Beleg selbst (get_document_content) und hinterlegst, was du erkannt hast: gedruckte Felder, Kostenart-Code aus list_expense_catalogs mit Sicherh…

  • accept_receipt_proposal Buchungsvorschlag annehmen und buchen · schreiben · ändert oder entfernt

    Nimmt den Vorschlag aus get_receipt_proposal an: übernimmt gelesene Felder, prüft und bucht die Rechnung und führt die bejahten Anschlussfragen aus (Zahlung,…

  • reject_receipt_proposal Buchungsvorschlag verwerfen · schreiben · ändert oder entfernt

    Verwirft einen gespeicherten offenen Vorschlag (id aus get_receipt_proposal).

  • delete_invoice Rechnung löschen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Soft-deletes an invoice (the file stays in the documents).

Dokumente

  • search_documents Dokumente suchen · lesen · liest · Werkzeug

    German full-text search in uploaded documents.

  • list_documents_page Dokumente vollständig nach Kontext und Datum finden · lesen · liest

    Paginierte Dokumentensuche mit vollständiger Trefferzahl, Art, Objekt/Einheit/Mietvertrag und Dokumentdatum.

  • list_documents Dokumente · lesen · liest

    Documents linked to an entity, or the most recent documents when no entity is given.

  • get_document_download_url Dokument herunterladen · lesen · liest · Werkzeug

    Short-lived (60 s) download URL of a document's original file (PDF, photo, XML, CSV; served as attachment).

  • get_document_content Dokumentinhalt lesen · lesen · liest · Werkzeug

    Reads an uploaded document: PDF text page by page from fromPage (nextFromPage when more follows; a page above 40,000 characters is cut, truncated: true), XML…

  • upload_document Dokument hochladen · schreiben · legt an

    Stores a document (base64, max 3 MB; up to 50 MB with create_upload_link and finalize_upload) and optionally links it to an entity.

  • create_upload_link Upload-Link anlegen · schreiben · legt an

    For files above 3 MB, up to 50 MB (bank statements 10 MB): returns a signed uploadUrl and uploadId.

  • finalize_upload Upload abschließen · schreiben · ändert oder entfernt

    Finishes create_upload_link after the PUT, using the same content checks as upload_document/upload_invoice/import_bank_file.

  • link_document Dokument verknüpfen · schreiben · ändert oder entfernt

    Links an existing document to a property, unit, person, lease, invoice, …; remove: true unlinks it (the document stays).

  • withdraw_document Dokument zurückziehen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Takes an uploaded document out of all lists and searches, with a reason (e.g. wrong file).

  • send_document_by_email Dokument per E-Mail senden · schreiben · versendet an Dritte

    Sends an existing document of the account (e.g. the signed lease contract, a final handover protocol PDF, a letter) by e-mail, unchanged, as an attachment.

  • list_listing_photos Inseratbilder einer Einheit · lesen · liest

    The listing photos (Inseratbilder) of a unit for an ad on ImmoScout and the like, in order: photoId, position (1 = cover photo, Titelbild), isCover, document…

  • add_listing_photo Inseratbild hinzufügen · schreiben · legt an

    Adds a photo the account already has as the last listing photo of a unit (the first photo of a unit becomes the cover). documentId: a JPEG, PNG or HEIC docum…

  • arrange_listing_photos Inseratbilder ordnen · schreiben · ändert oder entfernt

    Sets the order of all listing photos of a unit: photoIds lists every photoId from list_listing_photos exactly once, in the new order; the first becomes the c…

Nebenkostenabrechnung

  • get_allocation_setup Umlageschlüssel · lesen · liest

    Allocation keys of a property, their base values, defaults per cost type and lease agreements.

  • create_allocation_key Umlageschlüssel anlegen · schreiben · legt an

    Creates an allocation key (living area, persons, units, MEA, consumption, …) for a property.

  • update_allocation_key Umlageschlüssel ändern · schreiben · ändert oder entfernt

    Updates name, scope, vacancy persons or selected units of an allocation key.

  • set_allocation_base Basiswert setzen · schreiben · ändert oder entfernt

    Sets a base value of a key for a unit from a date (MEA, custom share, fixed amount in cents).

  • set_property_default_key Standardschlüssel · schreiben · ändert oder entfernt

    Default allocation key of a property for a cost type.

  • set_lease_agreement Umlagevereinbarung · schreiben · ändert oder entfernt

    Sets the allocation agreement of a lease from a date (cost types, keys, caps).

  • adopt_contract_agreement Umlagevereinbarung aus dem Mietvertrag übernehmen · schreiben · legt an

    Takes the allocation agreement (Umlagevereinbarung: which operating costs the tenant bears, from the lease start) over from the lease's contract signed in Ze…

  • archive_allocation_key Umlageschlüssel archivieren · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Archives an allocation key so it can no longer be chosen.

  • get_settlement_period Nebenkosten-Abrechnungszeitraum · lesen · liest

    The property's settlement period: startMonth (null = not set yet; ask the owner or set it with set_settlement_period), a proposal (the latest WEG statement's…

  • set_settlement_period Nebenkosten-Abrechnungszeitraum festlegen · schreiben · ändert oder entfernt

    Sets only the property's operating-cost settlement period: startMonth 1–12, twelve months from the first of that month (e.g. 7 = July–June, like the WEG's Wi…

  • get_property_tax_values Grundsteuer laut Bescheid · lesen · liest

    The Grundsteuer of a property as a fixed annual amount laut Bescheid: versions (whole property, or per unit for an Eigentumswohnung; annualCents, validFrom, …

  • set_property_tax_value Grundsteuer laut Bescheid eintragen · schreiben · ändert oder entfernt

    Enters the annual Grundsteuer laut Bescheid from validFrom on (1 January, or the day of the Besitzübergang); a later entry ends the earlier one.

  • delete_property_tax_value Grundsteuer-Wert löschen · schreiben · ändert oder entfernt

    Deletes one version of the Grundsteuer laut Bescheid (a mistaken entry, get_property_tax_values).

  • list_settlement_runs Nebenkostenabrechnungen · lesen · liest

    Operating-cost settlement runs of a property with period, status and deadline.

  • get_settlement_run Nebenkostenabrechnung · lesen · liest

    A settlement run: positions, findings (linter), results per lease (balanceCents is always the full result, also after run.deadlineOn, § 556 Abs. 3 BGB: nothi…

  • list_settlement_invoice_candidates Passende Rechnungen für die Abrechnung · lesen · liest

    Invoices of the run's property for its period that are not part of the settlement yet (not allocable, without a cost type, or not booked): supplier and numbe…

  • explain_settlement_amount Betrag erklären · lesen · liest

    Explains one amount of a settlement run from the trace: segments, weights, share, rounding, cap. participantKey as returned by get_settlement_run (l:<leaseId…

  • get_prepayment_proposals Vorauszahlungen anpassen (Vorschläge) · lesen · liest

    Proposals to adjust prepayments after a sent settlement (§ 560 Abs. 4 BGB).

  • create_settlement_draft Abrechnung anlegen · schreiben · legt an

    Creates a settlement run (draft) for a property and period; positions come from booked invoices.

  • refresh_settlement_positions Neue Rechnungen übernehmen · schreiben · ändert oder entfernt

    Adds positions for newly booked invoices of the period.

  • set_settlement_co2 CO₂-Kosten erfassen · schreiben · ändert oder entfernt

    Records the CO₂ data of a heating run (CO2KostAufG): emissionsKg (kg CO₂ of the period as a plain decimal with a dot, no thousands separators: 3000, not 3.00…

  • clear_settlement_co2 CO₂-Kosten entfernen · schreiben · ändert oder entfernt

    Removes the CO₂ data of an open heating run (run goes back to draft).

  • update_settlement_position Position ändern · schreiben · ändert oder entfernt

    Changes key, heating split or §35a amount of a position (run goes back to draft).

  • set_settlement_heating_split Heizkosten bei Mieterwechsel aufteilen · schreiben · ändert oder entfernt

    How a position carried by one flat is split between the flat's tenants and vacancy at a change of tenant. (1) Heating (§ 9b HeizkostenV; a WEG heating line o…

  • set_settlement_result_ledger Ergebnis ins Mietkonto übernehmen oder nicht · schreiben · ändert oder entfernt

    Whether a lease's result (back payment or credit) goes into the rent ledger, and so into the FIBU and the tax, when the statement is sent: include true is th…

  • set_settlement_backpayment_claim Nachzahlung nach Fristablauf fordern oder nicht · schreiben · ändert oder entfernt

    After the settlement deadline (§ 556 Abs. 3 BGB, run.deadlineOn) ZeroImmo cuts nothing: a back payment is billed and posted in full unless the owner decides …

  • get_settlement_weg_co2 CO₂-Angabe der WEG-Abrechnung · lesen · liest

    For a settlement run derived from a WEG statement: the owner's CO₂ status (to_deduct with landlordCents, deducted, not_applicable, or null = not stated) and …

  • set_settlement_weg_co2 CO₂-Anteil bei WEG-Abrechnung angeben · schreiben · ändert oder entfernt

    CO2KostAufG for a settlement run derived from a WEG statement (owned flat): status to_deduct with landlordCents (the landlord's share of the flat's CO₂ costs…

  • add_settlement_position Position hinzufügen · schreiben · ändert oder entfernt

    Adds a manual position (cents; credit notes negative).

  • assign_invoice_to_settlement Rechnung in die Abrechnung übernehmen · schreiben · ändert oder entfernt

    Takes a booked invoice of the property into an open settlement run as an allocable cost of costTypeId (a BetrKV cost type, e.g. property_tax for a Grundsteue…

  • delete_settlement_position Position entfernen · schreiben · ändert oder entfernt

    Removes a position from an open run.

  • calculate_settlement Abrechnung berechnen · schreiben · ändert oder entfernt

    Calculates a run (engine + linter); returns findings and whether errors block it.

  • mark_settlement_reviewed Als geprüft markieren · schreiben · ändert oder entfernt

    Marks a calculated run without errors as reviewed (audited).

  • finalize_settlement Abrechnung abschließen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Finalizes a reviewed settlement run (frozen afterwards; Beta, no legal guarantee). acknowledgeWarnings is needed when the linter warned.

  • generate_settlement_statements Abrechnungs-PDFs erzeugen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · legt an

    Archives one statement PDF per lease of a finalized run in the document store.

  • send_settlement_statements_by_email Abrechnungen per E-Mail versenden · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · versendet an Dritte

    Mails each tenant their statement (if e-mail is configured).

  • mark_settlement_sent Als versendet markieren · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Records that all statements of the run not sent yet were sent (e.g. by post) on a date and posts their results to the rent ledger, except those the owner kep…

  • mark_settlement_statement_sent Eine Abrechnung als versendet vermerken · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Records that the statement of ONE lease of a finalized run was sent by the owner himself (letter, hand-over) on a date, and posts that lease's result to its …

  • reverse_settlement Abrechnung stornieren · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Reverses a finalized or sent run: the ledger postings of its results are reversed and the prepayment charges written down when it was sent are open again; a …

  • delete_settlement_draft Abrechnungsentwurf löschen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Deletes an open settlement run.

  • apply_prepayment_adjustment Vorauszahlung anpassen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Applies a prepayment adjustment (§ 560 Abs. 4 BGB) as a rent change; the tenant must be informed in text form.

WEG-Abrechnung (Eigentumswohnung)

  • list_weg_statements WEG-Abrechnungen · lesen · liest

    WEG Hausgeldabrechnungen of an owned flat (Path B).

  • get_weg_statement WEG-Abrechnung · lesen · liest

    A WEG statement with its lines, mapping and the settlement runs using it. reserveUseCheck (null = fine) warns when lines are marked paidFromReserve but the s…

  • create_weg_statement WEG-Abrechnung anlegen · schreiben · legt an

    Creates a WEG statement for a unit and period (lines added separately).

  • submit_weg_reading WEG-Abrechnung auslesen · schreiben · legt an

    Adds all cost lines (at most 80) of a draft WEG statement (Einzelabrechnung of an owned flat) at once, as you read them from its PDF (read it with get_docume…

  • add_weg_line WEG-Position · schreiben · legt an

    Adds a line (label, unit share in cents, WEG key); the cost type is proposed from the label.

  • update_weg_line WEG-Zuordnung · schreiben · ändert oder entfernt

    Maps a line (cost type, allocable, heating, isReserve = contribution to the reserve, paidFromReserve = a repair the WEG paid from the reserve: on review it b…

  • delete_weg_line WEG-Position entfernen · schreiben · ändert oder entfernt

    Removes a line of a draft WEG statement.

  • mark_weg_reserve_use WEG-Positionen als „aus der Rücklage bezahlt“ markieren · schreiben · ändert oder entfernt

    Marks lines of a draft WEG statement as repairs the WEG paid from the Erhaltungsrücklage (paidFromReserve), in one step.

  • set_weg_reserve_use_paid_on Zahlungsdatum der Reparatur aus der Rücklage · schreiben · ändert oder entfernt

    Sets the day the WEG paid the repairs marked paidFromReserve.

  • mark_weg_reviewed WEG-Abrechnung prüfen · schreiben · ändert oder entfernt

    Confirms all mappings of a WEG statement (confirmed must be true); mappings are learned.

  • list_hausgeld_plans Hausgeld-Pläne · lesen · liest

    The Hausgeld plans of the owner's condominiums, per property and flat the newest first: monthlyCents, reserveCents (Erhaltungsrücklage, not deductible), oper…

  • get_hausgeld_proposal Hausgeld laut WEG-Abrechnung · lesen · liest

    The monthly Hausgeld a WEG statement gives for set_hausgeld_plan: source plan = the new Wirtschaftsplan attached to the statement (from = its first day, if p…

  • set_hausgeld_plan Hausgeld-Plan einer Eigentumswohnung eintragen · schreiben · ändert oder entfernt

    Enters the monthly Hausgeld of a condominium (flat) from a day on: monthlyCents exactly as debited, reserveCents = the part for the Erhaltungsrücklage (not d…

  • delete_hausgeld_plan Hausgeld-Plan löschen · schreiben · ändert oder entfernt

    Deletes a Hausgeld plan and its booking rule.

  • book_hausgeld_special_levy Sonderumlage der WEG buchen · schreiben · ändert oder entfernt

    Books an open bank debit that is a Sonderumlage to the WEG, by its purpose (ask the owner; it follows from the owners' resolution): maintenance → Erhaltungsa…

  • apply_hausgeld_plan_to_booked Gebuchtes Hausgeld „offen“ nach dem Plan aufteilen · schreiben · ändert oder entfernt

    Splits Hausgeld that was booked as 'Aufteilung offen' (tax category weg_hausgeld_open, counts 0 € for tax) by the Hausgeld plan: the reserve part becomes 'Zu…

  • get_weg_year_check WEG-Jahr prüfen · lesen · liest

    For a WEG statement: the monthly Hausgeld paid in its period (booked payments known by a Hausgeld plan; paid) against the Soll-Vorschüsse of the statement (a…

  • apply_weg_year_split Hausgeld eines WEG-Jahres für die Steuer verteilen · schreiben · ändert oder entfernt

    Applies the split get_weg_year_check proposes for a reviewed WEG statement: the running-costs part of each monthly Hausgeld payment of the period and of the …

  • create_weg_settlement Abrechnung aus WEG · schreiben · legt an

    Creates the tenant settlement run from a reviewed WEG statement, for the statement's period: one run for the flat with one result (and one statement PDF) per…

  • reopen_weg_statement WEG-Abrechnung wieder öffnen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Reopens a reviewed WEG statement (refused while a settlement run uses it).

  • delete_weg_statement WEG-Abrechnung löschen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Soft-deletes a draft WEG statement that no settlement uses.

  • list_buildings Häuser (Eigentumswohnungen an einer Adresse) · lesen · liest

    The account's "Häuser" (in the data: buildings; the owner's condominiums in one house, ADR-0157; the web calls the group "Haus", the word "Gebäude" is kept f…

  • get_building_anlage_v Anlage V eines Hauses zusammen · lesen · liest

    The Anlage V lines summed over the condominiums of a building, with each property's result.

  • list_tax_filing_groups Gemeinsame Anlagen V · lesen · liest

    The filing groups (ADR-0206): condominiums of one house the owner files in ONE Anlage V for a tax year, with their flats.

  • get_filing_group_anlage_v Gemeinsame Anlage V einer Gruppe · lesen · liest

    The joint Anlage V of a filing group for its year: the finished Anlagen V of its flats added line by line (income lines minus expense lines = resultCents; ea…

  • create_building Haus anlegen (Eigentumswohnungen zusammenfassen) · schreiben · legt an

    Creates a "Haus" (in the data: building) for condominiums of the owner in one house (address, year of construction, WEG name, administrator once), optionally…

  • create_split_house Aufgeteiltes Haus mit Eigentumswohnungen anlegen · schreiben · legt an

    Creates a house that is divided into condominiums (Teilungserklärung) in one step: a Haus and one condominium property per flat of the owner, each with its u…

  • link_property_to_building Eigentumswohnung einem Haus zuordnen · schreiben · ändert oder entfernt

    Puts a property into a building (buildingId) or takes it out (null).

  • create_tax_filing_group Wohnungen in einer Anlage V abgeben · schreiben · legt an

    Files several condominiums in ONE Anlage V for a tax year (per year, never carried over silently).

  • delete_tax_filing_group Gemeinsame Anlage V wieder trennen · schreiben · ändert oder entfernt

    Separates a filing group: every flat is filed by itself again for that year.

  • mark_filing_group_filed Gemeinsame Anlage V als abgegeben markieren · schreiben · ändert oder entfernt

    Marks every flat of a filing group as filed for the group's year (the lines of each flat are frozen as filed, later changes show per flat).

  • unmark_filing_group_filed Abgabe-Markierung der gemeinsamen Anlage V zurücknehmen · schreiben · ändert oder entfernt

    Takes the filing mark of every flat of a filing group back (filed by mistake, or a corrected return follows).

Messdienst-Abrechnung (Heizkosten)

  • list_provider_statements Messdienst-Abrechnungen · lesen · liest

    Heating statements of a metering service (Heizkostenabrechnung of ista, Techem, Brunata-Metrona, Minol, Kalo …) recorded for a property: period, service, sta…

  • get_provider_statement Messdienst-Abrechnung · lesen · liest

    A metering service's heating statement: header (period, shares, CO₂ data and mode, remote reading and § 6a monthly information), the distributed cost lines, …

  • get_provider_cost_statement Kostenaufstellung für den Messdienst · lesen · liest

    Kostenaufstellung for the metering service (Messdienst: ista, Techem, Brunata-Metrona, Minol, Kalo …) of a property and period: what the landlord sends befor…

  • store_provider_cost_statement Kostenaufstellung für den Messdienst ablegen · schreiben · legt an

    Creates the Kostenaufstellung for the metering service (the same content as get_provider_cost_statement: heating costs from booked invoices by the categories…

  • create_provider_statement Messdienst-Abrechnung anlegen · schreiben · legt an

    Creates a draft for the heating statement of a metering service (Heizkostenabrechnung of ista, Techem, Brunata-Metrona, Minol, Kalo or a local service) for a…

  • submit_provider_reading Messdienst-Abrechnung auslesen · schreiben · legt an

    Adds the header, the distributed cost lines and all users (at most 200) of a draft metering service statement at once, as you read them from its PDF (read th…

  • update_provider_statement Messdienst-Abrechnung ändern · schreiben · ändert oder entfernt

    Corrects the header of a draft metering service statement: service, Liegenschaftsnummer, period, documentId, CO₂ mode and CO₂ data, consumption shares, hot-w…

  • update_provider_user Nutzer der Messdienst-Abrechnung zuordnen · schreiben · ändert oder entfernt

    Corrects a user line of a draft metering service statement: our unit (learned for this service and Nutzer-Nr.), the lease (null = vacancy or owner use; a lin…

  • add_provider_user Nutzer zur Messdienst-Abrechnung hinzufügen · schreiben · legt an

    Adds a user line the reading missed to a draft metering service statement: Nutzer-Nr., location, our unit and lease (empty = vacancy or owner use), the user …

  • delete_provider_user Nutzer aus der Messdienst-Abrechnung entfernen · schreiben · ändert oder entfernt

    Removes a user line of a draft metering service statement, e.g. one read twice.

  • review_provider_statement Messdienst-Abrechnung prüfen · schreiben · ändert oder entfernt

    Confirms a metering service statement (confirmed must be true, only after the owner checked users, leases and amounts): every user needs a unit; the units ar…

  • apply_provider_statement Messdienst-Abrechnung übernehmen · schreiben · ändert oder entfernt

    Puts a reviewed metering service statement into the open heating settlement run of the property (runId, else the open run overlapping the period, else a new …

  • reopen_provider_statement Messdienst-Abrechnung wieder öffnen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Reopens a reviewed metering service statement for corrections (refused while a settlement run uses it).

  • delete_provider_statement Messdienst-Abrechnung löschen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Soft-deletes a draft metering service statement that no settlement uses; the PDF stays in the documents.

Zähler und Heizung

  • list_meters Zähler · lesen · liest

    Meters of a property with their master data (serial number, location, calibration, maloId, meloId, gridOperator, meteringOperator, technology, dualTariff, ha…

  • list_lease_meter_readings Zählerstände eines Mietverhältnisses · lesen · liest

    The meter readings of one tenancy (ADR-0209): the readings linked to the lease (move-in, move-out, interim; relation linked) and the readings of the unit's o…

  • list_supply_contracts Lieferverträge · lesen · liest

    Supply contracts of a property's meters (ADR-0130): meterId, party (tenant with leaseId, or landlord), supplier, customerNo, contractNo, from, to (last day; …

  • get_unit_occupancy Belegung und Leerstand · lesen · liest

    Per flat of a property (ADR-0130): who uses it today (current.kind lease with leaseId and tenant, usage with periodId, usage such as vacant_letting_intent an…

  • get_portfolio_occupancy Zähler & Leerstand (alle Objekte) · lesen · liest

    Overview of meters and vacancy across all properties of the account (ADR-0130), today: figures (vacantUnits, lettableUnits, vacancyRatePercent, avgDaysVacant…

  • list_vacancy_mandates Leerstandsmanagement-Aufträge · lesen · liest

    The account's vacancy management orders (ADR-0171, request_vacancy_management), newest first: id, unitId, unitLabel, meterType (electricity/gas), serialNo, m…

  • request_vacancy_management Leerstandsmanagement beauftragen · schreiben · legt an

    Orders ZeroImmo' free vacancy management for a vacant flat (ADR-0171), only when the user wants it: with the landlord's power of attorney for this one proces…

  • set_vacancy_mandate_tenant Neuen Mieter für das Leerstandsmanagement angeben · schreiben · ändert oder entfernt

    Enters or corrects the next tenant of a vacancy management order (ADR-0171) so staff can re-register the meter at the supplier: mandateId (list_vacancy_manda…

  • cancel_vacancy_mandate Leerstandsmanagement stornieren · schreiben · ändert oder entfernt

    Cancels a vacancy management order (ADR-0171) while staff have not signed a supply contract yet (status beauftragt); afterwards the user writes to ZeroImmo.

  • get_reading_sheet Ablesebogen · lesen · liest

    Reading sheet for a key date: the meters installed then, grouped by unit (type, serial number, location, last reading, calibration expired) and pdfUrl, the P…

  • store_reading_sheet Ablesebogen ablegen · schreiben · legt an

    Creates the reading sheet (Ablesebogen) of a property for a key date as a PDF (the same content as get_reading_sheet: the meters installed then, grouped by u…

  • create_meter Zähler anlegen · schreiben · legt an

    Adds a meter to a property (building meter) or a unit: cold_water, hot_water, heat (Wärmemengenzähler), heat_cost_allocator, electricity, gas, oil_tank, dist…

  • update_meter Zähler ändern · schreiben · ändert oder entfernt

    Changes a meter's serial number, location or calibration date (calibrationUntil = last valid day of the Eichfrist, usually 31 Dec; a task appears 6 months be…

  • add_meter_reading Zählerstand · schreiben · legt an

    Records a meter reading as printed on the meter (up to 3 decimals) on readOn, with source (who read it) and reason (why it was taken: move_in, move_out, vaca…

  • set_unit_vacancy Grund oder Vermietungsabsicht für einen Leerstand angeben · schreiben · ändert oder entfernt

    Optional.

  • set_supply_contract Liefervertrag erfassen · schreiben · ändert oder entfernt

    Records who buys the energy of a meter (electricity, gas, district heating) from when (ADR-0130): party tenant (with the leaseId of the meter's flat) or land…

  • end_supply_contract Liefervertrag beenden · schreiben · ändert oder entfernt

    Ends a supply contract of a meter on a last day (it can only become shorter), e.g. when the tenant moves out or the landlord's vacancy contract ends.

  • get_heating_setup Heizungsanlage · lesen · liest

    Heating system of a property (versions, newest first: system type heating_only or combined, fuel type, fuel meter, calorific value Hi, gas billed by gross ca…

  • set_heating_system Heizungsanlage festlegen · schreiben · ändert oder entfernt

    Sets the heating system of a property from validFrom (the version before ends that day). systemType combined = heating and hot water from one system: then ho…

  • add_fuel_delivery Tanklieferung erfassen · schreiben · legt an

    Records a delivery into a tank (meter type oil_tank): date, quantity in the tank's unit, gross amount in cents, optional invoiceId (then the invoice is not c…

  • delete_fuel_delivery Tanklieferung löschen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Deletes a fuel delivery into a tank (refused inside finalized settlement periods).

  • set_co2_landlord_override CO₂-Anteil abweichend · schreiben · ändert oder entfernt

    Sets the landlord's CO₂ share (0–100 %) of a unit from validFrom where the tier of the CO2KostAufG does not apply. reason (required with a share): non_reside…

  • delete_meter_reading Zählerstand löschen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Deletes a meter reading (refused inside finalized settlement periods).

  • remove_meter Zähler ausbauen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Marks a meter as removed on a date.

  • exchange_meter Zähler tauschen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Meter exchange (Zählertausch, ADR-0130) in one step: books the old meter's final reading (finalValue) on exchangedOn, marks it removed that day, creates the …

  • delete_supply_contract Liefervertrag löschen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Deletes a supply contract entered by mistake (to end a contract use end_supply_contract).

Steuer, AfA und Anlage V

  • get_tax_overview Steuerübersicht · lesen · liest

    Tax cockpit of a property and year: income and expenses per line with sources, corrections and result.

  • get_anlage_v Anlage V (Zeilen) · lesen · liest

    The tax overview of a property and year in the lines of the Anlage V form: per line the total, the deductible share (basis points), the deductible amount and…

  • get_rent_tracker § 21-Tracker (50 % / 66 %) · lesen · liest

    The § 21 Abs. 2 EStG tracker (ADR-0186 D7): for every running residential lease the agreed rent incl.

  • get_anlage_v_elster Anlage V für ELSTER (Feldkennungen) · lesen · liest

    The Anlage V of a property and year as ELSTER fields (ADR-0187): per field the official field ID (Feldkennung, e.g. E0704508 = Schuldzinsen direkt), the line…

  • get_tax_readiness Bereit für die Anlage V? · lesen · liest

    Readiness of one property's Anlage V for a year: light (the items about this property, scope property) and accountLight (scope account: open bank movements, …

  • preview_purchase_costs Kaufnebenkosten aufteilen (Vorschau) · lesen · liest

    Splits the costs of buying a property: acquisition costs (price, land transfer tax, broker, notary and land register for the ownership) → building AfA basis …

  • apply_purchase_costs Kaufnebenkosten übernehmen · schreiben · ändert oder entfernt

    Saves the result of preview_purchase_costs: an AfA suggestion for the building (status suggested, counts after confirm_depreciation_record; an entered buildi…

  • confirm_inclusive_rent Inklusivmiete bestätigen (Zeile 24) · schreiben · ändert oder entfernt

    Confirms (or withdraws) that a lease's rent includes the operating costs (all-inclusive or gross rent, no prepayment or flat rate): Anlage V line 24 = Ja. ge…

  • get_tax_opt_ins Steuerliche Besonderheiten (§ 7b, §§ 7h/7i) · lesen · liest

    The property's opt-ins for § 7b (special AfA for new rental flats) and §§ 7h/7i (redevelopment area / listed monument), the building application date, the sp…

  • preview_special_afa Sonder-AfA berechnen (Vorschau) · lesen · liest

    Computes the plan of § 7b (5 % of the basis capped per m² for four years; refused over the cost cap or outside the application windows) or §§ 7h/7i (9 % × 8 …

  • set_tax_opt_ins Steuerliche Besonderheiten ein- oder ausschalten · schreiben · ändert oder entfernt

    Switches the opt-ins § 7b, § 7h, § 7i of a property (omitted ones stay).

  • create_special_afa Sonder-AfA eintragen (§ 7b, §§ 7h/7i) · schreiben · legt an

    Computes the plan (see preview_special_afa) and enters one AfA record per phase; needs the opt-in (set_tax_opt_ins). §§ 7h/7i: pass certificateDocumentId of …

  • list_tax_carryforwards § 82b-Register (verteilte Ausgaben aus früheren Jahren) · lesen · liest

    Maintenance spread over 2–5 years (§ 82b EStDV) that started before ZeroImmo, per property: origin year, total, years, what was deducted before the year, the…

  • add_tax_carryforward Verteilte Ausgabe aus früheren Jahren eintragen (§ 82b) · schreiben · legt an

    Enters maintenance spread over 2–5 years that started before ZeroImmo (origin year = year paid, total, years).

  • confirm_tax_carryforward Vorschlag aus der Vorjahres-Anlage V bestätigen · schreiben · ändert oder entfernt

    Confirms a suggested entry (list_tax_carryforwards, status suggested), with the total and years if they were not read.

  • delete_tax_carryforward Eintrag im § 82b-Register entfernen · schreiben · ändert oder entfernt

    Removes a register entry (a wrong suggestion or a typo).

  • set_tax_carryforwards_none Keine verteilten Ausgaben aus früheren Jahren · schreiben · ändert oder entfernt

    Records the owner's answer that the property has no maintenance spread from before ZeroImmo (none true), or opens the question again (false).

  • mark_tax_year_filed Steuerjahr als abgegeben markieren · schreiben · ändert oder entfernt

    Marks one property's Anlage V of a year as filed (owner decision): the lines as they are now are kept; later bookings stay possible and show as changes in ge…

  • unmark_tax_year_filed Abgabe-Markierung zurücknehmen · schreiben · ändert oder entfernt

    Takes back mark_tax_year_filed for one property and year (the snapshot is deleted).

  • set_deposit_offset_tax Kautionseinbehalt in die Anlage V übernehmen · schreiben · ändert oder entfernt

    Answers "übernehmen?" for a withholding of the deposit (depositOffsets of get_tax_overview): counted true = income on Anlage V line 25 (verrechnete Mietkauti…

  • list_private_tax_items Private Posten für die Einkommensteuer · lesen · liest

    The owner's private items for the PRIVATE income tax return of a year (E-PRIV): bank movements marked 'Privat – für die Einkommensteuer' (set_bank_private in…

  • export_tax_advisor_package Steuerberater-Paket herunterladen · lesen · liest

    The Steuerberater-Paket of a tax year for one property or all (ZIP): README.txt, per property a folder with Zusammenfassung-<year>.pdf (income, Werbungskoste…

  • export_datev_bookings Export im DATEV-Format (Buchungsstapel) · lesen · liest

    The EXTF Buchungsstapel of a tax year for one property (or all, when none has its own DATEV client): Windows-1252, header with the advisor's values, Festschr…

  • get_datev_settings DATEV-Angaben und Kontenzuordnung · lesen · liest

    The values for the Export im DATEV-Format (EXTF Buchungsstapel) as on the page Steuer → Steuerberater-Paket: advisorNumber (Beraternummer 1001–9999999), clie…

  • set_datev_settings DATEV-Angaben speichern · schreiben · ändert oder entfernt

    Saves the advisor's values for the Export im DATEV-Format.

  • list_unit_usage Nutzung und Aufteilung · lesen · liest

    Tax setup of a property for Anlage V: taxSplitEnabled (off = every unit counts as let, usage periods and the split key are not applied; the ortsübliche Miete…

  • list_depreciation AfA · lesen · liest

    Documented depreciation (AfA) records of a property with history.

  • list_afa_candidates Belege für die AfA · lesen · liest

    Booked invoice lines of a property whose tax category is depreciated (Bewegliche Wirtschaftsgüter, Anschaffungs-/Herstellungskosten) and that have no AfA rec…

  • get_acquisition_cost_tracker 15-%-Grenze (anschaffungsnahe Kosten) · lesen · liest

    Tracker for anschaffungsnahe Herstellungskosten (§ 6 Abs. 1 Nr. 1a EStG) of a property: maintenance invoice lines (tax categories Erhaltungsaufwand and Erhal…

  • add_tax_adjustment Steuer-Korrektur · schreiben · legt an

    Adds an append-only correction (cents, with reason) to a tax cockpit line.

  • add_depreciation_record AfA eintragen · schreiben · legt an

    Records an AfA value with its source: either the entered annual amount (e.g. from the tax advisor's AfA list), or for a single asset basisCents + acquiredOn …

  • adopt_afa_candidate AfA aus Beleg übernehmen · schreiben · legt an

    Turns an invoice line from list_afa_candidates into a confirmed linear AfA: basis = gross amount of the line, start = acquisition month, useful life = the su…

  • change_depreciation_record AfA ändern · schreiben · ändert oder entfernt

    New AfA amount from a year: ends the old record, starts a new one with its source.

  • set_afa_record_unit AfA-Eintrag einer Einheit zuordnen · schreiben · ändert oder entfernt

    Says which unit of the property a single asset belongs to (afaKind movable or other, e.g. the kitchen of one flat), or null for the whole property.

  • confirm_depreciation_record AfA bestätigen · schreiben · ändert oder entfernt

    Confirms a suggestion or the yearly 'values unchanged'.

  • discard_afa_suggestion AfA-Vorschlag verwerfen · schreiben · ändert oder entfernt

    Discards an open AfA suggestion (status suggested, e.g. from the web app's 'KI vorschlagen'); its invoice line waits for AfA again in list_afa_candidates.

  • end_depreciation_record AfA beenden · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Ends an AfA record after a year (sale, fully depreciated).

  • void_depreciation_record AfA-Fehleintrag stornieren · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Voids an AfA record entered by mistake: it is ended before its first year, so it counts in no year (confirmed records are never deleted).

  • set_acquisition_cost_line Rechnung für die 15-%-Grenze ein- oder ausschließen · schreiben · ändert oder entfernt

    Takes an invoice line (maintenance or building work booked über AfA) out of the 15 % count of get_acquisition_cost_tracker (excluded true, optional reason, e…

  • set_acquisition_cost_basis Gebäudewert für die 15-%-Grenze setzen · schreiben · ändert oder entfernt

    Sets the user's own building value (Anschaffungskosten des Gebäudes without land, in cents) that the 15 % limit of get_acquisition_cost_tracker is computed f…

  • set_acquisition_cost_visibility 15-%-Tracker ein- oder ausblenden · schreiben · ändert oder entfernt

    Shows or hides the 15 % tracker of a property on the property card and the AfA page: hidden (e.g. inherited or gifted property, or no longer of interest), sh…

  • set_unit_usage Nutzung einer Einheit eintragen · schreiben · ändert oder entfernt

    Records how a unit is used on days without a lease, from a day on (optionally until a last day): self-used, used for own business, left free of charge to a r…

  • end_unit_usage Nutzung beenden · schreiben · ändert oder entfernt

    Ends a usage period of a unit on a last day (it can only get shorter), e.g. when the owner moves out before the unit is let again.

  • delete_unit_usage Nutzung löschen · schreiben · ändert oder entfernt

    Deletes a usage period entered by mistake (ids from list_unit_usage).

  • confirm_unit_usage Nutzung bestätigen · schreiben · ändert oder entfernt

    Confirms a usage period that ZeroImmo took over from a unit marked as not lettable (source lettable_migration, confirmed false); afterwards the tax overview …

  • set_unit_usage_persons Personen einer selbst genutzten Wohnung · schreiben · ändert oder entfernt

    Sets the persons of the household that uses a flat without a lease (own use, left to a relative or someone else), on an existing usage period (list_unit_usage).

  • set_tax_split_enabled Steuerliche Aufteilung ein/aus · schreiben · ändert oder entfernt

    Switches the usage split of a property for the Anlage V on or off (ADR-0092).

  • set_tax_assessed_share Anteil laut Steuerbescheid · schreiben · ändert oder entfernt

    Records the share of the Werbungskosten the Finanzamt recognised for a property and tax year, as the user reads it from the tax assessment (basis points: 800…

  • delete_tax_assessed_share Anteil laut Steuerbescheid löschen · schreiben · ändert oder entfernt

    Deletes the share recorded from the tax assessment of a property and year; the computed usage split counts again for that year.

  • set_property_tax_details Angaben für die Anlage V · schreiben · ändert oder entfernt

    Sets the master data of a property that only the Anlage V needs (lines 6–8 of the form): Aktenzeichen laut Grundsteuermessbescheid, date of the notarial purc…

  • set_property_tax_attribution Zeile 86: Aufteilung auf Person A und B · schreiben · ändert oder entfernt

    Records how the result of a property (Anlage V line 85, before the § 21 Abs. 2 cut) is attributed to person A and person B in line 86, e.g. spouses who own i…

  • delete_property_tax_attribution Zeile 86: Aufteilung löschen · schreiben · ändert oder entfernt

    Deletes the line 86 entry of a property that starts in fromYear; the earlier entry (or person A alone) applies again from that year.

  • set_tax_split_key Aufteilungsschlüssel (Steuer) · schreiben · ändert oder entfernt

    Sets the key that splits building-wide costs, AfA and trips between let and other use, from a day on: area (default; living area for flats and houses, usable…

  • set_market_rent Ortsübliche Miete eintragen · schreiben · ändert oder entfernt

    Records the ortsübliche Miete of a unit from a day on, as the user determined it: the cold rent per month (or per m², converted with the unit's area) plus th…

  • set_lease_related_party Vermietung an Angehörige · schreiben · ändert oder entfernt

    Marks a lease as let to a relative or another related party (or removes the mark), with an internal note.

  • declare_rent_prognosis Totalüberschussprognose erklären · schreiben · legt an

    Records the result of a Totalüberschussprognose for a lease marked as related party and a tax year, as the user or the tax advisor states it (positive, negat…

Schreiben, Mahnwesen, Indexmiete

  • get_dunning_proposals Mahnvorschläge · lesen · liest

    Leases with open items past due and the next dunning step (payment_reminder → dunning_1 → dunning_2); list_dunning_cases shows the same cases with state, las…

  • list_letters Schreiben eines Mietvertrags · lesen · liest

    Letters to the tenants of a lease, newest first: kind (payment_reminder, dunning_1, dunning_2, rent_increase, prepayment_adjustment, termination_confirmation…

  • create_letter Schreiben erstellen · schreiben · ändert oder entfernt

    Creates a letter to the tenants as a PDF draft (see get_letter_preview, update_letter_draft).

  • get_letter_preview Brief-Vorschau ansehen · lesen · liest

    One letter as it will be sent: state (draft, on_its_way, sent), the printed text (subject, salutation, paragraphs, table rows, total, text after the table, g…

  • update_letter_draft Briefentwurf ändern · schreiben · ändert oder entfernt

    Changes the text of a letter that is still a draft (not sent, not on its way by post) and renders a new PDF.

  • delete_letter_draft Briefentwurf löschen · schreiben · ändert oder entfernt

    Deletes a letter that was never sent (a draft): it disappears from the lists, its PDF is withdrawn (kept in the document hash chain), an index rent letter's …

  • convert_letter_to_custom Als freien Brief weiterbearbeiten · schreiben · ändert oder entfernt

    Turns a draft of a dunning letter, rent increase request, prepayment adjustment or termination confirmation into a free letter (kind custom) to the lease's t…

  • resolve_letter_mail_review E-Mail-Versand eines Schreibens klären · schreiben · ändert oder entfernt

    Settles a letter in state mail_unclear (get_letter_preview): an e-mail of it was started but its sending was never recorded (e.g. the mail service timed out)…

  • mark_letter_sent Schreiben als versendet erfassen · schreiben · ändert oder entfernt

    Records that a letter went out by post or was handed over, on a day (not in the future).

  • list_letter_templates Briefvorlagen auflisten · lesen · liest

    The account's own letter templates (Vorlagen: id, name, subject, body, revision, updatedAt) and ZeroImmo' neutral starter templates (id starter:<slug>, e.g. …

  • get_letter_template Briefvorlage ansehen · lesen · liest

    One letter template with its full subject and body: an own one (also archived) by UUID, or a starter template by key (starter:<slug>).

  • save_letter_template Briefvorlage speichern · schreiben · ändert oder entfernt

    Creates an own letter template (without templateId) or changes one (templateId, optionally revision from get_letter_template: refused when it was saved in be…

  • archive_letter_template Briefvorlage archivieren · schreiben · ändert oder entfernt

    Archives an own letter template: it leaves the lists (list_letter_templates includeArchived still shows it) and can no longer be changed; letters created wit…

  • render_letter_template Briefvorlage für Empfänger füllen · lesen · liest

    Fills a template (templateId) or a given subject/body with the data of a recipient, exactly as create_letter (kind custom) would print it; nothing is stored.

  • send_letter_by_email Schreiben per E-Mail senden · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · versendet an Dritte

    Mails a created letter (list_letters) once as the archived PDF to the tenants' e-mail addresses and records it as sent.

  • send_letter_by_post Schreiben per Post senden · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · versendet an Dritte

    Sends a created letter (list_letters) once by post through ZeroImmo' print service (briefsenden, Deutsche Post) to the tenants' address: channel letter (plai…

  • list_letter_dispatches Briefversand (Versandprotokoll) · lesen · liest

    The send log of the account's letters, newest first: every letter by post through ZeroImmo (with channel letter/einwurf/einschreiben/rueckschein, price in ce…

  • get_letter_dispatch Brief per Post (Details) · lesen · liest

    One letter by post sent through ZeroImmo: the letter's kind and date (letterIssuedOn), recipient address as sent, channel, price and refund (cents), status a…

  • export_letter_dispatches Briefversand exportieren (CSV) · lesen · liest

    The send log (list_letter_dispatches) as CSV text for a spreadsheet or the landlord's records: all rows matching the filters, newest first, not paged, at mos…

  • resolve_letter_dispatch_review Brief per Post: Klärung entscheiden · schreiben · ändert oder entfernt

    Decides a letter by post in status review (Klärung nötig: the print service never confirmed the order within a day, so ZeroImmo neither refunded nor counted …

  • list_dunning_cases Mahnwesen: Mahnfälle · lesen · liest

    The dunning cases of the account, the same rows as the page Mahnwesen: one per lease with open rent past due, oldest due first.

  • get_dunning_case Mahnwesen: Mahnfall ansehen · lesen · liest

    One dunning case of a lease: the row as in list_dunning_cases, the open items (proven true/false, interestCents up to today), all dunning letters of the case…

  • mark_dunning_case_resolved Mahnfall als geklärt markieren · schreiben · ändert oder entfernt

    Marks a dunning case as settled outside the app (e.g. paid in cash, an agreement), with a short reason: the open items past due leave the case and no letter …

  • reopen_dunning_case Mahnfall wieder öffnen · schreiben · ändert oder entfernt

    Ends the 'geklärt' of a lease's dunning case (mark_dunning_case_resolved): its open items are part of the case again and the next step is proposed.

  • book_dunning_charges Mahnkosten/Zinsen als Forderung buchen · schreiben · legt an

    Books the Mahnkosten and Verzugszinsen shown in a dunning letter (create_letter with feeCents/interest) as charges on the lease's rent account (component oth…

  • export_dunning_file Mahnakte herunterladen · lesen · liest

    The dunning file of a lease for a lawyer or later a collection agency (ZIP): the dunning letter PDFs of the case as archived, the Versandnachweis PDF of each…

  • list_index_rent_status Indexmieten: Übersicht · lesen · liest

    Every running index lease (Indexmiete, § 557b BGB) of the account, the same rows as the page Bestand → Indexmieten: tenants, terms (start index month and val…

  • get_index_rent_calculation Indexmiete: Berechnung · lesen · liest

    The index rent calculation of one lease: the row of list_index_rent_status plus every adjustment so far (history, newest first, with letter documentId, sent/…

  • set_lease_index_terms Indexdaten des Mietvertrags speichern · schreiben · ändert oder entfernt

    Saves the index clause of an index lease as the contract states it: startIndexMonth (YYYY-MM, e.g. the month of the lease start), startIndexValue as printed …

  • create_index_rent_letter Indexmiete: Schreiben erstellen · schreiben · legt an

    Creates the Mietanpassung nach § 557b BGB for an index lease as a PDF (Textform, no signature) to all tenants of the lease: both VPI values with months, the …

  • snooze_index_rent_reminder Indexmiete: Erinnerung zurückstellen · schreiben · ändert oder entfernt

    mode snooze = 'Nicht jetzt': no index rent reminder for this lease for three months, the open proposal (also an unsent letter) is set aside; off = 'nicht meh…

  • get_index_values Verbraucherpreisindex (VPI) · lesen · liest

    The official monthly Verbraucherpreisindex für Deutschland (Destatis table 61111-0002, final values only) as ZeroImmo stores them: per base year (today 2020 …

Aufgaben und Verlauf

  • list_open_tasks Offene Aufgaben · lesen · liest · Werkzeug

    Open tasks and deadlines, earliest first.

  • get_timeline Verlauf · lesen · liest

    Timeline (events, notes, sent statements, address changes of a person) of a property, unit, person, lease or document. leaseId: the lease an entry is about, …

  • create_task Aufgabe anlegen · schreiben · legt an

    Creates a task, optionally linked to an entity.

  • update_task Aufgabe ändern · schreiben · ändert oder entfernt

    Changes a task created by hand (create_task): title, description, dueOn, priority or its reference (ref replaces it; null removes it, null description or due…

  • set_task_status Aufgabe erledigen · schreiben · ändert oder entfernt

    Sets a task to open, done or dismissed.

  • add_note Notiz · schreiben · legt an

    Adds a note or call to the timeline of an entity.

Reisekosten

  • list_trips Reisen · lesen · liest

    Trips for the rental business, newest first: date, purpose, general (true: a general trip spread over all rental units when saved; its shares are in allocati…

  • get_trip Reise mit Strecken und Kosten · lesen · liest

    One trip: purpose, property (null: no direct property), departure and return, legs (mode, stops, km), kilometre and meal allowance, its costs (tickets, hotel…

  • create_trip Reise erfassen · schreiben · legt an

    Records one trip (Reisekosten, ADR-0089). propertyId (+ unitId), or null for no direct property (the viewing of a property to buy; such a trip counts in no A…

  • update_trip Reise ändern · schreiben · ändert oder entfernt

    Replaces a trip's data and legs with `trip` (same fields as create_trip); its costs stay.

  • apply_invoice_split_to_trip Reise wie die Rechnung aufteilen · schreiben · ändert oder entfernt

    The trip takes the split its invoice has today (ADR-0208): one property on the invoice = that property (and unit); several = the same properties and units wi…

  • delete_trip Reise löschen · schreiben · ändert oder entfernt

    Permanently deletes a wrongly recorded trip (cannot be undone).

  • add_trip_expense Kosten zu einer Reise hinzufügen · schreiben · legt an

    A cost of a trip: kind train, flight, public_transport, taxi, rental_car, hotel, parking or other; amountCents gross (with an invoice its gross amount by def…

  • delete_trip_expense Kosten von einer Reise entfernen · schreiben · ändert oder entfernt

    Removes a cost from its trip (an uploaded receipt and an invoice stay as they are).

  • calculate_route Strecke berechnen · schreiben · ändert oder entfernt

    Driving distance through the stops of one car or motorcycle leg in order (Mapbox), e.g. ["Zuhause", "Bauhaus Balingen", "Lindenhaus", "Zuhause"]. "Zuhause" i…

  • get_travel_report Reisekostenabrechnung eines Jahres · lesen · liest

    Travel costs of a calendar year: all trips with legs, kilometre and meal allowance and their costs (tickets, hotel, parking), travel invoices not yet added t…

  • list_travel_places Gemerkte Orte für Reisen · lesen · liest

    The start address "Zuhause" (kind home) and saved places (kind saved, e.g. "Bauhaus Balingen"; places picked in the web form are saved automatically) used by…

  • save_travel_place Ort für Reisen speichern · schreiben · ändert oder entfernt

    kind "home" sets or replaces the start address "Zuhause" (label is ignored); kind "saved" stores a named place (a name that exists is updated).

  • delete_travel_place Gemerkten Ort löschen · schreiben · ändert oder entfernt

    Deletes a saved place (trips keep their stops as text).

Kauf: Kaufpreisaufteilung (BMF), Restnutzungsdauer und Gebäudecheck

  • list_building_checks Gebäudechecks auflisten · lesen · liest

    The account's Digitaler Gebäudecheck orders, newest first: id, label, status (awaiting_payment, open = photos can be uploaded in the web app, submitted = bei…

  • get_building_check_report Zustandsbericht eines Gebäudechecks lesen · lesen · liest

    The Zustandsbericht of a finished Gebäudecheck (status done) as Markdown in a fixed eight-chapter structure (summary, building and risk profile, findings by …

  • get_purchase_price_split_options Kaufpreisaufteilung: Grundstücksarten und Bodenrichtwert-Portale · lesen · liest

    Everything needed before preview_purchase_price_split: the release of the BMF Arbeitshilfe used (version, publication, expiry), the Grundstücksarten with the…

  • get_purchase_price_split_prefill Kaufpreisaufteilung aus einer Immobilie vorbereiten · lesen · liest

    Suggestions for a purchase price split of one property on its purchase date (acquired_on, else today): state and land value portal from the postal code, Grun…

  • preview_purchase_price_split Kaufpreis auf Gebäude und Grund und Boden aufteilen · lesen · liest

    Calculates the split of a purchase price into building (depreciable) and land after the BMF Arbeitshilfe zur Aufteilung eines Grundstückskaufpreises, without…

  • save_purchase_price_split Kaufpreisaufteilung speichern · schreiben · legt an

    Calculates and saves a purchase price split under a name (label), optionally linked to a property (propertyId).

  • list_purchase_price_splits Gespeicherte Kaufpreisaufteilungen · lesen · liest

    Saved purchase price splits, newest first, optionally of one property: name, method, building share, split in cents, table version and day of creation.

  • get_purchase_price_split Gespeicherte Kaufpreisaufteilung mit Rechenweg · lesen · liest

    One saved purchase price split: summary, the stored input, the result recomputed with the stored table version (The result follows the BMF Arbeitshilfe step …

  • delete_purchase_price_split Kaufpreisaufteilung löschen · schreiben · ändert oder entfernt

    Deletes a saved purchase price split.

  • get_rnd_prefill Restnutzungsdauer: Werte einer Immobilie · lesen · liest

    Suggestions for preview_remaining_useful_life from one property: propertyKind (condominium, single_family, multi_family; null for other types), yearBuilt, ad…

  • preview_remaining_useful_life Restnutzungsdauer schätzen (Indikation) · lesen · liest

    Indication of the Restnutzungsdauer of a residential building after the model of ImmoWertV 2021, Anlage 2 (Gesamtnutzungsdauer 80 years), from its kind, year…

  • list_rnd_requests Restnutzungsdauer: Anfragen an gutachten.org · lesen · liest

    Lists the owner's requests for the free Ersteinschätzung of the Restnutzungsdauer that ZeroImmo passed to the partner gutachten.org, newest first: per reques…

Konto und Kontingente

  • get_usage Verbrauch und Kontingente · lesen · liest

    Usage and quotas of the account: storage in bytes (every stored file, generated PDFs and withdrawn documents included; only uploads are refused when full), t…

  • revoke_my_token Eigenen Zugang widerrufen · schreiben · ändert oder entfernt

    Revokes the access this call is made with (the token or the app connection), nothing else; takes no arguments: every later call with it is refused (401).

  • start_account_export Konto vollständig exportieren · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Prepares an owner-only export of all account tables and stored files, including original personal data, as ZIP parts.

  • get_account_export_part Kontoexport herunterladen · rechtlich wirksam (Freigabe im Chat oder Web; Vollzugriff separat) · ändert oder entfernt

    Returns a 60-second signed download URL of a ZIP part from start_account_export.

  • leave_feedback Feedback an ZeroImmo senden · schreiben · legt an

    Forwards the user's feedback about ZeroImmo or its AI to the ZeroImmo team: their own words in message (as they said them, no other people's data) and/or a r…

Community (Forum)

  • list_forum_categories Forum: Kategorien · lesen · liest

    Categories of the ZeroImmo community forum with description, topic count and whether only the ZeroImmo team may open topics there.

  • list_forum_topics Forum: Themen · lesen · liest Beiträge anderer Mitglieder

    Published topics, pinned first; optionally of one category (categorySlug from list_forum_categories). sort: latest (default, by latest activity), popular (to…

  • get_forum_topic Forum: Thema lesen · lesen · liest Beiträge anderer Mitglieder

    A topic with its posts (paged).

  • search_community Community durchsuchen · lesen · liest Beiträge anderer Mitglieder

    Full-text search (German) over published forum topics and posts.

  • get_community_rules Community-Regeln · lesen · liest

    The current community rules (Markdown) with their version.

  • get_my_community_profile Eigenes Community-Profil · lesen · liest

    The user's community profile (nickname, rules accepted, status), their Kekse (community points: status only, no money value, not transferable or redeemable),…

  • get_my_kekse_history Eigene Kekse: Verlauf · lesen · liest

    The user's own Kekse history, newest first and paged: date, delta, reason code (post_liked, suggestion_planned, suggestion_done, admin_adjustment, reversal, …

  • create_forum_topic Forum: Thema eröffnen · schreiben · schreibt Beiträge für andere Mitglieder

    Opens a topic with its first post (Markdown) in a category, as the user and labelled „über Agent“; it is public at once.

  • reply_to_forum_topic Forum: Antworten · schreiben · schreibt Beiträge für andere Mitglieder

    Replies to an open topic (Markdown), as the user and labelled „über Agent“.

  • edit_my_post Forum: Eigenen Beitrag ändern · schreiben · ändert, was andere sehen

    Replaces the text (Markdown) of one of the user's own posts (postId from get_forum_topic: a post with own and editable true) within 24 hours after it was wri…

  • delete_my_post Forum: Eigenen Beitrag löschen · schreiben · ändert, was andere sehen

    Deletes one of the user's own posts (postId from get_forum_topic: a post with own true) within 24 hours after it was written; older posts the user deletes on…

  • report_community_content Community: Inhalt melden · schreiben · meldet an die Moderation

    Reports a post, topic or member profile to the moderation (reason: illegal, child_sexual_abuse, rules, spam, personal_data, other).

  • update_my_community_profile Community-Profil ändern · schreiben · ändert, was andere sehen

    Changes the federal state (BW, BY, BE, … as code) and „Vermieter seit“ (year) of the user's public profile.

  • list_improvement_suggestions Verbesserungsvorschläge · lesen · liest Beiträge anderer Mitglieder

    Improvement suggestions for ZeroImmo with status (open, planned, in_progress, done, declined with the team's reason) and votes; sorted by votes or new, optio…

  • submit_improvement_suggestion Verbesserung vorschlagen · schreiben · schreibt Beiträge für andere Mitglieder

    Suggests an improvement to ZeroImmo (title and Markdown text), as the user and labelled „über Agent“.

  • vote_improvement_suggestion Für einen Vorschlag stimmen · schreiben · ändert, was andere sehen

    Votes for an improvement suggestion (vote true) or takes the vote back (vote false); one vote per member, only while the suggestion is open, planned or in pr…