Zum Inhalt springen
immoGenio.

KI-Zugang · Tool-Katalog

Was ein KI-Assistent in immoGenio tun darf — Tool für Tool.

Der MCP-Server unter mcp.immogenio.de stellt 361 Tools bereit. Hier steht jedes einzelne: ob es liest, schreibt oder löscht, welche Berechtigung es verlangt und welche Parameter es nimmt. Der Katalog entsteht aus dem Quelltext des Servers — was hier steht, ist das, was Claude oder ChatGPT beim Verbinden sehen.

Zum KatalogJSON

Stand 20. November 2026

Tools gesamt
361
lesend
166
schreibend
185
löschend
10

Jedes Tool ruft genau einen Endpunkt der Partner-API. Die Rechte prüft die API, nicht das Modell.

immoGenio Cockpit · KI-Zugang (MCP)

Tool-Katalog

361 Tools — 166 lesend, 185 schreibend, 10 löschend · Stand 20. November 2026 · www.immogenio.de/funktionen/mcp-server-ki-agenten/tools/

[00]Lesart

Zwei Wege, eine Prüfung

Persönlich

Anmeldung mit dem immoGenio-Konto, Freigabe unter Mein Konto › KI verbinden. Der Assistent darf höchstens, was der Mensch selbst im jeweiligen Mandanten darf — einschließlich seiner Objekt- und Einheitengrenze. Freigegeben wird eine KI-Stufe:

  • Lesen — Bestand ohne Kontaktdaten
  • Lesen mit Kontaktdaten — zusätzlich E-Mail, Telefon, Anschrift
  • Bearbeiten — anlegen, ändern, löschen, Vorgänge schalten

Als Token

Ein Zugangsschlüssel unter Einstellungen › Integrationen › API-Zugänge, für Agenten ohne Anmeldung. Er trägt einzeln gewählte Berechtigungen — die Spalte „Berechtigung“ unten nennt sie je Tool. Handlungen, die für einen Menschen stehen, gehen nie über ein Token.

Status werden nie als Feld gesetzt, sondern über geprüfte Workflow-Übergänge, mit denselben Regeln wie in der Oberfläche. Bank- und Steuerdaten von Personen gibt keine Schnittstelle heraus.

361 Tools

[01]18 Tools

Zugang, Mandanten und Einrichtung

mandanten_auflistenLesenListet die Mandanten (WEGs, Eigentümer, Betrieb), auf die dieser Zugang zugreifen darf — je mit ID und Name.jeder Zugang

GET /api/v1/partner/mandanten

Listet die Mandanten (WEGs, Eigentümer, Betrieb), auf die dieser Zugang zugreifen darf — je mit ID und Name. Die ID ist der Parameter mandant aller anderen Tools. Zuerst aufrufen, wenn nicht klar ist, um welche Gemeinschaft oder welchen Eigentümer es geht. leistungsumfang heizkosten heißt: Heizkosten-Mandant eines fremd verwalteten Hauses — dort gibt es nur Haus, Einheiten, Zähler, Nutzer, Meldungen, Aufgaben, Dokumente und Heizkosten; alles andere antwortet mit 403 (Code leistungsumfang).

mandant_anlegenSchreibenLegt im Unternehmen des angefragten Mandanten einen neuen Mandanten an — immer mit seinem ersten Objekt, ein Mandant ohne Objekt entsteht nicht.Mandant:CreateBearbeiten

POST /api/v1/partner/mandanten

Legt im Unternehmen des angefragten Mandanten einen neuen Mandanten an — immer mit seinem ersten Objekt, ein Mandant ohne Objekt entsteht nicht. mandant_art: weg (Eigentümergemeinschaft; das Objekt wird eine WEG), eigentuemer (ein Eigentümer als Kunde), eigener_bestand (der eigene Bestand der Verwaltung, gibt es je Unternehmen nur einmal), eigene_gesellschaft (eigener Bestand einer eigenen Gesellschaft). Die Antwort nennt die id des Mandanten (danach Parameter mandant der anderen Tools), objektNr und herkunft: neu, platzhalter_uebernommen (ein leerer Mandant aus der Registrierung wurde übernommen und behält seine id) oder eigener_vorhanden (das Objekt liegt im vorhandenen eigenen Bestand). erreichbar=false heißt: Dieser Zugang erreicht den neuen Mandanten nicht. Zählt gegen das Mandantenkontingent des Tarifs — erschöpft: 402 mit Link zum Tarif. Nur, wer zum Team des Unternehmens gehört (sonst 403). Ein persönlicher Zugang braucht die Freigabe für alle Mandanten (sonst 409), ein Token „alle Mandanten des Betriebs" (sonst 403). Ein vorhandenes Objekt umziehen und die Buchhaltung einschalten geht nur im Portal. Braucht Mandant:Create.

Parameter von mandant_anlegen
ParameterTypBeschreibung
mandant_art Pflichtweg | eigentuemer | eigener_bestand | eigene_gesellschaftWem der Bestand gehört.
name PflichtstringName des Mandanten, z. B. "WEG Am Park 2–14" oder "Anna Muster".
strassestringAnschrift des Mandanten (z. B. eines Eigentümers); bei einer WEG meist leer.
plzstringPostleitzahl, fünfstellig.
ortstringOrt.
inhaberobjectNur bei eigentuemer und eigene_gesellschaft: wem der Bestand gehört. Daraus entsteht der Inhaber des Mandanten (ein Eigentümer im neuen Mandanten), der Name des Mandanten folgt ihm. Ohne Angabe bleibt der Inhaber offen und wird im Portal eingetragen. Eine GbR ist firma, Eheleute und Erben sind gemeinschaft.
objekt PflichtobjectDas erste Objekt.
unternehmen_einrichtenSchreibenRichtet ein Unternehmen ohne Team ein: Der angemeldete Mensch trägt sich als Inhaber ein und legt fest, was das Unternehmen ist (persona) und für wen es verwaltet — wie im Dialog „Neuer Mandant" des Portals.Betrieb:EinrichtenBearbeiten · nur persönlich

POST /api/v1/partner/betrieb/einrichten

Richtet ein Unternehmen ohne Team ein: Der angemeldete Mensch trägt sich als Inhaber ein und legt fest, was das Unternehmen ist (persona) und für wen es verwaltet — wie im Dialog „Neuer Mandant" des Portals. Nur über den persönlichen KI-Zugang, nie mit einem Token (403 nur_persoenlich); nur für System-Administratoren und nur, solange das Unternehmen des angefragten Mandanten niemanden im Team hat (sonst 403 bzw. 409 „schon eingerichtet"). Danach Mandanten anlegen (mandant_anlegen) und einrichtung_abschliessen. Braucht Betrieb:Einrichten.

Parameter von unternehmen_einrichten
ParameterTypBeschreibung
persona Pflichtverwalter | vermieterverwalter: eine Hausverwaltung; vermieter: ein Eigentümer, der selbst vermietet.
verwalter_subListe (miet | weg | sev)Verwaltungsarten — Pflicht für Verwalter, die für Kunden verwalten.
verwaltet_fuerListe (fremd | eigen)fremd: für Kunden; eigen: den eigenen Bestand.
portfolio_size Pflicht1_10 | 11_50 | 51_200 | 200_plusUngefähre Zahl der verwalteten Einheiten.
einrichtung_abschliessenSchreibenSchließt die Einrichtung des Unternehmens des angefragten Mandanten ab: Die Mandanten werden für das Team frei, und die Mailadressen des Unternehmens werden eingerichtet.Betrieb:AbschliessenBearbeiten · nur persönlich

POST /api/v1/partner/betrieb/einrichtung-abschliessen

Schließt die Einrichtung des Unternehmens des angefragten Mandanten ab: Die Mandanten werden für das Team frei, und die Mailadressen des Unternehmens werden eingerichtet. Verlangt, dass jeder Mandant ein Objekt hat und — bei einer Verwaltung für Kunden — mindestens ein Kundenmandant existiert (sonst 409 mit dem Grund). Mitarbeiter lädt man danach im Portal ein. Ein zweiter Aufruf ändert nichts. Nur über den persönlichen KI-Zugang (403 nur_persoenlich) und nur für Inhaber und Administratoren des Unternehmens. Braucht Betrieb:Abschliessen.

rechtsformen_auflistenLesenListet die Gesellschaftsformen (GmbH, UG, GbR, e.K. …) je mit code und bezeichnung.jeder Zugang

GET /api/v1/partner/rechtsformen

Listet die Gesellschaftsformen (GmbH, UG, GbR, e.K. …) je mit code und bezeichnung. Der code ist der einzige zulässige Wert für das Feld rechtsform bei Eigentümern (eigentuemer_anlegen, eigentuemer_aktualisieren), Dienstleistern (dienstleister_anlegen, dienstleister_aktualisieren) und in den Firmendaten der Verwaltung (firmendaten_setzen, Block hausverwaltung). VORHER aufrufen, wenn eine Gesellschaftsform geschrieben wird: Ein Wert, der nicht in der Liste steht, wird mit 422 abgewiesen. Die Liste ist für alle Mandanten gleich und braucht keinen Scope.

objekt_loeschenSchreibenLöscht ein Objekt mit seinen Einheiten, Mietverträgen, Zählern und Darlehen; Dokumente und Aufgaben verlieren nur den Objektbezug.jeder Zugang

POST /api/v1/partner/loeschen/objekt/:objektNr

Löscht ein Objekt mit seinen Einheiten, Mietverträgen, Zählern und Darlehen; Dokumente und Aufgaben verlieren nur den Objektbezug. Gesperrt, mit Zahl und Stelle, solange Abrechnungen, Versicherungs- oder Versorgungsverträge am Objekt hängen (dann stilllegen). Läuft über die Folgenvorschau: Der erste Aufruf (ohne pruefwert) liefert nur die Vorschau — zeigen Sie dem Nutzer, was mitgelöscht wird und was die Buchhaltung betrifft, und rufen Sie dann mit dem pruefwert erneut auf. Der Datensatz liegt danach 30 Tage im Papierkorb (papierkorb_wiederherstellen). Veraltet — bitte loeschen_vorschau und loeschen mit art und id verwenden.

Parameter von objekt_loeschen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
pruefwertstringDer pruefwert aus der Vorschau. Ohne ihn wird NICHT gelöscht, sondern nur die Vorschau geliefert (was mitgelöscht wird, Buchhaltung, Frage).
anlassfalsch_angelegt | nicht_mehr_gebrauchtNur wenn die Vorschau frage_anlass meldet (Buchungen hängen daran).
einheit_loeschenSchreibenLöscht eine Einheit mit ihren Räumen, Heizkörpern, Schlüsseln, Zählern samt Ständen und Mietverträgen.jeder Zugang

POST /api/v1/partner/loeschen/einheit/:einheitId

Löscht eine Einheit mit ihren Räumen, Heizkörpern, Schlüsseln, Zählern samt Ständen und Mietverträgen. Gesperrt, mit Zahl und Stelle, solange Hausgeld-Sollstellungen, Wirtschaftsplan-Anteile, Eigentümerwechsel, Heizkosten oder Versicherungsfälle an ihr hängen (dann stilllegen). Läuft über die Folgenvorschau: Der erste Aufruf (ohne pruefwert) liefert nur die Vorschau — zeigen Sie dem Nutzer, was mitgelöscht wird und was die Buchhaltung betrifft, und rufen Sie dann mit dem pruefwert erneut auf. Der Datensatz liegt danach 30 Tage im Papierkorb (papierkorb_wiederherstellen). Veraltet — bitte loeschen_vorschau und loeschen mit art und id verwenden.

Parameter von einheit_loeschen
ParameterTypBeschreibung
einheitId PflichtstringUUID der Einheit (z. B. aus der jeweiligen Liste).
pruefwertstringDer pruefwert aus der Vorschau. Ohne ihn wird NICHT gelöscht, sondern nur die Vorschau geliefert (was mitgelöscht wird, Buchhaltung, Frage).
anlassfalsch_angelegt | nicht_mehr_gebrauchtNur wenn die Vorschau frage_anlass meldet (Buchungen hängen daran).
mieter_loeschenSchreibenLöscht einen Mieter mit seinen Mietverträgen; das Debitorkonto und die Buchhaltung bleiben (Name mit „(gelöscht)“).jeder Zugang

POST /api/v1/partner/loeschen/mieter/:mieterId

Löscht einen Mieter mit seinen Mietverträgen; das Debitorkonto und die Buchhaltung bleiben (Name mit „(gelöscht)“). Hängen Buchungen daran, ist anlass Pflicht. Läuft über die Folgenvorschau: Der erste Aufruf (ohne pruefwert) liefert nur die Vorschau — zeigen Sie dem Nutzer, was mitgelöscht wird und was die Buchhaltung betrifft, und rufen Sie dann mit dem pruefwert erneut auf. Der Datensatz liegt danach 30 Tage im Papierkorb (papierkorb_wiederherstellen). Veraltet — bitte loeschen_vorschau und loeschen mit art und id verwenden.

Parameter von mieter_loeschen
ParameterTypBeschreibung
mieterId PflichtstringUUID des Mieters (z. B. aus der jeweiligen Liste).
pruefwertstringDer pruefwert aus der Vorschau. Ohne ihn wird NICHT gelöscht, sondern nur die Vorschau geliefert (was mitgelöscht wird, Buchhaltung, Frage).
anlassfalsch_angelegt | nicht_mehr_gebrauchtNur wenn die Vorschau frage_anlass meldet (Buchungen hängen daran).
eigentuemer_loeschenSchreibenLöscht einen Eigentümer; Zuordnungen zu Objekten und Einheiten gehen mit, die Anteilshistorie bleibt für vergangene Abrechnungen.jeder Zugang

POST /api/v1/partner/loeschen/eigentuemer/:eigentuemerId

Löscht einen Eigentümer; Zuordnungen zu Objekten und Einheiten gehen mit, die Anteilshistorie bleibt für vergangene Abrechnungen. Gesperrt, solange Hausgeld-Sollstellungen, Jahresabrechnungen, Versammlungsstimmen oder ein Eigentümerwechsel am Eigentümer hängen. Läuft über die Folgenvorschau: Der erste Aufruf (ohne pruefwert) liefert nur die Vorschau — zeigen Sie dem Nutzer, was mitgelöscht wird und was die Buchhaltung betrifft, und rufen Sie dann mit dem pruefwert erneut auf. Der Datensatz liegt danach 30 Tage im Papierkorb (papierkorb_wiederherstellen). Veraltet — bitte loeschen_vorschau und loeschen mit art und id verwenden.

Parameter von eigentuemer_loeschen
ParameterTypBeschreibung
eigentuemerId PflichtstringUUID des Eigentuemers (z. B. aus der jeweiligen Liste).
pruefwertstringDer pruefwert aus der Vorschau. Ohne ihn wird NICHT gelöscht, sondern nur die Vorschau geliefert (was mitgelöscht wird, Buchhaltung, Frage).
anlassfalsch_angelegt | nicht_mehr_gebrauchtNur wenn die Vorschau frage_anlass meldet (Buchungen hängen daran).
versammlung_loeschenSchreibenLöscht eine Versammlung samt Tagesordnungspunkten, Stimmen, Vollmachten, Anwesenheiten und Dokumenten.jeder Zugang

POST /api/v1/partner/loeschen/versammlung/:id

Löscht eine Versammlung samt Tagesordnungspunkten, Stimmen, Vollmachten, Anwesenheiten und Dokumenten. Beschlüsse der Versammlung bleiben in der Beschluss-Sammlung, versandte Einladungen und Niederschriften bleiben als PDF erhalten. Gesperrt nur, solange die Versammlung online läuft. Läuft über die Folgenvorschau: Der erste Aufruf (ohne pruefwert) liefert nur die Vorschau — zeigen Sie dem Nutzer, was mitgelöscht wird und was die Buchhaltung betrifft, und rufen Sie dann mit dem pruefwert erneut auf. Der Datensatz liegt danach 30 Tage im Papierkorb (papierkorb_wiederherstellen). Veraltet — bitte loeschen_vorschau und loeschen mit art und id verwenden.

Parameter von versammlung_loeschen
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
pruefwertstringDer pruefwert aus der Vorschau. Ohne ihn wird NICHT gelöscht, sondern nur die Vorschau geliefert (was mitgelöscht wird, Buchhaltung, Frage).
anlassfalsch_angelegt | nicht_mehr_gebrauchtNur wenn die Vorschau frage_anlass meldet (Buchungen hängen daran).
beschluss_loeschenSchreibenLöscht einen Beschluss.jeder Zugang

POST /api/v1/partner/loeschen/beschluss/:id

Löscht einen Beschluss. Trägt er eine gebuchte Jahresabrechnung, wird deren Buchung der Abrechnungsspitzen zurückgenommen (außer sie ist schon geprüft oder festgeschrieben — dann zuerst die Jahresabrechnung stornieren). Wirtschaftspläne, Umlaufbeschlüsse und Selbstbehalt-Regeln, die auf dem Beschluss beruhen, sperren das Löschen mit Weg. Läuft über die Folgenvorschau: Der erste Aufruf (ohne pruefwert) liefert nur die Vorschau — zeigen Sie dem Nutzer, was mitgelöscht wird und was die Buchhaltung betrifft, und rufen Sie dann mit dem pruefwert erneut auf. Der Datensatz liegt danach 30 Tage im Papierkorb (papierkorb_wiederherstellen). Veraltet — bitte loeschen_vorschau und loeschen mit art und id verwenden.

Parameter von beschluss_loeschen
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
pruefwertstringDer pruefwert aus der Vorschau. Ohne ihn wird NICHT gelöscht, sondern nur die Vorschau geliefert (was mitgelöscht wird, Buchhaltung, Frage).
anlassfalsch_angelegt | nicht_mehr_gebrauchtNur wenn die Vorschau frage_anlass meldet (Buchungen hängen daran).
dienstleister_loeschenSchreibenLöscht einen Betrieb samt Zugängen, Dokumenten, Gewerken und Leistungen.jeder Zugang

POST /api/v1/partner/loeschen/dienstleister/:dienstleisterId

Löscht einen Betrieb samt Zugängen, Dokumenten, Gewerken und Leistungen. Angebotsanfragen bleiben als Nachweis stehen (mit dem Namen als Text), Aufträge und Angebote verlieren nur den Bezug. Gesperrt, wenn der Betrieb anderen Mandanten zugeordnet ist. Der Weg für einen Betrieb, mit dem man nicht mehr arbeitet, bleibt dienstleister_aktualisieren mit aktiv=false. Läuft über die Folgenvorschau: Der erste Aufruf (ohne pruefwert) liefert nur die Vorschau — zeigen Sie dem Nutzer, was mitgelöscht wird und was die Buchhaltung betrifft, und rufen Sie dann mit dem pruefwert erneut auf. Der Datensatz liegt danach 30 Tage im Papierkorb (papierkorb_wiederherstellen). Veraltet — bitte loeschen_vorschau und loeschen mit art und id verwenden.

Parameter von dienstleister_loeschen
ParameterTypBeschreibung
dienstleisterId PflichtstringUUID des Dienstleisters (z. B. aus der jeweiligen Liste).
pruefwertstringDer pruefwert aus der Vorschau. Ohne ihn wird NICHT gelöscht, sondern nur die Vorschau geliefert (was mitgelöscht wird, Buchhaltung, Frage).
anlassfalsch_angelegt | nicht_mehr_gebrauchtNur wenn die Vorschau frage_anlass meldet (Buchungen hängen daran).
loeschvorschau_lesenLesenZeigt, was ein Löschen mit sich nimmt, bevor etwas gelöscht wird: was mitgelöscht wird, was danach gilt, was die Buchhaltung betrifft (Forderungen, Buchungen), was erhalten bleibt, ob eine Frage zu beantworten ist (frage_anlass → anlass "falsch_angelegt" oder "nicht_mehr_gebraucht"), und den pruefwert für datensatz_loeschen.jeder Zugang

GET /api/v1/partner/loeschen/:art/:id/vorschau

Zeigt, was ein Löschen mit sich nimmt, bevor etwas gelöscht wird: was mitgelöscht wird, was danach gilt, was die Buchhaltung betrifft (Forderungen, Buchungen), was erhalten bleibt, ob eine Frage zu beantworten ist (frage_anlass → anlass "falsch_angelegt" oder "nicht_mehr_gebraucht"), und den pruefwert für datensatz_loeschen. art: mietvertrag, einheit, objekt, mieter, eigentuemer, person, dienstleister, bankkonto, zaehlerstand, mietbestandteil, versammlung, beschluss, uebergabe, dokument (Objektablage), einheit_dokument, mieter_dokument, eigentuemer_dokument (Ablage an Einheit, Mieter, Eigentümer), mieter_leistung (Leistungsnachweis eines Mieters), versicherungsfall, versicherungsvertrag, praemie (Zeile der Prämienhistorie), versicherer, makler, meldeweg, wirtschaftsplan, mahnung, nk_abrechnung, umlageschluessel, mieterhoehung, nkv_anpassung, mietpreis, darlehen, sondertilgung, kaution, schluessel, zaehler, messstelle, versorgungsvertrag (id eines Objekts ist seine Nummer, die einer Person, eines Darlehens, einer Sondertilgung, einer Mahnung eine Zahl, sonst eine UUID). Braucht den Löschscope der Art (z. B. Mietvertrag:Delete, Einheit:Delete, Bankkonto:Delete). Veraltet — bitte loeschen_vorschau und loeschen mit art und id verwenden.

Parameter von loeschvorschau_lesen
ParameterTypBeschreibung
art Pflichtversammlungsform_nachweis | weg_uebernahme | weg_uebernahme_dokument | beleg | angebot | kreditor | leistungsart | kasse | top | etv_dokument | umlaufbeschluss | umlauf_anlage | beirat_schreiben | beschluss_vermerk | eigentuemer_objekt | eigentuemer_einheit | eigentuemer_zugang | eigentuemer_mitglied | eigentuemer_vertreter | eigentuemerwechsel | verkauf | wp_position | umfrage | aushang | verwalterwechsel | briefing_empfaenger | mietvertrag | einheit | objekt | mieter | eigentuemer | person | dienstleister | bankkonto | zaehlerstand | mietbestandteil | versammlung | beschluss | dokument | wirtschaftsplan | mahnung | nk_abrechnung | umlageschluessel | mieterhoehung | nkv_anpassung | mietpreis | mietvertrag_personenzahl | darlehen | sondertilgung | kaution | schluessel | zaehler | messstelle | versorgungsvertrag | uebergabe | einheit_dokument | mieter_dokument | eigentuemer_dokument | versicherungsfall | versicherungsvertrag | praemie | versicherer | makler | meldeweg | mieter_leistung | preisstand | vertragskosten | messstellen_zuordnung | abschlagsfassung | jahresrechnung | sepa_mandat | anlage | anlage_ereignis | bauteil | instandhaltungsvorhaben | energieausweis | esg_szenario | esg_verbrauch | esg_metrik | esg_baseline | anmietung | notdienst | objektrecht | externe_ablage | pflichtnachweis | pflichtnachweis_dokument | pflichtfestlegung | fremdverwaltung | sev_einmalig | sev_abrechnung | hausmeister | hausmeister_vertrag | hausmeister_vertragsaufgabe | hausmeister_aufgabe | hausmeister_auftrag | hausmeister_erledigung | hausmeister_termin | haus_hinweis | bewohner | mieter_mitglied | notfallkontakt | staffel_stufe | staffelanpassung | indexanpassung | inserat | inserat_lead | mietvertrag_ordner | mieter_ordner | mietvertrag_dokument | kaution_abrechnung | kuendigung | mietminderung | modernisierung | untervermietung | stammdatenaenderung | mieterwechsel_antrag | schadenArt des Datensatzes.
id PflichtstringID des Datensatzes (UUID; bei einem Objekt die Objekt-Nr., bei einer Person ihre Zahl).
datensatz_loeschenSchreibenLöscht einen Datensatz mit allen Folgen in einer Transaktion; er liegt danach 30 Tage im Papierkorb (papierkorb_wiederherstellen).jeder Zugang

POST /api/v1/partner/loeschen/:art/:id

Löscht einen Datensatz mit allen Folgen in einer Transaktion; er liegt danach 30 Tage im Papierkorb (papierkorb_wiederherstellen). Ohne pruefwert wird NICHT gelöscht, sondern nur die Vorschau zurückgegeben — zeigen Sie dem Nutzer die Folgen und fragen Sie nach, bevor Sie mit dem pruefwert erneut aufrufen. Hat sich die Lage seit der Vorschau geändert, antwortet die API mit 409 vorschau_veraltet und der neuen Vorschau. Bei frage_anlass ist anlass Pflicht: "falsch_angelegt" hebt Forderungen auf (festgeschriebene Buchungen werden storniert, dazu braucht es Buchung:Storno), "nicht_mehr_gebraucht" lässt die Buchhaltung unverändert. Es geht nie mehr, als der Mensch im Portal selbst darf. Braucht den Löschscope der Art (z. B. Mietvertrag:Delete). Veraltet — bitte loeschen_vorschau und loeschen mit art und id verwenden.

Parameter von datensatz_loeschen
ParameterTypBeschreibung
art Pflichtversammlungsform_nachweis | weg_uebernahme | weg_uebernahme_dokument | beleg | angebot | kreditor | leistungsart | kasse | top | etv_dokument | umlaufbeschluss | umlauf_anlage | beirat_schreiben | beschluss_vermerk | eigentuemer_objekt | eigentuemer_einheit | eigentuemer_zugang | eigentuemer_mitglied | eigentuemer_vertreter | eigentuemerwechsel | verkauf | wp_position | umfrage | aushang | verwalterwechsel | briefing_empfaenger | mietvertrag | einheit | objekt | mieter | eigentuemer | person | dienstleister | bankkonto | zaehlerstand | mietbestandteil | versammlung | beschluss | dokument | wirtschaftsplan | mahnung | nk_abrechnung | umlageschluessel | mieterhoehung | nkv_anpassung | mietpreis | mietvertrag_personenzahl | darlehen | sondertilgung | kaution | schluessel | zaehler | messstelle | versorgungsvertrag | uebergabe | einheit_dokument | mieter_dokument | eigentuemer_dokument | versicherungsfall | versicherungsvertrag | praemie | versicherer | makler | meldeweg | mieter_leistung | preisstand | vertragskosten | messstellen_zuordnung | abschlagsfassung | jahresrechnung | sepa_mandat | anlage | anlage_ereignis | bauteil | instandhaltungsvorhaben | energieausweis | esg_szenario | esg_verbrauch | esg_metrik | esg_baseline | anmietung | notdienst | objektrecht | externe_ablage | pflichtnachweis | pflichtnachweis_dokument | pflichtfestlegung | fremdverwaltung | sev_einmalig | sev_abrechnung | hausmeister | hausmeister_vertrag | hausmeister_vertragsaufgabe | hausmeister_aufgabe | hausmeister_auftrag | hausmeister_erledigung | hausmeister_termin | haus_hinweis | bewohner | mieter_mitglied | notfallkontakt | staffel_stufe | staffelanpassung | indexanpassung | inserat | inserat_lead | mietvertrag_ordner | mieter_ordner | mietvertrag_dokument | kaution_abrechnung | kuendigung | mietminderung | modernisierung | untervermietung | stammdatenaenderung | mieterwechsel_antrag | schadenArt des Datensatzes.
id PflichtstringID des Datensatzes (UUID; bei einem Objekt die Objekt-Nr., bei einer Person ihre Zahl).
pruefwertstringDer pruefwert aus loeschvorschau_lesen. Ohne ihn wird nur die Vorschau geliefert.
anlassfalsch_angelegt | nicht_mehr_gebrauchtNur wenn die Vorschau frage_anlass meldet.
loeschen_vorschauLesenZeigt, was ein Löschen mit sich nimmt, bevor etwas gelöscht wird — für jede Art mit demselben Aufruf: was mitgelöscht wird, was danach gilt, was die Buchhaltung betrifft, was erhalten bleibt, ob eine Frage zu beantworten ist (frage_anlass → anlass "falsch_angelegt" oder "nicht_mehr_gebraucht"), ob der Name einzutippen ist, und den pruefwert für loeschen.jeder Zugang

GET /api/v1/partner/loeschen/:String/:encodeURIComponent/vorschau

Zeigt, was ein Löschen mit sich nimmt, bevor etwas gelöscht wird — für jede Art mit demselben Aufruf: was mitgelöscht wird, was danach gilt, was die Buchhaltung betrifft, was erhalten bleibt, ob eine Frage zu beantworten ist (frage_anlass → anlass "falsch_angelegt" oder "nicht_mehr_gebraucht"), ob der Name einzutippen ist, und den pruefwert für loeschen. Die Art bestimmt den Scope (z. B. Mietvertrag:Delete, Uebergabe:Delete) und das Portal-Recht dahinter; id: bei einem Objekt die Nummer, bei einer Person, Übergabe, einem Darlehen oder einer Mahnung eine Zahl, sonst eine UUID. Unterschriebene Übergaben lassen sich löschen; die Vorschau sagt, dass die Parteien das Protokoll als PDF haben.

Parameter von loeschen_vorschau
ParameterTypBeschreibung
art Pflichtversammlungsform_nachweis | weg_uebernahme | weg_uebernahme_dokument | beleg | angebot | kreditor | leistungsart | kasse | top | etv_dokument | umlaufbeschluss | umlauf_anlage | beirat_schreiben | beschluss_vermerk | eigentuemer_objekt | eigentuemer_einheit | eigentuemer_zugang | eigentuemer_mitglied | eigentuemer_vertreter | eigentuemerwechsel | verkauf | wp_position | umfrage | aushang | verwalterwechsel | briefing_empfaenger | mietvertrag | einheit | objekt | mieter | eigentuemer | person | dienstleister | bankkonto | zaehlerstand | mietbestandteil | versammlung | beschluss | dokument | wirtschaftsplan | mahnung | nk_abrechnung | umlageschluessel | mieterhoehung | nkv_anpassung | mietpreis | mietvertrag_personenzahl | darlehen | sondertilgung | kaution | schluessel | zaehler | messstelle | versorgungsvertrag | uebergabe | einheit_dokument | mieter_dokument | eigentuemer_dokument | versicherungsfall | versicherungsvertrag | praemie | versicherer | makler | meldeweg | mieter_leistung | preisstand | vertragskosten | messstellen_zuordnung | abschlagsfassung | jahresrechnung | sepa_mandat | anlage | anlage_ereignis | bauteil | instandhaltungsvorhaben | energieausweis | esg_szenario | esg_verbrauch | esg_metrik | esg_baseline | anmietung | notdienst | objektrecht | externe_ablage | pflichtnachweis | pflichtnachweis_dokument | pflichtfestlegung | fremdverwaltung | sev_einmalig | sev_abrechnung | hausmeister | hausmeister_vertrag | hausmeister_vertragsaufgabe | hausmeister_aufgabe | hausmeister_auftrag | hausmeister_erledigung | hausmeister_termin | haus_hinweis | bewohner | mieter_mitglied | notfallkontakt | staffel_stufe | staffelanpassung | indexanpassung | inserat | inserat_lead | mietvertrag_ordner | mieter_ordner | mietvertrag_dokument | kaution_abrechnung | kuendigung | mietminderung | modernisierung | untervermietung | stammdatenaenderung | mieterwechsel_antrag | schadenArt des Datensatzes.
id PflichtstringID des Datensatzes (UUID; bei einem Objekt die Objekt-Nr., bei Person, Übergabe, Darlehen, Mahnung eine Zahl).
loeschenSchreibenLöscht einen Datensatz beliebiger Art mit allen Folgen in einer Transaktion; er liegt danach 30 Tage im Papierkorb (papierkorb_wiederherstellen).jeder Zugang

POST /api/v1/partner/loeschen/:String/:encodeURIComponent

Löscht einen Datensatz beliebiger Art mit allen Folgen in einer Transaktion; er liegt danach 30 Tage im Papierkorb (papierkorb_wiederherstellen). Ohne pruefwert wird NICHT gelöscht, sondern nur die Vorschau zurückgegeben — zeigen Sie dem Nutzer die Folgen und fragen Sie nach, bevor Sie mit dem pruefwert aus loeschen_vorschau erneut aufrufen. Hat sich die Lage seit der Vorschau geändert, antwortet die API mit 409 vorschau_veraltet und der neuen Vorschau. Bei frage_anlass ist anlass Pflicht: "falsch_angelegt" hebt Forderungen auf (festgeschriebene Buchungen werden storniert, dazu braucht es Buchung:Storno), "nicht_mehr_gebraucht" lässt die Buchhaltung unverändert. Es geht nie mehr, als der Mensch im Portal selbst darf. Braucht den Löschscope der Art (z. B. Mietvertrag:Delete).

Parameter von loeschen
ParameterTypBeschreibung
art Pflichtversammlungsform_nachweis | weg_uebernahme | weg_uebernahme_dokument | beleg | angebot | kreditor | leistungsart | kasse | top | etv_dokument | umlaufbeschluss | umlauf_anlage | beirat_schreiben | beschluss_vermerk | eigentuemer_objekt | eigentuemer_einheit | eigentuemer_zugang | eigentuemer_mitglied | eigentuemer_vertreter | eigentuemerwechsel | verkauf | wp_position | umfrage | aushang | verwalterwechsel | briefing_empfaenger | mietvertrag | einheit | objekt | mieter | eigentuemer | person | dienstleister | bankkonto | zaehlerstand | mietbestandteil | versammlung | beschluss | dokument | wirtschaftsplan | mahnung | nk_abrechnung | umlageschluessel | mieterhoehung | nkv_anpassung | mietpreis | mietvertrag_personenzahl | darlehen | sondertilgung | kaution | schluessel | zaehler | messstelle | versorgungsvertrag | uebergabe | einheit_dokument | mieter_dokument | eigentuemer_dokument | versicherungsfall | versicherungsvertrag | praemie | versicherer | makler | meldeweg | mieter_leistung | preisstand | vertragskosten | messstellen_zuordnung | abschlagsfassung | jahresrechnung | sepa_mandat | anlage | anlage_ereignis | bauteil | instandhaltungsvorhaben | energieausweis | esg_szenario | esg_verbrauch | esg_metrik | esg_baseline | anmietung | notdienst | objektrecht | externe_ablage | pflichtnachweis | pflichtnachweis_dokument | pflichtfestlegung | fremdverwaltung | sev_einmalig | sev_abrechnung | hausmeister | hausmeister_vertrag | hausmeister_vertragsaufgabe | hausmeister_aufgabe | hausmeister_auftrag | hausmeister_erledigung | hausmeister_termin | haus_hinweis | bewohner | mieter_mitglied | notfallkontakt | staffel_stufe | staffelanpassung | indexanpassung | inserat | inserat_lead | mietvertrag_ordner | mieter_ordner | mietvertrag_dokument | kaution_abrechnung | kuendigung | mietminderung | modernisierung | untervermietung | stammdatenaenderung | mieterwechsel_antrag | schadenArt des Datensatzes.
id PflichtstringID des Datensatzes (UUID; bei einem Objekt die Objekt-Nr., bei Person, Übergabe, Darlehen, Mahnung eine Zahl).
pruefwertstringDer pruefwert aus loeschen_vorschau. Ohne ihn wird nur die Vorschau geliefert.
anlassfalsch_angelegt | nicht_mehr_gebrauchtNur wenn die Vorschau frage_anlass meldet.
papierkorb_auflistenLesenListet die gelöschten Datensätze des Mandanten, die noch wiederherstellbar sind (30 Tage): Art, Bezeichnung, wer wann gelöscht hat, Anlass, was beim Löschen storniert wurde.jeder Zugang

GET /api/v1/partner/papierkorb

Listet die gelöschten Datensätze des Mandanten, die noch wiederherstellbar sind (30 Tage): Art, Bezeichnung, wer wann gelöscht hat, Anlass, was beim Löschen storniert wurde. Zeilen erscheinen nur für Arten, deren Löschscope der Zugang trägt (z. B. Mietvertrag:Delete, Einheit:Delete).

Parameter von papierkorb_auflisten
ParameterTypBeschreibung
artstringNur diese Art, z. B. "mietvertrag".
papierkorb_wiederherstellenSchreibenHolt einen Datensatz aus dem Papierkorb zurück.jeder Zugang

POST /api/v1/partner/papierkorb/:id/wiederherstellen

Holt einen Datensatz aus dem Papierkorb zurück. Ohne bestaetigt:true kommt nur die Vorschau (was zurückkommt, Konflikte wie vergebene Nummern, Buchhaltungshinweis). Storniertes bleibt storniert: Die Stammdaten kommen zurück, nicht die Buchungen. Braucht den Löschscope der Art.

Parameter von papierkorb_wiederherstellen
ParameterTypBeschreibung
id PflichtstringUUID des Papierkorb-Eintrags (aus papierkorb_auflisten) (z. B. aus der jeweiligen Liste).
bestaetigtbooleantrue = wirklich wiederherstellen; sonst nur Vorschau.

[02]4 Tools

Unternehmen und Erscheinungsbild

firmendaten_lesenLesenZeigt die Angaben für Briefpapier und Schriftverkehr.Firmendaten:ReadLesen mit Kontaktdaten

GET /api/v1/partner/firmendaten

Zeigt die Angaben für Briefpapier und Schriftverkehr. hausverwaltung sind die Firmendaten der Verwaltung (des Betriebs): Name, Anschrift und Kontakt, Steuernummer, USt-IdNr., Handelsregister, § 34c-Erlaubnis und § 26a-Zertifizierung — sie gelten für alle Mandanten dieser Verwaltung. hausverwaltungBank ist die Bankverbindung der Verwaltung (steht auf Honorarrechnungen an Eigentümer und auf Akquise-Angeboten), sepaCreditor die Bankverbindung dieses Mandanten (Mieterrechnungen, SEPA-Lastschrifteinzug). Beide haben dieselbe Form: id = SEPA-Gläubiger-ID, name = Kontoinhaber, iban, bic, bank = Kreditinstitut. mandant sind Name, Art (weg, eigentuemer, eigener_bestand, selbst) und die Stammdaten dieses Mandanten (Anschrift, Kontakt, Steuernummer, USt-IdNr., Handelsregister) — er ist der Vermieter einer WEG oder eines Eigentümers als Kunde und steht auf Rechnungen an Mieter; ist eigene_angaben false (eigener Bestand, Eigentümer selbst), gelten die Angaben der Verwaltung. Meldet außerdem, ob die Verwaltung ein Briefpapier-Logo hinterlegt hat. auftritte sind die Namen, unter denen das Unternehmen als Verwaltung schreibt (z. B. "Mustermann GmbH · Immobilienverwaltung"), mit istStandard und logoVorhanden; auftrittId ist der Auftritt dieses Mandanten, null = der Standard. Ein Auftritt ändert nur den Absender (Briefkopf, Gruß, Mail-Absendername) — Vermieter, Rechnungsaussteller und Vertragspartei bleibt das Unternehmen unter seinem Namen in hausverwaltung.name. vertretung nennt, wer das Unternehmen besitzt bzw. nach außen vertritt — je Eintrag personId (Verweis auf eine Person des Unternehmens), name, funktion (inhaber, geschaeftsfuehrer, vorstand, gesellschafter, prokurist, sonstige) und funktionText im Klartext; leer heißt: nicht angegeben, nicht „niemand“. Die Angabe stammt aus den Firmendaten und sagt nichts über Konten oder Rechte in immoGenio; eingetragen wird sie nur in der Konsole. Braucht den Scope Firmendaten:Read.

firmendaten_setzenSchreibenSchreibt die Firmendaten der Verwaltung, ihre Bankverbindung, die Bankverbindung und/oder die Stammdaten des Mandanten.Firmendaten:UpdateBearbeiten

PATCH /api/v1/partner/firmendaten

Schreibt die Firmendaten der Verwaltung, ihre Bankverbindung, die Bankverbindung und/oder die Stammdaten des Mandanten. ACHTUNG 1: hausverwaltung und hausverwaltungBank gehören der Verwaltung (dem Betrieb) — eine Änderung gilt sofort für ALLE Mandanten dieser Verwaltung, nicht nur für den Mandanten des Tokens. sepaCreditor und mandant gelten nur für diesen Mandanten; mandant wird beim eigenen Bestand und beim Eigentümer selbst mit 409 abgewiesen (dort gelten die Angaben der Verwaltung). ACHTUNG 2: Ein übergebener Block ersetzt seinen alten Stand VOLLSTÄNDIG — ein weggelassenes Feld innerhalb eines Blocks wird geleert (nur der Name der Verwaltung lässt sich nicht leeren). Deshalb immer zuerst firmendaten_lesen aufrufen und den vollständigen Block zurückschicken. Nicht übergebene Blöcke bleiben unberührt. Eine IBAN mit falscher Prüfziffer oder eine BIC ohne 8 bzw. 11 Zeichen wird mit 400 abgewiesen. Das Briefpapier-Logo lässt sich hier nicht setzen (nur in der Konsole). auftrittId wählt den Auftritt dieses Mandanten aus der Liste von firmendaten_lesen (null = der Standard); Auftritte anlegen oder ändern geht nur in der Konsole. Einen Mandanten bearbeiten heißt hier: Anschrift, Kontakt und Steuerangaben im Block mandant. Den Namen eines Mandanten ändert man nicht über ein Tool, ebenso wenig wie im Portal. Über den persönlichen Zugang ändern hausverwaltung, hausverwaltungBank, Auftritt und mandant nur Inhaber und Administratoren des Unternehmens, wie in der Konsole (sonst 403). Braucht den Scope Firmendaten:Update.

Parameter von firmendaten_setzen
ParameterTypBeschreibung
hausverwaltungobjectFirmendaten der Verwaltung: Anschrift, Kontakt, Steuer/Register. Gilt für alle Mandanten der Verwaltung. Ersetzt den bisherigen Stand vollständig.
hausverwaltungBankobjectBankverbindung der Verwaltung — steht auf Honorarrechnungen an Eigentümer und auf Akquise-Angeboten. Gilt für alle Mandanten der Verwaltung. Ersetzt den bisherigen Stand vollständig.
sepaCreditorobjectBankverbindung dieses Mandanten (eine WEG zieht auf ihr eigenes Konto ein) — steht auf Rechnungen an Mieter und ist zugleich der Gläubiger des SEPA-Lastschrifteinzugs. Gilt nur für diesen Mandanten. Ersetzt den bisherigen Stand vollständig.
mandantobjectAnschrift, Kontakt und Steuerangaben dieses Mandanten (z. B. der WEG) — stehen auf Rechnungen an Mieter und in Briefen als Vermieter. § 14 UStG verlangt auf einer Rechnung Anschrift und Steuernummer oder USt-IdNr. Gilt nur für diesen Mandanten. Ersetzt den bisherigen Stand vollständig.
auftrittIdbeliebigAuftritt, unter dem die Verwaltung in diesem Mandanten schreibt — id aus firmendaten_lesen.auftritte, null = der Standard-Auftritt. Gilt nur für diesen Mandanten.
erscheinungsbild_lesenLesenZeigt das Corporate Design („Eigenes Design“) der Verwaltung: unternehmen ist die Ebene des Unternehmens, mandant die Ebene dieses Mandanten, wirksam das Ergebnis, das im Mandanten tatsächlich gilt (Unternehmen, vom Mandanten überlagert; nur gesetzte Werte, der Rest ist das Standarddesign).Erscheinungsbild:ReadLesen

GET /api/v1/partner/erscheinungsbild

Zeigt das Corporate Design („Eigenes Design“) der Verwaltung: unternehmen ist die Ebene des Unternehmens, mandant die Ebene dieses Mandanten, wirksam das Ergebnis, das im Mandanten tatsächlich gilt (Unternehmen, vom Mandanten überlagert; nur gesetzte Werte, der Rest ist das Standarddesign). Je Ebene: farben (Hell) und farbenDunkel (Dunkel) als Zuordnung Token → Hex-Wert, schriftName, hatSchriftdatei, css, wortmarkeText (Schriftzug statt des Logos „immoGenio“ oben links), hatWortmarkeBild und hatFavicon (eigenes Favicon im Browser-Tab; Mandant vor Unternehmen). verfuegbar ist false, wenn das Unternehmen nicht im Enterprise-Tarif ist — dann lässt sich das Design weder ändern noch wirkt es. Braucht den Scope Erscheinungsbild:Read.

erscheinungsbild_setzenSchreibenÄndert das Corporate Design („Eigenes Design“) — nur im Enterprise-Tarif (sonst 403 mit Hinweis auf den Tarif) und nur als Inhaber oder Administrator des Unternehmens, wie im Portal.Erscheinungsbild:UpdateBearbeiten

PUT /api/v1/partner/erscheinungsbild/:ebene

Ändert das Corporate Design („Eigenes Design“) — nur im Enterprise-Tarif (sonst 403 mit Hinweis auf den Tarif) und nur als Inhaber oder Administrator des Unternehmens, wie im Portal. ebene "unternehmen" gilt für ALLE Mandanten der Verwaltung, "mandant" nur für den Mandanten dieses Zugangs und überlagert das Unternehmen; was dort nicht gesetzt ist, wird vom Unternehmen geerbt. Teil-Update: nur gesendete Felder ändern sich, Ungesendetes bleibt. Immer zuerst erscheinungsbild_lesen aufrufen. Farben sind Hex-Werte im Format #rrggbb. Die Primärfarbe (primaer) und die Sekundärfarbe (sekundaer) bestimmen das GANZE Design (Markenskala, Knöpfe, Akzente) — für ein Corporate Design genügen meist diese beiden; die übrigen Token (background, foreground, card, kopfleiste, kopfleiste-text, kopfleiste-akzent) sind Feinheiten und optional. farben gilt für den hellen Modus, farbenDunkel für den dunklen; beide getrennt pflegen. In farben/farbenDunkel führt ein Token mit Wert null dazu, dass dieses Token zurückgesetzt wird (Standard bzw. geerbt), farben: null leert alle Farben der Karte. schriftName: Name der Schrift (null = zurücksetzen); die Schriftdatei (woff2) lässt sich hier nicht hochladen, sondern nur im Portal unter Eigenes Design — ein Name ohne Datei verwendet eine auf dem Gerät vorhandene Schrift. css: eigene CSS-Regeln (höchstens 20.000 Zeichen, null = entfernen); verboten sind @import, fremde url() (erlaubt nur url(data:…)), expression(), javascript:, behavior:, image-set()/cross-fade()/element() und Backslashes; ein Verstoß wird mit 400 samt Zeile und Abhilfe abgewiesen. wortmarkeText: eigener Schriftzug statt „immoGenio“ oben links in der Kopfleiste (höchstens 60 Zeichen, eine Zeile, null = zurücksetzen); ein im Portal hochgeladenes Wortmarken-Bild gewinnt auf derselben Ebene vor dem Schriftzug, und das Bild selbst lässt sich hier nicht hochladen, sondern nur im Portal unter Eigenes Design. Dasselbe gilt für das Favicon (PNG, SVG, ICO oder WebP): Es lässt sich hier nicht hochladen, nur im Portal unter Eigenes Design. Antwort ist der neue Stand der geänderten Ebene. Braucht den Scope Erscheinungsbild:Update.

Parameter von erscheinungsbild_setzen
ParameterTypBeschreibung
ebene Pflichtunternehmen | mandant"unternehmen" = gilt für alle Mandanten der Verwaltung; "mandant" = nur für den Mandanten dieses Zugangs (überlagert das Unternehmen).
farbenbeliebigHell: Token → Hex #rrggbb; Wert null setzt ein Token zurück, null statt Objekt leert alle.
farbenDunkelbeliebigDunkel: wie farben, für den dunklen Modus.
schriftNamebeliebigName der Schrift; null = zurücksetzen. Die Datei lädt man im Portal hoch.
cssbeliebigEigene CSS-Regeln; null = entfernen.
wortmarkeTextbeliebigSchriftzug der Wortmarke oben links; null = zurücksetzen. Ein Bild lädt man im Portal hoch.

[03]44 Tools

Objekte, Einheiten und Zähler

objekte_auflistenLesenListet Immobilien-Objekte des Mandanten (Objekt-Nr., Kurzname, Adresse, Stadt, Baujahr, Gebäudeart, Status) inkl. Aggregaten: Anzahl Einheiten, aktive Mietverträge, Leerstand.Objekt:ReadLesen

GET /api/v1/partner/objekte

Listet Immobilien-Objekte des Mandanten (Objekt-Nr., Kurzname, Adresse, Stadt, Baujahr, Gebäudeart, Status) inkl. Aggregaten: Anzahl Einheiten, aktive Mietverträge, Leerstand. Filter: Objekt-Nr., Stadt, Baujahr-Bereich.

Parameter von objekte_auflisten
ParameterTypBeschreibung
pageintegerSeitennummer (ab 1).
pageSizeintegerEinträge pro Seite (max. 200).
objektNrstringNur dieses Objekt zurückgeben (Objekt-Nr.).
ortstringNach Stadt/Ort filtern (Teilstring, case-insensitive).
baujahrVonintegerNur Objekte mit Baujahr >= diesem Wert.
baujahrBisintegerNur Objekte mit Baujahr <= diesem Wert.
einheiten_auflistenLesenListet Wohn-/Gewerbeeinheiten (Bezeichnung, Objekt, Typ, Fläche, Zimmer, Stockwerk, MEA, vermietet ja/nein, aktueller Mietername).Einheit:ReadLesen

GET /api/v1/partner/einheiten

Listet Wohn-/Gewerbeeinheiten (Bezeichnung, Objekt, Typ, Fläche, Zimmer, Stockwerk, MEA, vermietet ja/nein, aktueller Mietername). Vermietet heisst: heute bewohnt, auch mit gekündigtem, noch laufendem Vertrag. Filter: Objekt-Nr., Typ, Status (vermietet/leer), Fläche-Bereich, Zimmeranzahl. Was wann frei wird und was für die Vermietung zu tun ist, liefert leerstand_auflisten.

Parameter von einheiten_auflisten
ParameterTypBeschreibung
pageintegerSeitennummer (ab 1).
pageSizeintegerEinträge pro Seite (max. 200).
objektNrstringNur Einheiten dieses Objekts (Objekt-Nr.).
typwohnung | stellplatz | garage | tiefgarage | haus | zimmer | gewerbeNach Einheit-Typ filtern.
statusvermietet | leerNur vermietete oder nur leere Einheiten.
flaecheVonnumberMindest-Flaeche in qm.
flaecheBisnumberMaximal-Flaeche in qm.
zimmernumberExakte Zimmeranzahl.
objekt_detailsLesenZeigt ein einzelnes Objekt mit Aggregaten (Einheiten-/Leerstands-/Aktiv-Vertrags-Count).Objekt:ReadLesen

GET /api/v1/partner/objekte/:objektNr

Zeigt ein einzelnes Objekt mit Aggregaten (Einheiten-/Leerstands-/Aktiv-Vertrags-Count).

Parameter von objekt_details
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
objekt_einheitenLesenListet alle Einheiten eines Objekts (mit Vermietungsstatus + aktuellem Mietername).Objekt:ReadLesen

GET /api/v1/partner/objekte/:objektNr/einheiten

Listet alle Einheiten eines Objekts (mit Vermietungsstatus + aktuellem Mietername).

Parameter von objekt_einheiten
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
objekt_eigentuemerLesenListet die Eigentümer eines Objekts inkl. Anteil (eigentuemer_objekt-Zuordnung).Objekt:ReadLesen

GET /api/v1/partner/objekte/:objektNr/eigentuemer

Listet die Eigentümer eines Objekts inkl. Anteil (eigentuemer_objekt-Zuordnung).

Parameter von objekt_eigentuemer
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
objekt_verlaufLesenVerlauf eines Objekts wie das Register „Verlauf“ der Objektseite (Konzept 77): was am Haus geschehen ist und in den nächsten zwölf Monaten ansteht, neueste Einträge zuerst.Objekt:ReadLesen

GET /api/v1/partner/objekte/:objektNr/verlauf

Verlauf eines Objekts wie das Register „Verlauf“ der Objektseite (Konzept 77): was am Haus geschehen ist und in den nächsten zwölf Monaten ansteht, neueste Einträge zuerst. Je Eintrag Art, Datum, Titel als Satz, Stand in Klartext und `href` (Pfad im Portal). Beschlüsse hängen unter ihrer Versammlung (`kinder`), die Dokumente eines Tages stehen in einem Eintrag. Arten je Scope: Mietbeginn und Mietende mit Mietvertrag:Read, Kündigungen mit Kuendigung:Read, Eigentümerwechsel mit Eigentuemerwechsel:Read, Versammlungen mit Versammlung:Read, Beschlüsse mit Beschluss:Read, Anfragen und Schadensmeldungen mit Anfrage:Read, Versicherungsfälle mit Versicherungsfall:Read, Rechnungen mit Kreditorposten:Read, Prüfungen mit Pflicht:Read, Wartungen, Befunde und Reparaturen mit Anlage:Read, Übergaben mit Uebergabe:Read, Dokumente nur mit Dokument:Read (Stufe Lesen mit Kontaktdaten). Fehlt ein Scope, fehlt seine Art. `arten` der Antwort nennt, was der Zugang sieht. Mieter- und Eigentümernamen nur mit Mieter:Read bzw. Eigentuemer:Read, die Kurzbeschreibung eines Versicherungsfalls nur mit Versicherungsfall:ReadPII. Freitexte, in denen Namen stehen, nur mit Kontakt-Scopes: der Betreff einer Anfrage mit Anfrage:ReadPII (sonst heißt der Eintrag etwa „Schadensmeldung Whg 3“), Titel und Dateinamen der Dokumente mit Dokument:Read (sonst nur „N Dokumente abgelegt“), Bemerkung der Rechnung, Name eines Lieferanten, der eine Privatperson ist (sonst nur „Rechnung“), Bezeichnung der Anlage, Prüfer und Beschreibung einer Wartung mit der Stufe „Lesen mit Kontaktdaten“ — beim persönlichen Zugang zählt die Stufe der Freigabe, beim Token genügt irgendein Scope dieser Stufe, weil es für diese Freitexte keinen eigenen Scope gibt. Blättern: `weiter` der Antwort als `weiter` in den nächsten Aufruf. `zaehlung` zählt je Monat und Gruppe bis heute und steht nur in der ersten Seite (danach `null`). Liegt das Objekt außerhalb der Objekte, die der Mensch hinter einem persönlichen Zugang sehen darf, antwortet die API mit 404. Scope: Objekt:Read.

Parameter von objekt_verlauf
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
gruppenListe (personen | weg | schaeden | rechnung | technik | uebergabe | dokument | aenderungen)Nur diese Gruppen; leer = alle, die der Zugang sehen darf. personen = Mietbeginn, Mietende, Kündigung und Eigentümerwechsel; weg = Versammlungen und Beschlüsse; schaeden = Anfragen und Versicherungsfälle; rechnung = Eingangsrechnungen; technik = Prüfungen und Wartungen; uebergabe = Wohnungsübergaben; dokument = abgelegte Dokumente.
vonstringFrühestes Datum (JJJJ-MM-TT).
bisstringSpätestes Datum (JJJJ-MM-TT); ohne Angabe zwölf Monate voraus.
abEurointegerRechnungen ab diesem Bruttobetrag in Euro; 0 = alle.
einheitIdstringNur der Verlauf dieser Einheit.
mitAenderungenbooleanAuch die Änderungen und Löschungen an den Stammdaten des Hauses (Gruppe aenderungen, Konzept 194). Ohne Angabe nicht enthalten; die Einzelheiten je Feld liefert aenderungen_lesen.
weiterstringZeiger `weiter` aus der vorigen Antwort.
limitintegerEinträge je Seite.
objekt_anlegenSchreibenLegt ein neues Objekt an.Objekt:CreateBearbeiten

POST /api/v1/partner/objekte

Legt ein neues Objekt an. Objekt-Nr. wird vom Aufrufer vergeben. Pflicht: nr, kurzname, name, adresse, ort, baujahr, gebaeudeart (DB-NOT-NULL) und verwaltungsart.

Parameter von objekt_anlegen
ParameterTypBeschreibung
nr PflichtintegerEindeutige Objekt-Nr.
kurzname PflichtstringKurzname/Kennung des Objekts.
name PflichtstringName/Bezeichnung.
adresse PflichtstringStrasse + Hausnummer.
plzstringPostleitzahl.
ort PflichtstringStadt/Ort.
gemeindestringGemeinde.
gebaeudeart PflichtMFH | EFH | Hochhaus | ETW | RMH | ETW+Garagen | Hotelzimmer | Ferienwohnung | Gewerbe | GaragenGebäudeart (Bauform).
baujahr PflichtintegerBaujahr (Jahr).
verwaltungsart Pflichtweg | miet | sevWas verwaltet wird — legt fest, welche Fachthemen es am Objekt gibt. weg: die Gemeinschaft (Versammlungen, Beschlüsse, Wirtschaftsplan, Hausgeld; keine Mietverträge). miet: das ganze Haus für den Eigentümer (Mieter, Mietverträge, Nebenkostenabrechnung). sev: einzelne Wohnungen in einer WEG, die jemand anders oder ein anderer Mandant führt (Mietthemen). Ein WEG-Mandant trägt nur weg, andere Mandanten nur miet und sev. Wechsel nur, solange keine Fachdaten der alten Art am Objekt hängen.
erbpachtbooleanErbpacht?
bemerkungenstringFreitext-Bemerkungen.
statusAktiv | InaktivStatus.
objekt_aktualisierenSchreibenAktualisiert ein Objekt (nur übergebene Felder; restliche Stammdaten bleiben erhalten).Objekt:UpdateBearbeiten

PATCH /api/v1/partner/objekte/:objektNr

Aktualisiert ein Objekt (nur übergebene Felder; restliche Stammdaten bleiben erhalten).

Parameter von objekt_aktualisieren
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
kurznamestringKurzname/Kennung des Objekts.
namestringName/Bezeichnung.
adressestringStrasse + Hausnummer.
plzstringPostleitzahl.
ortstringStadt/Ort.
gemeindestringGemeinde.
gebaeudeartMFH | EFH | Hochhaus | ETW | RMH | ETW+Garagen | Hotelzimmer | Ferienwohnung | Gewerbe | GaragenGebäudeart (Bauform).
baujahrintegerBaujahr (Jahr).
verwaltungsartweg | miet | sevWas verwaltet wird — legt fest, welche Fachthemen es am Objekt gibt. weg: die Gemeinschaft (Versammlungen, Beschlüsse, Wirtschaftsplan, Hausgeld; keine Mietverträge). miet: das ganze Haus für den Eigentümer (Mieter, Mietverträge, Nebenkostenabrechnung). sev: einzelne Wohnungen in einer WEG, die jemand anders oder ein anderer Mandant führt (Mietthemen). Ein WEG-Mandant trägt nur weg, andere Mandanten nur miet und sev. Wechsel nur, solange keine Fachdaten der alten Art am Objekt hängen.
erbpachtbooleanErbpacht?
bemerkungenstringFreitext-Bemerkungen.
statusAktiv | InaktivStatus.
einheit_detailsLesenZeigt eine einzelne Einheit mit Objekt-Bezug und aktuellem Mietvertrag/Mietername.Einheit:ReadLesen

GET /api/v1/partner/einheiten/:einheitId

Zeigt eine einzelne Einheit mit Objekt-Bezug und aktuellem Mietvertrag/Mietername.

Parameter von einheit_details
ParameterTypBeschreibung
einheitId PflichtstringUUID der Einheit (z. B. aus der jeweiligen Liste).
einheit_raeume_lesenLesenLiest die Räume einer Einheit (Zimmer, Küche, Bad, Balkon …) mit Fläche und Böden und darunter ihre Heizkörper, dazu die Heizkörper ohne Raum.Einheit:ReadLesen

GET /api/v1/partner/einheiten/:einheitId/raeume

Liest die Räume einer Einheit (Zimmer, Küche, Bad, Balkon …) mit Fläche und Böden und darunter ihre Heizkörper, dazu die Heizkörper ohne Raum. Je Raum zaehler_ids (Zähler, die am Raum hängen), je Heizkörper zaehler_id (der laufende Heizkostenverteiler). Die ids sind die Parameter raum_id und heizkoerper_id von zaehler_anlegen und zaehler_aktualisieren. Zähler selbst liefert zaehler_auflisten.

Parameter von einheit_raeume_lesen
ParameterTypBeschreibung
einheitId PflichtstringUUID der Einheit (z. B. aus der jeweiligen Liste).
einheit_schluessel_lesenLesenLiest die Schlüssel einer Einheit: je Zeile Bezeichnung, Nummer, Ablageort, wer wie viele hält (stand: Büro, Mietvertrag, Eigentümer, Person, Dienstleister, mit Rückgabefrist und ueberfaellig), verlorene Stück und die letzten Bewegungen.Einheit:ReadLesen

GET /api/v1/partner/einheiten/:einheitId/schluessel

Liest die Schlüssel einer Einheit: je Zeile Bezeichnung, Nummer, Ablageort, wer wie viele hält (stand: Büro, Mietvertrag, Eigentümer, Person, Dienstleister, mit Rückgabefrist und ueberfaellig), verlorene Stück und die letzten Bewegungen. Die id einer Zeile ist der Parameter von einheit_schluessel_bewegung_buchen. vorschlag nennt bei einer Einheit ohne Schlüssel das letzte Protokoll, aus dem sich der Bestand im Portal übernehmen lässt.

Parameter von einheit_schluessel_lesen
ParameterTypBeschreibung
einheitId PflichtstringUUID der Einheit (z. B. aus der jeweiligen Liste).
einheit_schluessel_anlegenSchreibenLegt eine Schlüsselzeile an der Einheit an, zum Beispiel „Wohnungstür“.Einheit:UpdateBearbeiten

POST /api/v1/partner/einheiten/:einheitId/schluessel

Legt eine Schlüsselzeile an der Einheit an, zum Beispiel „Wohnungstür“. anzahl wird der erste Zugang und liegt im Büro, solange halter nichts anderes sagt. Stückzahlen ändert danach nur einheit_schluessel_bewegung_buchen. Vorher einheit_schluessel_lesen, damit keine Zeile doppelt entsteht.

Parameter von einheit_schluessel_anlegen
ParameterTypBeschreibung
einheitId PflichtstringUUID der Einheit (z. B. aus der jeweiligen Liste).
bezeichnung Pflichtstring
anzahl Pflichtinteger
schluesselnummerstring
ablageortstringWo der Schlüssel im Büro liegt, etwa „Fach 12“. Steht nie im Protokoll.
notizstring
halterobjectWer die Schlüssel hält; ohne Angabe das Büro. typ ist buero (ohne id), mietvertrag, eigentuemer, person oder dienstleister (mit id).
einheit_schluessel_bewegung_buchenSchreibenBucht eine Bewegung an einer Schlüsselzeile.Einheit:UpdateBearbeiten

POST /api/v1/partner/einheiten/:einheitId/schluessel/:schluesselId/bewegungen

Bucht eine Bewegung an einer Schlüsselzeile. Überschrieben wird nie, jede Änderung ist eine Bewegung: ausgabe (von, ohne Angabe Büro, an, mit rueckgabe_bis), rueckgabe (von, ins Büro), verlust (von), zugang (neue Stück, an, ohne Angabe Büro), korrektur (entweder von oder an, notiz ist Pflicht). Mehr, als ein Halter hat, wird abgewiesen. Verlust löst keine Rechnung aus.

Parameter von einheit_schluessel_bewegung_buchen
ParameterTypBeschreibung
einheitId PflichtstringUUID der Einheit (z. B. aus der jeweiligen Liste).
schluesselId PflichtstringUUID der Schlüsselzeile (id aus einheit_schluessel_lesen) (z. B. aus der jeweiligen Liste).
art Pflichtzugang | ausgabe | rueckgabe | verlust | korrektur
anzahl Pflichtinteger
vonobjectWer abgibt. typ ist buero (ohne id), mietvertrag, eigentuemer, person oder dienstleister (mit id).
anobjectWer bekommt. typ ist buero (ohne id), mietvertrag, eigentuemer, person oder dienstleister (mit id).
rueckgabe_bisstringJJJJ-MM-TT, nur bei einer Ausgabe an Dritte.
datumstringJJJJ-MM-TT, ohne Angabe heute.
notizstring
einheit_raeume_setzenSchreibenErsetzt Räume und Heizkörper einer Einheit durch die gesendete Liste: Einträge mit id bleiben und werden aktualisiert, ohne id entstehen neu, fehlende werden gelöscht (Zähler daran verlieren nur den Raum).Einheit:UpdateBearbeiten

PUT /api/v1/partner/einheiten/:einheitId/raeume

Ersetzt Räume und Heizkörper einer Einheit durch die gesendete Liste: Einträge mit id bleiben und werden aktualisiert, ohne id entstehen neu, fehlende werden gelöscht (Zähler daran verlieren nur den Raum). Vorher einheit_raeume_lesen und alles Unveränderte mit seiner id mitsenden. Zähler ordnet dieses Werkzeug nicht zu — das macht zaehler_aktualisieren mit raum_id oder heizkoerper_id.

Parameter von einheit_raeume_setzen
ParameterTypBeschreibung
einheitId PflichtstringUUID der Einheit (z. B. aus der jeweiligen Liste).
raeume PflichtListe (object)Alle Räume in der gewünschten Reihenfolge.
heizkoerper_ohne_raumListe (object)Heizkörper, die keinem Raum zugeordnet sind.
einheit_anlegenSchreibenLegt eine neue Einheit unter einem Objekt an.Einheit:CreateBearbeiten

POST /api/v1/partner/einheiten

Legt eine neue Einheit unter einem Objekt an. Das Objekt muss dem Mandanten gehören.

Parameter von einheit_anlegen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
bezeichnung PflichtstringBezeichnung/Nummer der Einheit (z. B. "WE 3, 2. OG").
typwohnung | stellplatz | garage | tiefgarage | haus | zimmer | gewerbeEinheit-Typ.
flaecheQmnumberWohn-/Nutzflaeche in qm.
meanumberMiteigentumsanteil (MEA).
stockwerkstringStockwerk, z. B. "EG", "2. OG", "DG", "TG".
lagestringLage im Haus, z. B. "links", "Mitte", "Gartenseite".
zimmernumberAnzahl Zimmer (Wohnung, Haus), z. B. 2.5.
bemerkungenstringFreitext-Bemerkungen.
einheit_aktualisierenSchreibenAktualisiert eine Einheit (nur übergebene Felder).Einheit:UpdateBearbeiten

PATCH /api/v1/partner/einheiten/:einheitId

Aktualisiert eine Einheit (nur übergebene Felder).

Parameter von einheit_aktualisieren
ParameterTypBeschreibung
einheitId PflichtstringUUID der Einheit (z. B. aus der jeweiligen Liste).
bezeichnungstringBezeichnung/Nummer der Einheit (z. B. "WE 3, 2. OG").
typwohnung | stellplatz | garage | tiefgarage | haus | zimmer | gewerbeEinheit-Typ.
flaecheQmnumberWohn-/Nutzflaeche in qm.
meanumberMiteigentumsanteil (MEA).
stockwerkstringStockwerk, z. B. "EG", "2. OG", "DG", "TG".
lagestringLage im Haus, z. B. "links", "Mitte", "Gartenseite".
zimmernumberAnzahl Zimmer (Wohnung, Haus), z. B. 2.5.
bemerkungenstringFreitext-Bemerkungen.
aktivbooleanAktiv-Flag.
unterkostenstellen_auflistenLesenListet die Unterkostenstellen eines Objekts: jede Wohnung und Einheit (art=einheit, mit Fläche, MEA, Stockwerk) und die frei angelegten Bereiche (Tiefgarage, Außenanlage …).Objekt:ReadLesen

GET /api/v1/partner/unterkostenstellen

Listet die Unterkostenstellen eines Objekts: jede Wohnung und Einheit (art=einheit, mit Fläche, MEA, Stockwerk) und die frei angelegten Bereiche (Tiefgarage, Außenanlage …). Ihre unterkostenstelleId geht in aufteilung von buchung_erfassen, beleg_aktualisieren und beleg_buchen — so ordnen Sie Kosten einer Wohnung zu, ohne die Kostenstelle des Objekts zu verlassen. Genau eines von objektNr oder kostenstelleId angeben. Bei einer auf Objekte begrenzten Rolle nur innerhalb der Grenze; eine Rolle nur auf Einheiten sieht nur diese Einheiten. Braucht Objekt:Read.

Parameter von unterkostenstellen_auflisten
ParameterTypBeschreibung
objektNrintegerNummer des Objekts.
kostenstelleIdstringUUID der Kostenstelle des Objekts (z. B. aus der jeweiligen Liste).
instandhaltungsplan_lesenLesenDer Instandhaltungsplan eines Objekts — nur die freigegebene Fassung, keine Entwürfe, keine Schreibfunktion.Instandhaltungsplan:ReadLesen

GET /api/v1/partner/objekte/:objektNr/instandhaltungsplan

Der Instandhaltungsplan eines Objekts — nur die freigegebene Fassung, keine Entwürfe, keine Schreibfunktion. Liefert die Zahl der offenen Vorschläge und, falls eine Fassung freigegeben ist, deren Stand: Maßnahmen je Jahr mit geschätzten Kosten (Preisstand des Planjahres), Jahresraster, Bauteile mit Lebensdauer und Quelle, an WEG-Objekten Rücklage mit Bestand, Zuführung, empfohlener Zuführung und erstem Jahr mit Unterdeckung. Offene Vorschläge selbst und Begründungen verworfener Vorschläge stehen nicht darin; freigegeben=null heißt: noch keine Fassung. Die Zahlen sind Schätzwerte einer Entscheidungshilfe, kein Beschluss. Braucht Instandhaltungsplan:Read.

Parameter von instandhaltungsplan_lesen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
zaehlerstaende_zu_pruefen_auflistenLesenListet die Zählerstände, die Mieter in der Mieter-App selbst abgelesen und gemeldet haben und die noch niemand geprüft hat — älteste zuerst.Zaehlerstand:ReadLesen

GET /api/v1/partner/zaehlerstaende/zu-pruefen

Listet die Zählerstände, die Mieter in der Mieter-App selbst abgelesen und gemeldet haben und die noch niemand geprüft hat — älteste zuerst. Je Meldung: Zähler (Nummer, Name, Typ, Maßeinheit), Einheit, Objekt-Nr., Ablesedatum, gemeldeter Wert, letzter übernommener Stand davor, auffaellig (Tagesverbrauch über dem Dreifachen des üblichen) und hat_foto. Ohne Namen und ohne Foto. Eine gemeldete Zahl zählt nirgends, bis sie übernommen ist. Braucht Zaehlerstand:Read.

Parameter von zaehlerstaende_zu_pruefen_auflisten
ParameterTypBeschreibung
zaehler_idstringUUID des Zählers (nur dessen Meldungen) (z. B. aus der jeweiligen Liste).
zaehlerstand_uebernehmenSchreibenÜbernimmt einen vom Mieter gemeldeten Zählerstand als geltenden Stand (id aus zaehlerstaende_zu_pruefen_auflisten).Zaehlerstand:UpdateBearbeiten

POST /api/v1/partner/zaehlerstaende/:standId/uebernehmen

Übernimmt einen vom Mieter gemeldeten Zählerstand als geltenden Stand (id aus zaehlerstaende_zu_pruefen_auflisten). Mit wert wird korrigiert übernommen; die Notiz am Stand hält „korrigiert von x auf y“ fest. Ein korrigierter Wert unter dem letzten Stand wird mit 422 abgewiesen, eine schon geprüfte Meldung mit 409. Auffällige Meldungen erst nach Rücksprache übernehmen. Braucht Zaehlerstand:Update.

Parameter von zaehlerstand_uebernehmen
ParameterTypBeschreibung
standId PflichtstringUUID der Meldung (z. B. aus der jeweiligen Liste).
wertnumberKorrigierter Stand (höchstens drei Nachkommastellen); ohne Angabe gilt der gemeldete.
zaehler_auflistenLesenListet die Zähler des Mandanten wie die Zählerliste im Portal: id, Zählernummer, Name, Art (zaehlertyp), Maßeinheit, Einbauort (lage), Objekt bzw. Einheit, Haupt- oder Nebenzähler, Ableseintervall, Status, Fernablesung, Einbau, Eichjahr samt Eichfrist und den letzten Stand mit Datum.Zaehler:ReadLesen

GET /api/v1/partner/zaehler

Listet die Zähler des Mandanten wie die Zählerliste im Portal: id, Zählernummer, Name, Art (zaehlertyp), Maßeinheit, Einbauort (lage), Objekt bzw. Einheit, Haupt- oder Nebenzähler, Ableseintervall, Status, Fernablesung, Einbau, Eichjahr samt Eichfrist und den letzten Stand mit Datum. Zähler an Wohnungen hängen an der Einheit; objekt_id findet sie trotzdem. Die id ist der Parameter von zaehler_aktualisieren und zaehlerstand_eintragen. Braucht Zaehler:Read.

Parameter von zaehler_auflisten
ParameterTypBeschreibung
objekt_idintegerNur Zähler dieses Objekts (Objekt-Nr.), auch die an seinen Einheiten.
einheit_idstringUUID der Einheit (nur deren Zähler) (z. B. aus der jeweiligen Liste).
zaehlertypstrom | wasser_kalt | wasser_warm | gas | waerme | oel | heizkostenverteiler | sonstigesNur diese Zählerart.
ist_nebenzaehlertrue | falseNur Neben- bzw. nur Hauptzähler.
statusaktiv | inaktivNur aktive bzw. stillgelegte Zähler.
searchstringTeil der Zählernummer oder des Namens.
limitintegerHöchstens so viele (Vorgabe 200).
offsetintegerSo viele überspringen.
zaehler_anlegenSchreibenLegt einen Zähler an — jede Art: Strom, Kaltwasser, Warmwasser, Gas, Wärme, Öl, Heizkostenverteiler, sonstige.Zaehler:CreateBearbeiten

POST /api/v1/partner/zaehler

Legt einen Zähler an — jede Art: Strom, Kaltwasser, Warmwasser, Gas, Wärme, Öl, Heizkostenverteiler, sonstige. Genau eines von objekt_id (Zähler am Haus, etwa Hauptwasser oder Allgemeinstrom) oder einheit_id (Zähler in der Wohnung). Ein Nebenzähler braucht parent_zaehler_id: einen Hauptzähler mit derselben Zuordnung. geraete_anzahl über 1 nur beim Satz Heizkostenverteiler einer Einheit. Eine Zählernummer, die es am selben Objekt bzw. an derselben Einheit schon gibt, wird mit 409 abgewiesen; ein Objekt oder eine Einheit außerhalb des Mandanten mit 400. Den Anfangsstand danach mit zaehlerstand_eintragen. Braucht Zaehler:Create.

Parameter von zaehler_anlegen
ParameterTypBeschreibung
eigentumkauf | mieteKauf oder Miete je Gerät — nur in Heizkosten-Mandanten (sonst Fehler 422); beim Anlegen ohne Angabe gilt die Vorgabe des Auftrags, beim Zählerwechsel erbt der neue Zähler das Eigentum des alten.
objekt_idbeliebigObjekt-Nr. — für Zähler am Haus. Nicht zusammen mit einheit_id.
einheit_idbeliebigUUID der Einheit (einheiten_auflisten) — für Zähler in der Wohnung. Nicht zusammen mit objekt_id.
zaehlernummer PflichtstringZählernummer vom Gerät — je Objekt bzw. Einheit eindeutig.
zaehlernamebeliebigBezeichnung, z. B. "Kaltwasser Bad".
zaehlertyp Pflichtstrom | wasser_kalt | wasser_warm | gas | waerme | oel | heizkostenverteiler | sonstigesZählerart.
masseinheit PflichtkWh | m3 | MWh | l | stueckMaßeinheit des Stands (m3 für Wasser und Gas, kWh für Strom und Wärme, stueck für Heizkostenverteiler).
lagebeliebigEinbauort, z. B. "Keller, Raum 3" oder "Bad".
ist_nebenzaehlerbooleantrue für einen Nebenzähler (dann parent_zaehler_id Pflicht). Vorgabe false.
parent_zaehler_idbeliebigUUID des Hauptzählers — nur bei Nebenzählern.
versorgerbeliebigVersorger bzw. Messdienst.
vertrags_nrbeliebigVertrags- oder Kundennummer beim Versorger.
ableseintervallmonatlich | quartalsweise | halbjaehrlich | jaehrlichWie oft abgelesen wird. Vorgabe jaehrlich.
notizbeliebigFreitext.
statusaktiv | inaktivinaktiv für einen ausgebauten Zähler. Vorgabe aktiv.
fernablesungunbekannt | nein | ja | ja_smgwFernablesbar nach § 5 HeizkostenV: ja, ja_smgw (über Smart-Meter-Gateway), nein; Vorgabe unbekannt.
einbau_ambeliebigEinbaudatum (YYYY-MM-DD).
eichjahrbeliebigJahr der Eichung — daraus rechnet sich die Eichfrist.
geraete_anzahlintegerNur beim Satz Heizkostenverteiler: Zahl der Geräte in der Einheit.
raum_idbeliebigUUID eines Raums der Einheit (einheit_raeume_lesen) — nur bei einem Zähler an einer Einheit, nicht zusammen mit heizkoerper_id. null löst die Zuordnung.
heizkoerper_idbeliebigUUID eines Heizkörpers der Einheit (einheit_raeume_lesen) für einen einzelnen Heizkostenverteiler (geraete_anzahl 1); der Raum folgt dem Heizkörper. Ein Heizkörper trägt höchstens einen laufenden Verteiler. null löst die Zuordnung.
zaehler_aktualisierenSchreibenÄndert einen Zähler (id aus zaehler_auflisten) — nur die übergebenen Felder, etwa Einbauort, Zählernummer nach einem Tausch, Eichjahr oder Status inaktiv für einen ausgebauten Zähler.Zaehler:UpdateBearbeiten

PATCH /api/v1/partner/zaehler/:id

Ändert einen Zähler (id aus zaehler_auflisten) — nur die übergebenen Felder, etwa Einbauort, Zählernummer nach einem Tausch, Eichjahr oder Status inaktiv für einen ausgebauten Zähler. Wer einen Nebenzähler umhängt, schickt parent_zaehler_id; der Hauptzähler muss dieselbe Zuordnung haben. Braucht Zaehler:Update.

Parameter von zaehler_aktualisieren
ParameterTypBeschreibung
id PflichtstringUUID des Zählers (z. B. aus der jeweiligen Liste).
eigentumkauf | mieteKauf oder Miete je Gerät — nur in Heizkosten-Mandanten (sonst Fehler 422); beim Anlegen ohne Angabe gilt die Vorgabe des Auftrags, beim Zählerwechsel erbt der neue Zähler das Eigentum des alten.
objekt_idbeliebigObjekt-Nr. — für Zähler am Haus. Nicht zusammen mit einheit_id.
einheit_idbeliebigUUID der Einheit (einheiten_auflisten) — für Zähler in der Wohnung. Nicht zusammen mit objekt_id.
zaehlernummerstringZählernummer vom Gerät — je Objekt bzw. Einheit eindeutig.
zaehlernamebeliebigBezeichnung, z. B. "Kaltwasser Bad".
zaehlertypstrom | wasser_kalt | wasser_warm | gas | waerme | oel | heizkostenverteiler | sonstigesZählerart.
masseinheitkWh | m3 | MWh | l | stueckMaßeinheit des Stands (m3 für Wasser und Gas, kWh für Strom und Wärme, stueck für Heizkostenverteiler).
lagebeliebigEinbauort, z. B. "Keller, Raum 3" oder "Bad".
ist_nebenzaehlerbooleantrue für einen Nebenzähler (dann parent_zaehler_id Pflicht). Vorgabe false.
parent_zaehler_idbeliebigUUID des Hauptzählers — nur bei Nebenzählern.
versorgerbeliebigVersorger bzw. Messdienst.
vertrags_nrbeliebigVertrags- oder Kundennummer beim Versorger.
ableseintervallmonatlich | quartalsweise | halbjaehrlich | jaehrlichWie oft abgelesen wird. Vorgabe jaehrlich.
notizbeliebigFreitext.
statusaktiv | inaktivinaktiv für einen ausgebauten Zähler. Vorgabe aktiv.
fernablesungunbekannt | nein | ja | ja_smgwFernablesbar nach § 5 HeizkostenV: ja, ja_smgw (über Smart-Meter-Gateway), nein; Vorgabe unbekannt.
einbau_ambeliebigEinbaudatum (YYYY-MM-DD).
eichjahrbeliebigJahr der Eichung — daraus rechnet sich die Eichfrist.
geraete_anzahlintegerNur beim Satz Heizkostenverteiler: Zahl der Geräte in der Einheit.
raum_idbeliebigUUID eines Raums der Einheit (einheit_raeume_lesen) — nur bei einem Zähler an einer Einheit, nicht zusammen mit heizkoerper_id. null löst die Zuordnung.
heizkoerper_idbeliebigUUID eines Heizkörpers der Einheit (einheit_raeume_lesen) für einen einzelnen Heizkostenverteiler (geraete_anzahl 1); der Raum folgt dem Heizkörper. Ein Heizkörper trägt höchstens einen laufenden Verteiler. null löst die Zuordnung.
zaehlerstand_eintragenSchreibenTrägt einen Zählerstand ein, wie der Verwalter ihn abliest (nicht für Meldungen von Mietern — dafür zaehlerstand_uebernehmen).Zaehlerstand:CreateBearbeiten

POST /api/v1/partner/zaehler/:id/staende

Trägt einen Zählerstand ein, wie der Verwalter ihn abliest (nicht für Meldungen von Mietern — dafür zaehlerstand_uebernehmen). Ein Wert unter dem letzten früheren Stand wird mit 422 abgewiesen; nach einem Zählertausch oder Überlauf reset=true setzen. Ein zweiter Stand am selben Tag wird mit 409 abgewiesen. Die Antwort meldet auffaellig=true, wenn der Verbrauch seit dem letzten Stand über dem Dreifachen des üblichen liegt — das sperrt nichts, ist aber einer Rückfrage wert. Braucht Zaehlerstand:Create.

Parameter von zaehlerstand_eintragen
ParameterTypBeschreibung
id PflichtstringUUID des Zählers (z. B. aus der jeweiligen Liste).
ablesedatum PflichtstringTag der Ablesung (YYYY-MM-DD).
wert PflichtnumberAbgelesener Stand in der Maßeinheit des Zählers.
ablesetypturnus | einzug | auszug | manuellAnlass: turnus (regelmäßige Ablesung), einzug, auszug oder manuell (Vorgabe).
notizstringNotiz zum Stand, etwa „Zählertausch, alter Endstand 1234".
resetbooleantrue, wenn der Stand nach Tausch oder Überlauf kleiner sein darf als der vorige.
messstellen_auflistenLesenListet die Messstellen des Mandanten wie die Liste unter Technik › Zähler im Portal.Messstelle:ReadLesen

GET /api/v1/partner/messstellen

Listet die Messstellen des Mandanten wie die Liste unter Technik › Zähler im Portal. Eine Messstelle ist die dauerhafte Stelle (Marktlokation), der Zähler das Gerät darunter — nach einem Zählerwechsel bleibt die Messstelle. Je Messstelle: id, Sparte, Bezeichnung, Marktlokation, Objekt bzw. Einheit (ohne Einheit hängt sie am ganzen Haus), Status (aktiv oder stillgelegt), der aktuelle Zähler (zaehler_id, zaehlernummer, einbau_am, eichjahr samt Eichfrist), die Zahl der Zähler bisher und der letzte Stand mit Datum. Ohne Versorger, Vertragsdaten und Preise — die liefert versorgungsvertraege_auflisten (mit messstelle_id). Die id ist der Parameter von messstelle_lesen und zaehler_wechseln. Bei einer Rolle nur auf Einheiten erscheinen nur die Messstellen an ihren Einheiten. Braucht Messstelle:Read.

Parameter von messstellen_auflisten
ParameterTypBeschreibung
objekt_nrintegerNur Messstellen dieses Objekts (Objekt-Nr.), auch die an seinen Einheiten.
einheit_idstringUUID der Einheit (nur deren Messstellen) (z. B. aus der jeweiligen Liste).
spartestrom | wasser_kalt | wasser_warm | gas | waerme | oel | heizkostenverteiler | sonstigesNur diese Sparte.
statusaktiv | stillgelegtNur aktive bzw. stillgelegte Messstellen.
searchstringTeil der Bezeichnung, der Marktlokation oder einer Zählernummer (auch eines ausgebauten Zählers).
limitintegerHöchstens so viele (Vorgabe 200).
offsetintegerSo viele überspringen.
messstelle_lesenLesenLiest eine Messstelle (id aus messstellen_auflisten) im Detail: alle Zähler bisher in der Reihenfolge des Einbaus (Zählernummer, Einbau, Ausbau, Anfangs- und Endstand, Wechselgrund, welchen Zähler er ersetzt hat, Eichfrist), alle Stände und der Verbrauch der letzten zwölf Monate — über Zählerwechsel hinweg durchgehend gerechnet.Messstelle:ReadLesen

GET /api/v1/partner/messstellen/:id

Liest eine Messstelle (id aus messstellen_auflisten) im Detail: alle Zähler bisher in der Reihenfolge des Einbaus (Zählernummer, Einbau, Ausbau, Anfangs- und Endstand, Wechselgrund, welchen Zähler er ersetzt hat, Eichfrist), alle Stände und der Verbrauch der letzten zwölf Monate — über Zählerwechsel hinweg durchgehend gerechnet. Ohne Versorger, Verträge und Preise (dafür versorgungsvertraege_auflisten mit messstelle_id). Eine Messstelle außerhalb des Mandanten oder der Rolle ist 404. Braucht Messstelle:Read.

Parameter von messstelle_lesen
ParameterTypBeschreibung
id PflichtstringUUID der Messstelle (z. B. aus der jeweiligen Liste).
zaehler_wechselnSchreibenWechselt den Zähler einer Messstelle (id aus messstellen_auflisten): Der alte Zähler bekommt Ausbau und Endstand, der neue Einbau, Anfangsstand und den Verweis auf den Vorgänger — in einer Transaktion.Messstelle:UpdateBearbeiten

POST /api/v1/partner/messstellen/:id/zaehlerwechsel

Wechselt den Zähler einer Messstelle (id aus messstellen_auflisten): Der alte Zähler bekommt Ausbau und Endstand, der neue Einbau, Anfangsstand und den Verweis auf den Vorgänger — in einer Transaktion. Messstelle, Marktlokation und Nebenzähler bleiben; der Verbrauch läuft über den Wechsel durchgehend. Pflicht: wechseldatum (nicht in der Zukunft, nicht vor dem Einbau des alten Zählers), endstand des alten, neue_zaehlernummer und grund; anfangsstand des neuen ist 0, wenn er fehlt. Ein Endstand unter dem letzten Stand des alten Zählers wird mit 422 abgewiesen, eine Zählernummer, die es im Mandanten schon gibt (auch an einem ausgebauten Zähler), und eine stillgelegte Messstelle mit 409; ein abweichender Stand am Wechseltag ebenfalls 409. Stände nach dem Wechseldatum sperren nicht, die Antwort nennt sie unter hinweise. Die Nebenkosten- und Heizkostenabrechnung liest eigene Zählerstände (nk_zaehlerstaende) und wird vom Wechsel nicht berührt. Zurücknehmen, eine Messstelle anlegen oder stilllegen gibt es nur im Portal. Braucht Messstelle:Update.

Parameter von zaehler_wechseln
ParameterTypBeschreibung
id PflichtstringUUID der Messstelle (z. B. aus der jeweiligen Liste).
wechseldatum PflichtstringTag des Wechsels (YYYY-MM-DD) — Ausbau und Einbau liegen an diesem Tag.
endstand PflichtnumberStand des alten Zählers beim Ausbau, in der Maßeinheit der Messstelle.
neue_zaehlernummer PflichtstringZählernummer des neuen Geräts — im Mandanten einmalig.
anfangsstandnumberStand des neuen Zählers beim Einbau (Vorgabe 0).
grund Pflichteichfrist | defekt | smart_meter | fernablesung | sonstigesAnlass des Wechsels.
eichjahrbeliebigEichjahr des neuen Zählers — daraus rechnet sich seine Eichfrist.
fernablesungunbekannt | nein | ja | ja_smgwFernablesbarkeit des neuen Zählers (§ 5 HeizkostenV).
geraete_anzahlintegerNur beim Satz Heizkostenverteiler: Zahl der Geräte in der Einheit.
versorgungsvertraege_auflistenLesenListet die Versorgungsverträge des Mandanten (Strom, Gas, Wasser, Wärme, Öl, sonstige) mit Versorger, Art, Vertrags- und Kundennummer, Tarif, Beginn, Ende, Kündigungsfrist in Tagen, gekündigt am, dem errechneten Stand (anzeige_stand, etwa aktiv, gekündigt, beendet), dem spätesten Kündigungstag, den aktuellen Preisen (Abschlag, Grundpreis, Arbeitspreis) und den zugeordneten Messstellen.Versorgung:ReadLesen

GET /api/v1/partner/versorgungsvertraege

Listet die Versorgungsverträge des Mandanten (Strom, Gas, Wasser, Wärme, Öl, sonstige) mit Versorger, Art, Vertrags- und Kundennummer, Tarif, Beginn, Ende, Kündigungsfrist in Tagen, gekündigt am, dem errechneten Stand (anzeige_stand, etwa aktiv, gekündigt, beendet), dem spätesten Kündigungstag, den aktuellen Preisen (Abschlag, Grundpreis, Arbeitspreis) und den zugeordneten Messstellen. Ein Versorgerwechsel bleibt als Vorgänger-Kette in der Historie: der bisherige Vertrag steht weiter in der Liste. Beinhaltet Vertragsdaten und Preise, deshalb ein eigenes Recht: Braucht Versorgung:Read (Messstelle:Read genügt nicht). Verträge hängen am Objekt; eine Rolle nur auf Einheiten sieht keine. Die id eines Vertrags ist alter_vertrag_id von versorger_wechseln.

Parameter von versorgungsvertraege_auflisten
ParameterTypBeschreibung
objekt_nrintegerNur Verträge dieses Objekts (Objekt-Nr.).
spartestrom | gas | wasser | waerme | oel | sonstigesNur diese Sparte.
messstelle_idstringUUID der Messstelle (nur Verträge, die ihr zugeordnet sind oder waren) (z. B. aus der jeweiligen Liste).
searchstringTeil von Versorger, Vertragsnummer oder Tarif.
limitintegerHöchstens so viele (Vorgabe 200).
offsetintegerSo viele überspringen.
versorgung_handlungsbedarf_lesenLesenWas bei den Versorgungsverträgen als Nächstes zu tun ist, nach Datum sortiert: ohne_vertrag (aktive Messstelle des Hauses hat heute keinen Liefervertrag und keinen Nachfolger), kuendigungsfrist (der späteste Kündigungstag liegt innerhalb von tage), wechsel_laeuft (angebahnter oder bestätigter, noch nicht begonnener Vertrag) und endet (gekündigt, Ende steht fest).Versorgung:ReadLesen

GET /api/v1/partner/versorgungsvertraege/handlungsbedarf

Was bei den Versorgungsverträgen als Nächstes zu tun ist, nach Datum sortiert: ohne_vertrag (aktive Messstelle des Hauses hat heute keinen Liefervertrag und keinen Nachfolger), kuendigungsfrist (der späteste Kündigungstag liegt innerhalb von tage), wechsel_laeuft (angebahnter oder bestätigter, noch nicht begonnener Vertrag) und endet (gekündigt, Ende steht fest). Je Eintrag art, datum, objekt_nr, Vertrag bzw. Messstelle, Versorger, Sparte. Nur lesen: Gekündigt oder gewechselt wird mit versorger_wechseln. Braucht Versorgung:Read.

Parameter von versorgung_handlungsbedarf_lesen
ParameterTypBeschreibung
objekt_nrintegerNur dieses Objekt (Objekt-Nr.).
tageintegerVorlauf in Tagen für Kündigungsfristen (Vorgabe 120).
versorgung_abschlagsplan_lesenLesenDer Abschlagsplan eines Versorgungsvertrags: die Fassungen (gültig ab, Rhythmus, Rate, Fälligkeitstag, Zahlungsweise), die Termine eines Jahres mit Betrag und Stand (aktiv, ausgesetzt, ersetzt), Kontierung, Kreditor, Mandatsreferenz und die Einstellungen (Abschläge als Erwartung oder Posten, Vorsteuerabzug).Versorgung:ReadLesen

GET /api/v1/partner/versorgungsvertraege/:encodeURIComponent/abschlagsplan

Der Abschlagsplan eines Versorgungsvertrags: die Fassungen (gültig ab, Rhythmus, Rate, Fälligkeitstag, Zahlungsweise), die Termine eines Jahres mit Betrag und Stand (aktiv, ausgesetzt, ersetzt), Kontierung, Kreditor, Mandatsreferenz und die Einstellungen (Abschläge als Erwartung oder Posten, Vorsteuerabzug). Zahlungsstand, Ausgleiche, Summen und Befunde (Bankstand) stehen nur mit dem zusätzlichen Scope Versorgungszahlung:Read in der Antwort, sonst sind sie null bzw. leer. Zieht fehlende Termine bis 24 Monate voraus nach; schreibt sonst nichts. Braucht Versorgung:Read. Die vertrag_id ist die id aus versorgungsvertraege_auflisten; ein Vertrag außerhalb des Mandanten oder der Rolle ist 404.

Parameter von versorgung_abschlagsplan_lesen
ParameterTypBeschreibung
vertrag_id PflichtstringUUID des Versorgungsvertrags (versorgungsvertraege_auflisten) (z. B. aus der jeweiligen Liste).
jahrintegerJahr der Termine; Vorgabe das laufende, sonst das jüngste mit Terminen.
versorgung_abschlagsplan_setzenSchreibenLegt eine neue Fassung des Abschlagsplans an (etwa nach einer Preisanpassung oder einer Jahresrechnung): gültig ab einem Tag, mit Rhythmus, Rate in Cent, Fälligkeitstag und Zahlungsweise.Versorgung:UpdateBearbeiten

POST /api/v1/partner/versorgungsvertraege/:encodeURIComponent/abschlagsplan/fassungen

Legt eine neue Fassung des Abschlagsplans an (etwa nach einer Preisanpassung oder einer Jahresrechnung): gültig ab einem Tag, mit Rhythmus, Rate in Cent, Fälligkeitstag und Zahlungsweise. Offene (unbezahlte) Termine ab diesem Tag werden durch die neuen ersetzt, bezahlte bleiben; die Preisstände des Vertrags ziehen mit. Eine Fassung wird nie überschrieben — gibt es für den Tag schon eine, antwortet der Server mit 409. Bei Rhythmus individuell stehen die Termine (faellig_am, betrag_cent) im Rumpf. Das Tool ordnet keine Zahlungen zu, bucht nichts und ändert weder Kontierung noch Kreditor; die Quelle ist immer hand. Braucht Versorgung:Update. Antwort: die neue Fassung und der Plan danach.

Parameter von versorgung_abschlagsplan_setzen
ParameterTypBeschreibung
vertrag_id PflichtstringUUID des Versorgungsvertrags (versorgungsvertraege_auflisten) (z. B. aus der jeweiligen Liste).
gueltig_ab PflichtstringTag, ab dem der neue Abschlag gilt (YYYY-MM-DD).
rhythmus Pflichtmonatlich | zweimonatlich | quartalsweise | halbjaehrlich | jaehrlich | individuellWie oft der Versorger einzieht.
rate_centbeliebigAbschlag je Zahlung in Cent (nicht bei individuell).
faellig_tagbeliebigTag im Monat, an dem eingezogen wird; in kürzeren Monaten der letzte Tag.
zahlungsweiselastschrift | dauerauftrag | ueberweisung | nullZahlungsweise.
beleg_idbeliebigBeleg, aus dem der Abschlag stammt (Nr. des Belegs).
notizbeliebigNotiz zur Fassung.
termineListe (object)Nur bei individuell: die Termine der Fassung.
versorgung_termine_lesenLesenDie Abschlagstermine eines Vertrags mit Bankstand: je Termin Fälligkeit, Betrag, bezahlt/offen/fehlt/erwartet, die zugeordneten Ausgleiche (Buchungstag, Betrag, Verwendungszweck, Rücklastschrift), dazu Summen des Jahres, Befunde (Zahlung fehlt, Abschlag weicht ab, Rücklastschrift, doppelter Einzug …) und zuordnung_fehlt.Versorgungszahlung:ReadLesen mit Kontaktdaten

GET /api/v1/partner/versorgungsvertraege/:encodeURIComponent/abschlagstermine

Die Abschlagstermine eines Vertrags mit Bankstand: je Termin Fälligkeit, Betrag, bezahlt/offen/fehlt/erwartet, die zugeordneten Ausgleiche (Buchungstag, Betrag, Verwendungszweck, Rücklastschrift), dazu Summen des Jahres, Befunde (Zahlung fehlt, Abschlag weicht ab, Rücklastschrift, doppelter Einzug …) und zuordnung_fehlt. Enthält Bankdaten, deshalb ein eigenes Recht: Braucht Versorgungszahlung:Read (setzt Vertrag lesen und Bankkonten lesen voraus). Nur lesen — Zahlungen den Terminen zuordnen oder lösen geht ausschließlich im Portal (Reiter „Abschläge“ des Vertrags, Bankumsatz).

Parameter von versorgung_termine_lesen
ParameterTypBeschreibung
vertrag_id PflichtstringUUID des Versorgungsvertrags (versorgungsvertraege_auflisten) (z. B. aus der jeweiligen Liste).
jahrintegerJahr der Termine; Vorgabe das laufende.
versorgung_jahresrechnungen_lesenLesenDie erfassten Jahres-, Schluss-, Zwischen- und Korrekturrechnungen eines Versorgungsvertrags: Zeitraum, Rechnungsdatum, Brutto, Abschläge laut Versorger, Ergebnis (positiv Nachzahlung, negativ Guthaben), Stand, Quelle (hand, beleglesung oder ki), Positionen je Zähler und das Guthaben.Versorgung:ReadLesen

GET /api/v1/partner/versorgungsvertraege/:encodeURIComponent/jahresrechnungen

Die erfassten Jahres-, Schluss-, Zwischen- und Korrekturrechnungen eines Versorgungsvertrags: Zeitraum, Rechnungsdatum, Brutto, Abschläge laut Versorger, Ergebnis (positiv Nachzahlung, negativ Guthaben), Stand, Quelle (hand, beleglesung oder ki), Positionen je Zähler und das Guthaben. Die Abstimmung gegen unsere Zahlungen steht nur mit zusätzlich Versorgungszahlung:Read in der Antwort (sonst null). Der Prüfstand des Postens der Nachzahlung gehört nicht dazu. Braucht Versorgung:Read.

Parameter von versorgung_jahresrechnungen_lesen
ParameterTypBeschreibung
vertrag_id PflichtstringUUID des Versorgungsvertrags (versorgungsvertraege_auflisten) (z. B. aus der jeweiligen Liste).
versorgung_jahresrechnung_erfassenSchreibenErfasst die Jahres-, Schluss-, Zwischen- oder Korrekturrechnung eines Versorgers aus den Zahlen der Rechnung (Quelle ki).Versorgungszahlung:ErfassenBearbeiten

POST /api/v1/partner/versorgungsvertraege/:encodeURIComponent/jahresrechnungen

Erfasst die Jahres-, Schluss-, Zwischen- oder Korrekturrechnung eines Versorgers aus den Zahlen der Rechnung (Quelle ki). Gebucht wird nur die Spitze (brutto_cent minus abschlaege_laut_versorger_cent): eine Nachzahlung als Entwurf im Stapel und offener Posten, der wie jede Eingangsrechnung in die Prüfung geht, ein Guthaben als Entwurf, kein Posten. Das Tool gibt nichts frei, zahlt nichts, schreibt keine Abschläge um und übernimmt keinen vorhandenen Posten; freigegeben wird im Portal durch einen Menschen. Ein neuer_plan legt zusätzlich eine neue Fassung des Abschlagsplans an. Der Vertrag braucht vorher einen Kreditor und eine Kontierung (sonst 422 mit dem Weg im Portal). Pro Beleg nur eine Rechnung (409). Stornieren geht nur im Portal. Braucht Versorgungszahlung:Erfassen (setzt Vertrag ändern und Belege buchen voraus). Beträge in Cent.

Parameter von versorgung_jahresrechnung_erfassen
ParameterTypBeschreibung
vertrag_id PflichtstringUUID des Versorgungsvertrags (versorgungsvertraege_auflisten) (z. B. aus der jeweiligen Liste).
artjahresrechnung | schlussrechnung | zwischenrechnung | korrekturArt der Rechnung; eine Korrektur nennt korrigiert_id.
zeitraum_von PflichtstringBeginn des Abrechnungszeitraums (YYYY-MM-DD).
zeitraum_bis PflichtstringEnde des Abrechnungszeitraums (YYYY-MM-DD).
rechnungsdatumbeliebigDatum der Rechnung.
rechnungsnummerbeliebigRechnungsnummer.
beleg_idbeliebigBeleg, aus dem die Zahlen stammen (Nr. des Belegs).
netto_centbeliebigNetto in Cent.
steuer_centbeliebigUmsatzsteuer in Cent.
brutto_cent PflichtintegerGesamtbetrag der Rechnung brutto in Cent.
abschlaege_laut_versorger_cent PflichtintegerAbschläge, die der Versorger für den Zeitraum anrechnet, in Cent.
ergebnis_centbeliebigOptional: brutto minus Abschläge (positiv Nachzahlung). Der Server rechnet selbst; eine Abweichung ist 400.
faellig_ambeliebigFälligkeit der Nachzahlung.
vertragskontobeliebigVertragskonto bzw. Zählernummer laut Rechnung — nur für die Abstimmung.
notizbeliebigNotiz.
korrigiert_idbeliebigNur bei Korrektur: UUID der ersetzten Rechnung (versorgung_jahresrechnungen_lesen).
positionenListe (object)Zählerpositionen der Rechnung; die Zählernummer wird auf unseren Zähler aufgelöst, soweit eindeutig.
neuer_planbeliebigDer neue Abschlag laut Rechnung; nicht bei Schlussrechnung.
versorger_sollstellung_vorschauLesenWas der Abschlagslauf für einen Monat stellen würde: die Abschlagstermine der Versorger mit Betrag und Kontierung, die Überleitung (Termine, die vorher als Erwartung galten) und das Nicht-Stellbare mit Grund (etwa Vertrag ohne Kreditor oder ohne Kontierung).Versorgungszahlung:ReadLesen mit Kontaktdaten

GET /api/v1/partner/versorger-sollstellung/vorschau

Was der Abschlagslauf für einen Monat stellen würde: die Abschlagstermine der Versorger mit Betrag und Kontierung, die Überleitung (Termine, die vorher als Erwartung galten) und das Nicht-Stellbare mit Grund (etwa Vertrag ohne Kreditor oder ohne Kontierung). Schreibt nichts. Braucht Versorgungszahlung:Read (setzt Vertrag lesen und Bankkonten lesen voraus). Zeigt nur die Objekte, die die Rolle sehen darf; eine Rolle nur auf Einheiten bekommt 404. Gestellt wird mit versorger_sollstellung_lauf_starten.

Parameter von versorger_sollstellung_vorschau
ParameterTypBeschreibung
monat PflichtstringMonat im Format JJJJ-MM.
versorger_sollstellung_laeufeLesenDie Historie der Abschlagsläufe (bis 200, neueste zuerst): je Lauf Monat, Stand (auch zurückgenommen), Zahl und Summe der gestellten Termine, Zeitpunkt und Akteur.Versorgungszahlung:ReadLesen mit Kontaktdaten

GET /api/v1/partner/versorger-sollstellung/laeufe

Die Historie der Abschlagsläufe (bis 200, neueste zuerst): je Lauf Monat, Stand (auch zurückgenommen), Zahl und Summe der gestellten Termine, Zeitpunkt und Akteur. Mit der id eines Laufs liefert versorger_sollstellung_lauf_lesen seine Akte. Schreibt nichts. Braucht Versorgungszahlung:Read. Mit Objektgrenze zählen Anzahl und Summe nur die Termine der erlaubten Häuser.

versorger_sollstellung_lauf_lesenLesenDie Akte eines Abschlagslaufs: Kopfdaten, Überleitung und die gestellten Termine (Termin, Vertrag, Objekt, Versorger, Sparte, Fälligkeit, Betrag, Konten, Kreditor-Nr.).Versorgungszahlung:ReadLesen mit Kontaktdaten

GET /api/v1/partner/versorger-sollstellung/laeufe/:encodeURIComponent

Die Akte eines Abschlagslaufs: Kopfdaten, Überleitung und die gestellten Termine (Termin, Vertrag, Objekt, Versorger, Sparte, Fälligkeit, Betrag, Konten, Kreditor-Nr.). Die id steht in versorger_sollstellung_laeufe. Ein Lauf, den es nicht gibt oder der außerhalb der Rolle liegt, ist 404. Schreibt nichts. Braucht Versorgungszahlung:Read.

Parameter von versorger_sollstellung_lauf_lesen
ParameterTypBeschreibung
lauf_id PflichtstringUUID des Laufs (versorger_sollstellung_laeufe) (z. B. aus der jeweiligen Liste).
versorger_sollstellung_lauf_startenSchreibenFührt den Abschlagslauf für einen Monat aus: stellt zu den fälligen Abschlagsterminen der Versorger den offenen Posten beim Kreditor und den Buchungssatz im Stapel.Versorgung:SollstellungBearbeiten

POST /api/v1/partner/versorger-sollstellung/lauf

Führt den Abschlagslauf für einen Monat aus: stellt zu den fälligen Abschlagsterminen der Versorger den offenen Posten beim Kreditor und den Buchungssatz im Stapel. Die Sätze bleiben vorgeschlagen — geprüft, freigegeben und festgeschrieben wird nur im Portal durch einen Menschen; das Tool gibt nichts frei. Termine, die sich nicht stellen lassen (Vertrag ohne Kreditor oder Kontierung), stehen mit Grund in der Antwort und werden nicht gestellt; nach der Korrektur holt versorger_sollstellung_nachstellen sie nach. Ein Lauf gilt für den ganzen Mandanten: Mit einer auf Objekte begrenzten Rolle antwortet der Server mit 409 und schreibt nichts. Vorher versorger_sollstellung_vorschau ansehen. Braucht Versorgung:Sollstellung (setzt Verträge lesen, Offene Posten lesen und Buchungssätze anlegen voraus).

Parameter von versorger_sollstellung_lauf_starten
ParameterTypBeschreibung
monat PflichtstringMonat im Format JJJJ-MM.
versorger_sollstellung_nachstellenSchreibenStellt die Termine eines Monats nach, die der Abschlagslauf nicht stellen konnte (etwa weil der Kreditor oder die Kontierung des Vertrags fehlte und inzwischen gesetzt ist).Versorgung:SollstellungBearbeiten

POST /api/v1/partner/versorger-sollstellung/nachstellen

Stellt die Termine eines Monats nach, die der Abschlagslauf nicht stellen konnte (etwa weil der Kreditor oder die Kontierung des Vertrags fehlte und inzwischen gesetzt ist). Bereits gestellte Termine bleiben unberührt. Wie der Lauf: Die Sätze bleiben vorgeschlagen, freigegeben wird nur im Portal; mit begrenzter Rolle 409. Braucht Versorgung:Sollstellung.

Parameter von versorger_sollstellung_nachstellen
ParameterTypBeschreibung
monat PflichtstringMonat im Format JJJJ-MM.
versorger_sollstellung_zuruecknehmenSchreibenNimmt einen ganzen Abschlagslauf zurück: die Sätze werden verworfen, die Posten storniert, die Termine stehen wieder ohne Posten da — in einer Transaktion.Versorgung:SollstellungBearbeiten

POST /api/v1/partner/versorger-sollstellung/laeufe/:encodeURIComponent/zuruecknehmen

Nimmt einen ganzen Abschlagslauf zurück: die Sätze werden verworfen, die Posten storniert, die Termine stehen wieder ohne Posten da — in einer Transaktion. Geht nur, solange kein Satz festgeschrieben und kein Posten bezahlt oder ausgeglichen ist; sonst 409 mit den Terminen, die es verhindern (dann erst im Portal bzw. in der Bank lösen). Ein schon zurückgenommener Lauf ist 409, ein unbekannter 404; mit einer auf Objekte begrenzten Rolle 409. Die lauf_id steht in versorger_sollstellung_laeufe. Braucht Versorgung:Sollstellung.

Parameter von versorger_sollstellung_zuruecknehmen
ParameterTypBeschreibung
lauf_id PflichtstringUUID des Laufs (versorger_sollstellung_laeufe) (z. B. aus der jeweiligen Liste).
versorger_ohne_kreditor_auflistenLesenDie Versorgungsverträge ohne Kreditor, zusammengefasst je Versorgername: Sparten, Zahl, Objekte, vertrag_ids, je Vertrag ein Vorschlag und je Name ein Gesamtvorschlag (art kreditor oder firma, id, name, grund).Versorgung:ReadLesen

GET /api/v1/partner/versorger-ohne-kreditor

Die Versorgungsverträge ohne Kreditor, zusammengefasst je Versorgername: Sparten, Zahl, Objekte, vertrag_ids, je Vertrag ein Vorschlag und je Name ein Gesamtvorschlag (art kreditor oder firma, id, name, grund). Ohne Kreditor lassen sich die Abschläge nicht als Sollstellung stellen. Vorschläge aus IBAN und Gläubiger-ID der Abbuchungen gibt es nur mit zusätzlich Versorgungszahlung:Read, sonst nur aus dem Namen. Schreibt nichts; zugeordnet wird mit versorger_zuordnen. Braucht Versorgung:Read; nur die Objekte der Rolle, eine Rolle nur auf Einheiten bekommt 404.

versorger_zuordnenSchreibenOrdnet einen Kreditor den Versorgungsverträgen zu, die unter einem Versorgernamen noch keinen haben (versorger_ohne_kreditor_auflisten).Versorgung:UpdateBearbeiten

POST /api/v1/partner/versorger-zuordnen

Ordnet einen Kreditor den Versorgungsverträgen zu, die unter einem Versorgernamen noch keinen haben (versorger_ohne_kreditor_auflisten). Ohne vertrag_ids gilt es für alle Verträge dieses Namens, sonst nur für die genannten. auswahl nennt den Kreditor: {art: "kreditor", id} ist ein vorhandener Kreditor des Mandanten; {art: "firma", id} legt aus einer Firma den Kreditor an (oder nimmt den vorhandenen) — das braucht zusätzlich Kreditor:Create (beim persönlichen Zugang das Portal-Recht „Kreditoren anlegen“), sonst 403. Der Versorgername der Verträge zieht auf den Namen des Kreditors mit. Verträge außerhalb der Rolle bleiben unberührt; gibt es unter dem Namen nichts mehr, ist es 404 und es wird kein Kreditor angelegt. Wiederholbar. Antwort: kreditor und zugeordnet (Zahl der Verträge). Braucht Versorgung:Update.

Parameter von versorger_zuordnen
ParameterTypBeschreibung
versorger_name PflichtstringVersorgername genau so, wie ihn versorger_ohne_kreditor_auflisten nennt.
vertrag_idsListe (string)UUIDs einzelner Verträge; ohne Angabe alle dieses Namens ohne Kreditor.
auswahl Pflichtobject
fremdverwaltung_setzenSchreibenSetzt die Verwaltung der Gemeinschaft an einem Objekt unter Sondereigentumsverwaltung (verwaltungsart sev): eine vorhandene (fremdverwaltung_id) oder eine neue (neu mit name, anschrift, email, telefon).Objekt:UpdateBearbeiten

PUT /api/v1/partner/sev-hausgeld/objekte/:objekt_nr/fremdverwaltung

Setzt die Verwaltung der Gemeinschaft an einem Objekt unter Sondereigentumsverwaltung (verwaltungsart sev): eine vorhandene (fremdverwaltung_id) oder eine neue (neu mit name, anschrift, email, telefon). glaeubiger_id ist die Gläubiger-ID, mit der sie das Hausgeld per Lastschrift einzieht. Mit ab (YYYY-MM-DD) ist es ein Verwalterwechsel: Jede Einheit des Objekts mit erfasstem Hausgeld bekommt ab dem Monat eine neue Fassung mit gleichem Betrag und der neuen Verwaltung; die alte Mandatsreferenz gilt dann nicht weiter. Der Kreditor bleibt die Gemeinschaft (GdWE …) — sie ist Gläubigerin, die Verwaltung vertritt sie. Ein Objekt, das nicht sev ist, wird mit 409 abgewiesen. Braucht Objekt:Update.

Parameter von fremdverwaltung_setzen
ParameterTypBeschreibung
objekt_nr PflichtintegerObjekt-Nr. (Ganzzahl).
fremdverwaltung_idbeliebigUUID einer vorhandenen Verwaltung (sev_hausgeld_lesen nennt die aktuelle).
neubeliebigNeue Verwaltung, wenn es sie im Mandanten noch nicht gibt (gleicher Name: die vorhandene wird ergänzt).
glaeubiger_idbeliebigGläubiger-ID der Lastschrift (DE…ZZZ…).
abbeliebigVerwalterwechsel zum Monat dieses Tages (YYYY-MM-DD).
versorger_wechselnSchreibenWechselt den Versorger an einer oder mehreren Messstellen: legt den neuen Vertrag mit Vorgänger an, kündigt den bisherigen (alter_vertrag_id aus versorgungsvertraege_auflisten) zum Tag kuendigung_zum und ordnet den neuen Vertrag den Messstellen ab seinem Beginn zu — in einer Transaktion.Versorgung:CreateBearbeiten

POST /api/v1/partner/versorgungsvertraege/versorgerwechsel

Wechselt den Versorger an einer oder mehreren Messstellen: legt den neuen Vertrag mit Vorgänger an, kündigt den bisherigen (alter_vertrag_id aus versorgungsvertraege_auflisten) zum Tag kuendigung_zum und ordnet den neuen Vertrag den Messstellen ab seinem Beginn zu — in einer Transaktion. Der bisherige Vertrag bleibt in der Historie; gelöscht wird nichts. Alle messstelle_ids müssen zum selben Objekt gehören (sonst 400); der neue Vertrag gilt dann für alle. Ohne kuendigung_zum wird der bisherige Vertrag nicht gekündigt; ist er unbefristet, wird der Wechsel mit 409 abgewiesen (kuendigung_zum ist dann nötig, spätestens der Tag vor dem Beginn). Lücken ohne Vertrag zwischen den Verträgen werden in luecken und hinweise benannt, nicht geschlossen. Überschneidet sich der neue Vertrag mit einem laufenden derselben Art an einer Messstelle, wird der Wechsel mit 409 abgewiesen und nichts geschrieben. stand angebahnt heißt: Wechsel eingeleitet, noch nicht bestätigt; bestaetigt ist die Vorgabe. zwischenablesung=true legt zum Wechseltag eine Aufgabe an, den Zählerstand abzulesen — ein Stand wird nicht erfunden. Ein Objekt außerhalb der Rolle oder eine Messstelle, die es nicht gibt, ist 404. Kündigen allein, Preisstände ändern und Zuordnungen lösen gibt es nur im Portal. Braucht Versorgung:Create.

Parameter von versorger_wechseln
ParameterTypBeschreibung
messstelle_ids PflichtListe (string)UUIDs der Messstellen (messstellen_auflisten), alle am selben Objekt.
alter_vertrag_idbeliebigUUID des bisherigen Vertrags (versorgungsvertraege_auflisten); null oder weglassen, wenn es keinen gibt.
kuendigung_zumbeliebigTag, zu dem der bisherige Vertrag endet (YYYY-MM-DD).
kuendigung_eingegangen_ambeliebigTag der Kündigung (YYYY-MM-DD); Vorgabe heute.
neuer_vertrag Pflichtobject
zwischenablesungbooleantrue legt eine Aufgabe „Zwischenablesung zum Versorgerwechsel“ am Wechseltag an.

[04]26 Tools

Vermietung

leerstand_auflistenLesenVermietungsstand je Einheit wie im Portal-Schirm Vermietung > Leerstand: vermietet, wird_frei (bewohnt, Mietende im Planungszeitraum, auch gekündigt), leer oder gesperrt (bewusst nicht zu vermieten).Mietvertrag:ReadLesen

GET /api/v1/partner/leerstand

Vermietungsstand je Einheit wie im Portal-Schirm Vermietung > Leerstand: vermietet, wird_frei (bewohnt, Mietende im Planungszeitraum, auch gekündigt), leer oder gesperrt (bewusst nicht zu vermieten). Je Einheit: frei ab, Tage leer, vermietbar ab, Mietername, Nachmieter (gesichert oder reserviert), Vermietungsweg, Rang in der Vermietungsreihenfolge, nächste Schritte. meta enthält Kennzahlen (Leerstandsquote nach Fläche, geschätzte entgangene Kaltmiete je Monat, keine Buchung) und Zähler je Filter für den ganzen Bestand. Filter: Objekt-Nr., Listenfilter, Nutzung, Planungszeitraum. Inaktive Einheiten fehlen. Scope: Mietvertrag:Read.

Parameter von leerstand_auflisten
ParameterTypBeschreibung
pageintegerSeitennummer (ab 1).
pageSizeintegerEinträge pro Seite (max. 200).
objektNrintegerObjekt-Nr. (Ganzzahl).
filterhandlungsbedarf | leer | wird_frei | nachfolge | gesperrt | vermietet | allehandlungsbedarf = Einheiten mit offenem Schritt; nachfolge = Nachmieter gesichert oder reserviert; leer/wird_frei ohne gesicherten Nachmieter.
nutzungalle | wohnen | stellplatzwohnen = Wohnungen, Häuser, Zimmer, Gewerbe; stellplatz = Stellplätze und Garagen.
horizontMonate6 | 12 | 24Planungszeitraum in Monaten; ein Mietende danach gilt als vermietet.
mieterwechsel_lesenLesenDer Mieterwechsel einer Einheit als geführter Fall: von der eingegangenen Kündigung bis zur abgerechneten Kaution des Vormieters, in sieben Phasen (Kündigung, Vor dem Auszug, Auszug, Herrichten, Nachmieter, Einzug, Abrechnen).Mietvertrag:ReadLesen

GET /api/v1/partner/mieterwechsel/:einheitId

Der Mieterwechsel einer Einheit als geführter Fall: von der eingegangenen Kündigung bis zur abgerechneten Kaution des Vormieters, in sieben Phasen (Kündigung, Vor dem Auszug, Auszug, Herrichten, Nachmieter, Einzug, Abrechnen). Liefert Vormieter, Folgevertrag, Planung, Inserat, Kennzahlen (Mietende, Leertage, entgangene Kaltmiete) und alle Schritte mit Stand (erledigt, automatisch_erledigt, dran, wartet, spaeter, entfaellt), Beginn, Frist, Grund und den Verweisen zum Datensatz (kuendigung_id, vertrag_id, inserat_id, uebergabe_id …). `jetzt_dran` nennt die Schritte in der Reihenfolge ihrer Frist, `erster_schritt` den nächsten. Ob ein Schritt erledigt ist, liest der Server aus den vorhandenen Daten; nur Praxisschritte ohne Datenquelle (`haken: true`) lassen sich von Hand abhaken. Der Plan ist reine Auskunft — die Handlungen laufen über die vorhandenen Werkzeuge (mietvertrag_workflow_transition, mietvertrag_anlegen, …). Antwortet mit 404 kein_mieterwechsel, wenn die Einheit vermietet ist und kein Wechsel läuft — es sei denn, `start` ist true. Die Einheiten, bei denen einer läuft, findet leerstand_auflisten. Scope: Mietvertrag:Read.

Parameter von mieterwechsel_lesen
ParameterTypBeschreibung
einheitId PflichtstringUUID der Einheit (aus einheiten_auflisten oder leerstand_auflisten) (z. B. aus der jeweiligen Liste).
startbooleantrue = den Mieterwechsel starten, auch wenn noch keine Kündigung vorliegt: Bei einer vermieteten Einheit wird der laufende Vertrag zum Vormieter, und der Plan beginnt bei „Kündigung erfassen“. Wo schon ein Wechsel läuft oder die Einheit leer ist, ändert es nichts.
uebergabe_nachbereitung_lesenLesenWas nach einer Wohnungsübergabe noch zu tun ist: das Register der Folgen (Protokoll abgelegt, Protokoll an alle Parteien, Zählerstände an Nebenkosten und Bestandszähler, Zählerwechsel im Bestand, Zählerstände nachreichen, Neues vor Ort in die Einheit übernehmen, Versorger, Mängel weitergeben, Mängelliste an den Mieter nach der Vorabnahme, Mängel, die der Mieter selbst behebt, Kaution, Frist für Mängelansprüche, Auszug nach der Vorabnahme, Wohnungsgeberbestätigung, Einzug des Nachmieters, Schlüssel-Differenz) — vor dem Abschluss nur die Unterschrift per Einladung (`phase` durchfuehrung).Uebergabe:ReadLesen

GET /api/v1/partner/uebergaben/:uebergabeId/nachbereitung

Was nach einer Wohnungsübergabe noch zu tun ist: das Register der Folgen (Protokoll abgelegt, Protokoll an alle Parteien, Zählerstände an Nebenkosten und Bestandszähler, Zählerwechsel im Bestand, Zählerstände nachreichen, Neues vor Ort in die Einheit übernehmen, Versorger, Mängel weitergeben, Mängelliste an den Mieter nach der Vorabnahme, Mängel, die der Mieter selbst behebt, Kaution, Frist für Mängelansprüche, Auszug nach der Vorabnahme, Wohnungsgeberbestätigung, Einzug des Nachmieters, Schlüssel-Differenz) — vor dem Abschluss nur die Unterschrift per Einladung (`phase` durchfuehrung). Je Schritt Stand (erledigt, offen, entfaellt), ein Satz dazu, ob der Stand aus den Daten oder von Hand (Haken) kommt, wo es einen gibt der Weg im Portal, die Frist (`frist.datum`, `frist.art`: link, vereinbart, gesetzlich, vertrag) und wo der Schritt erledigt wird (`ort`: app, verwaltung, beide). `erledigt` und `gesamt` zählen ohne entfallene Schritte. Reine Auskunft: Haken und Aktionen gibt es nur im Portal. Die Übergabe-ID nennt der Verlauf am Objekt (objekt_verlauf, Gruppe uebergabe). Scope: Uebergabe:Read.

Parameter von uebergabe_nachbereitung_lesen
ParameterTypBeschreibung
uebergabeId PflichtintegerID der Übergabe (aus dem Verlauf am Objekt).
mieterwechsel_haken_setzenSchreibenHakt einen Praxisschritt des Mieterwechsels ab, lässt ihn mit Begründung entfallen oder nimmt den Haken zurück — derselbe Weg wie die Knöpfe im Mieterwechsel-Fall in immoGenio.Mietvertrag:UpdateBearbeiten

PUT /api/v1/partner/mieterwechsel/:encodeURIComponent/haken/:encodeURIComponent

Hakt einen Praxisschritt des Mieterwechsels ab, lässt ihn mit Begründung entfallen oder nimmt den Haken zurück — derselbe Weg wie die Knöpfe im Mieterwechsel-Fall in immoGenio. `erledigt` nur bei Schritten mit `haken: true` (z. B. Eigentümer gefragt, Zwischenablesung bestellt, Kaution eingegangen), `entfaellt` nur bei Schritten mit `darf_entfallen: true` und mit `grund` (mindestens 8 Zeichen, der Grund steht später im Verlauf), `offen` nimmt einen Haken zurück. Ein Schritt, der in dieser Konstellation ohnehin entfällt, lässt sich nicht abhaken (409). Erledigt nichts in den Daten: Kündigung, Übergaben, Inserat, Vertrag und Kaution gehen weiter über ihre eigenen Werkzeuge. Antwort: der neue Plan wie mieterwechsel_lesen. Vorher mieterwechsel_lesen. Braucht Mietvertrag:Update.

Parameter von mieterwechsel_haken_setzen
ParameterTypBeschreibung
einheitId PflichtstringUUID der Einheit (z. B. aus der jeweiligen Liste).
code PflichtstringSchrittcode aus mieterwechsel_lesen (z. B. hausdienste, eigentuemer_entscheidung, kaution_eingang).
stand Pflichterledigt | entfaellt | offenerledigt = abgehakt, entfaellt = entfällt mit Grund, offen = Haken zurücknehmen.
notizbeliebigNotiz zum Haken (optional, höchstens 2.000 Zeichen).
grundbeliebigPflicht bei stand=entfaellt: warum der Schritt entfällt (mindestens 8 Zeichen).
mietenpruefung_lesenLesenDie Mietenprüfung eines Objekts: Welche Mietverträge des Hauses dürfen jetzt erhöht werden, welche nicht und bis wann — und was läuft schon.Mietvertrag:ReadLesen

GET /api/v1/partner/objekte/:objektNr/mietenpruefung

Die Mietenprüfung eines Objekts: Welche Mietverträge des Hauses dürfen jetzt erhöht werden, welche nicht und bis wann — und was läuft schon. Liefert je Vertrag die Art (mieterhoehung = Vergleichsmiete § 558 BGB, index = Indexmiete § 557b BGB, staffel = Staffelmiete § 557a BGB), die Gruppe (moeglich, index_faellig, staffel_faellig, gesperrt, laeuft), bei gesperrten Verträgen den Grund mit Datum ("Wartefrist bis …", "Indexmiete: zwölf Monate bis …", Mietbeginn fehlt, Gewerbe "laut Vertrag", gekündigt) und bei laufenden Begehren den Stand des Ablaufs mit Zugang, Zustimmungsfrist, Wirksam-ab und Klagefrist. Dazu Indexstand mit Monat und neue Miete (Indexverträge), die nächste Staffelstufe, die Vergleichsmiete der Einheit und die Kappungsgrenze des Objekts mit Quelle (abgesenkt in Gebieten laut Verordnung, mit Ablaufdatum; "unbekannt" mit hartem Rand 20 % und vorsichtigem Wert 15 %, wenn die Verordnung abgelaufen ist; Indexwert älter als drei Monate gilt als veraltet; "möglich" nennt das früheste Gültig-ab). Reine Auskunft: Begehren anlegen, versenden und Zustimmung buchen geschieht im Portal bzw. mit den vorhandenen Werkzeugen (mieterhoehung_historisch_erfassen). Die Objekt-Nr. nennt objekte_auflisten. Namen der Mieter nur mit Scope Mieter:Read. Scopes: Mietvertrag:Read und Objekt:Read.

Parameter von mietenpruefung_lesen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
mietvertraege_auflistenLesenListet Mietverträge (Vertrags-ID, Objekt, Mietername (nur Name), Beginn/Ende, Netto-/NK-/Gesamtmiete, Status).Mietvertrag:ReadLesen

GET /api/v1/partner/mietvertraege

Listet Mietverträge (Vertrags-ID, Objekt, Mietername (nur Name), Beginn/Ende, Netto-/NK-/Gesamtmiete, Status). DSGVO-minimiert: keine Mieter-Kontaktdaten. Ein Vertrag kann mehrere Einheiten umfassen, etwa Wohnung und Stellplatz: `einheiten` listet sie alle mit Rolle (haupt/zusatz) und Zeitraum, `einheitId`/`einheitBezeichnung` nennen die Haupteinheit. Filter: aktiv, Objekt-Nr., Einheit-ID (trifft auch eine mitvermietete Einheit), Mieter-ID, Zeitraum (von/bis nach Mietbeginn). Netto-, NK- und Gesamtmiete gelten nach der Leseregel der Sollstellung (Mietbestandteile) — heute oder mit `standAm` an diesem Tag. Mit `bestandteile: true` trägt jeder Vertrag `bestandteile` (je Sollart der Betrag in Cent), `vorgemerkt` (Beträge, die später gelten), `uebernommenAm` und `marken` (wirkt_nicht: eine Eingabe gilt an keinem Tag; nk_ungeteilt: BK-, aber keine HK-Vorauszahlung). Mit `geaendertSeit` kommen nur Verträge, deren Miete sich ab diesem Tag geändert hat, je mit `aenderungen` (art, ab, sollart, bisherCent, neuCent, wirkt, rueckwirkend, herkunft, erfasstAm, erfasstVon); die Übernahme aus dem Vorsystem ist der Ausgangsstand und zählt nicht. Für „Was hat sich seit der Übernahme geändert?“: geaendertSeit = uebernommenAm.

Parameter von mietvertraege_auflisten
ParameterTypBeschreibung
pageintegerSeitennummer (ab 1).
pageSizeintegerEinträge pro Seite (max. 200).
aktivbooleantrue = nur aktive, false = nur nicht-aktive Verträge.
standAmstringBeträge an diesem Tag (YYYY-MM-DD); Vorgabe heute.
bestandteilebooleantrue = je Vertrag die Mietbestandteile, Vorgemerktes und Marken.
geaendertSeitstringNur Verträge mit einer Änderung der Miete ab diesem Tag (YYYY-MM-DD), samt `aenderungen`.
objektNrintegerNur Verträge dieses Objekts.
einheitIdstringUUID der Einheit — trifft jeden Vertrag, der diese Einheit umfasst, auch als mitvermietete (z. B. aus der jeweiligen Liste).
mieterIdstringUUID des Mieters (z. B. aus der jeweiligen Liste).
vonstringMietbeginn >= Datum (YYYY-MM-DD).
bisstringMietbeginn <= Datum (YYYY-MM-DD).
mietvertrag_detailsLesenZeigt einen einzelnen Mietvertrag mit Objekt, Mietername, Konditionen, Status und workflowId.Mietvertrag:ReadLesen

GET /api/v1/partner/mietvertraege/:vertragsId

Zeigt einen einzelnen Mietvertrag mit Objekt, Mietername, Konditionen, Status und workflowId. Umfasst der Vertrag mehrere Einheiten (Wohnung plus Stellplatz), stehen sie alle in `einheiten`; `einheitId`/`einheitBezeichnung` sind die Haupteinheit. Mieter-Kontaktdaten nur mit Scope Mieter:ReadPII.

Parameter von mietvertrag_details
ParameterTypBeschreibung
vertragsId PflichtstringUUID des Mietvertrags (z. B. aus der jeweiligen Liste).
mietvertrag_anlegenSchreibenLegt einen Mietvertrag an — derselbe Weg wie „Neuer Vertrag" im Portal.Mietvertrag:CreateBearbeiten

POST /api/v1/partner/mietvertraege

Legt einen Mietvertrag an — derselbe Weg wie „Neuer Vertrag" im Portal. Der Mieter muss bestehen (sonst zuerst mieter_anlegen). VORHER mietvertraege_auflisten mit einheitId aufrufen: Steht für die Einheit schon ein Vertrag dieses Mieters, NICHT erneut anlegen — jeder Aufruf erzeugt einen weiteren Vertrag, und doppelte Verträge erzeugen doppelte Mietforderungen. bereitsUnterschrieben=true (Bestand, Mieter wohnt schon): Der Vertrag steht sofort als „Aktiv" (bzw. „Beendet" bei vergangenem Mietende, „Mietvertrag abgeschlossen" bei künftigem Beginn). bereitsUnterschrieben=false (Neuvermietung): Der Vertragsabschluss startet (Entwurf, Unterschrift Vermieter, Unterschrift Mieter) und wird im Portal geführt. Ohne Angabe gilt ein Vertrag mit erreichtem Mietbeginn als unterschrieben. Die Antwort nennt vertragsId und status. Mitvermietete Einheiten und Umsatzsteuer nur im Portal. Ein Stellplatz, eine Garage oder Kabel ohne eigene Einheit gehört in weitereBestandteile (ab Mietbeginn im Soll); heizkostenVorauszahlung teilt nkVorauszahlung in Betriebs- und Heizkosten. Später ändert beides mietvertrag_sollbestandteil_setzen. Meldet der Dienst, dass im Sollarten-Katalog die Betriebs- oder Heizkostenvorauszahlung fehlt: sollarten_standard_anlegen aufrufen, dann erneut anlegen.

Parameter von mietvertrag_anlegen
ParameterTypBeschreibung
einheitId PflichtstringUUID der Einheit (aus einheiten_auflisten oder leerstand_auflisten) (z. B. aus der jeweiligen Liste).
mieterId PflichtstringUUID des Mieters (aus mieter_auflisten oder mieter_anlegen) (z. B. aus der jeweiligen Liste).
vertragstyp PflichtUnmöbliert | Möbliert | Stellplatz | Gewerbe | Pacht | FerienwohnungVertragstyp.
zahlungsartÜberweisung | Überweisung (DKB) | Überweisung (norisbank) | Bar | LohnabzugZahlungsart (Vorgabe Überweisung; Lohnabzug nur bei Werkmietwohnung).
mietbeginn PflichtstringMietbeginn (YYYY-MM-DD).
mietendestringMietende (YYYY-MM-DD); weglassen = unbefristet.
kaltmiete PflichtnumberKaltmiete in Euro je Monat.
nkVorauszahlungnumberNebenkosten-Vorauszahlung bzw. -Pauschale in Euro je Monat.
nkArtvorauszahlung | pauschaleVorauszahlung (mit Jahresabrechnung, Vorgabe) oder Pauschale.
kautionnumberVereinbarte Kaution in Euro (höchstens drei Kaltmieten, § 551 BGB).
kautionHinterlegtBeistringWo die Kaution angelegt ist (z. B. Bank).
mietanpassungsartregulaer | index | staffelMietanpassung (Vorgabe regulaer = Vergleichsmiete).
indexreiheIdintegerNur bei index (Pflicht): Indexreihe.
indexBasisWertnumberNur bei index (Pflicht): Basis-Indexwert.
indexBasisJahrintegerNur bei index (Pflicht): Basisjahr.
indexBasisMonatintegerNur bei index (Pflicht): Basismonat.
bereitsUnterschriebenbooleantrue = schon unterschriebener Bestandsvertrag, false = Neuvermietung mit Vertragsabschluss.
bemerkungenstringBemerkungen (optional).
heizkostenVorauszahlungnumber„davon Heizkosten“: der Teil von nkVorauszahlung, der auf die Heizkosten entfällt, in Euro je Monat. Im Soll steht dann BK = nkVorauszahlung − Anteil und HK = Anteil. Nur bei nkArt vorauszahlung.
weitereBestandteileListe (object)Weitere Teile der Miete ab Mietbeginn — Stellplatz, Garage, Kabel. Grundmiete und Vorauszahlungen stehen in kaltmiete und nkVorauszahlung, nicht hier.
mietvertrag_aktualisierenSchreibenÄndert einen Mietvertrag — derselbe Weg wie „Bearbeiten" im Portal.Mietvertrag:UpdateBearbeiten

PATCH /api/v1/partner/mietvertraege/:vertragsId

Ändert einen Mietvertrag — derselbe Weg wie „Bearbeiten" im Portal. Nur die übergebenen Felder ändern sich, null leert ein Feld (mietende: null = unbefristet). Ein geänderter Mietbeginn verschiebt auch den Beginn der Einheit im Vertrag; danach rechnen Belegung, Leerstand und Nebenkostenabrechnung. Ein Vertrag ohne Mietbeginn bekommt keine Mietforderungen — mit gesetztem Mietbeginn stellt der nächste Sollstellungslauf seine Miete. Für Korrekturen falsch erfasster Daten, NICHT für eine Mieterhöhung (die läuft über ihren eigenen Weg; eine geänderte Kaltmiete greift nicht, wo Mietpreise mit Gültigkeitsdatum stehen). Mieter, Einheit und Stand ändern sich hier nicht: Kündigung und Ende über mietvertrag_workflow_transition. Vorher mietvertrag_details lesen. Braucht Mietvertrag:Update.

Parameter von mietvertrag_aktualisieren
ParameterTypBeschreibung
vertragsId PflichtstringUUID des Mietvertrags (z. B. aus der jeweiligen Liste).
vertragstypUnmöbliert | Möbliert | Stellplatz | Gewerbe | Pacht | FerienwohnungVertragstyp.
zahlungsartÜberweisung | Überweisung (DKB) | Überweisung (norisbank) | Bar | LohnabzugZahlungsart (Lohnabzug nur bei Werkmietwohnung).
mietbeginnstringMietbeginn (YYYY-MM-DD).
mietendebeliebigMietende einer Befristung (YYYY-MM-DD); null = unbefristet.
kaltmietenumberKaltmiete in Euro je Monat.
nkVorauszahlungbeliebigNebenkosten-Vorauszahlung bzw. -Pauschale in Euro je Monat.
nkArtvorauszahlung | pauschaleVorauszahlung (mit Jahresabrechnung) oder Pauschale.
kautionbeliebigVereinbarte Kaution in Euro (höchstens drei Kaltmieten, § 551 BGB).
kautionHinterlegtBeibeliebigWo die Kaution angelegt ist (z. B. Bank).
mietanpassungsartregulaer | index | staffelMietanpassung (regulaer = Vergleichsmiete).
indexreiheIdintegerBei index: Indexreihe.
indexBasisWertnumberBei index: Basis-Indexwert.
indexBasisJahrintegerBei index: Basisjahr.
indexBasisMonatintegerBei index: Basismonat.
bemerkungenbeliebigBemerkungen.
mietvertrag_workflow_statusLesenZeigt den GenioFlow-Status des Vermietungs-Workflows eines Mietvertrags (currentState, isTerminal) + erlaubte Aktionen inkl. Payload-Felder — wie das Workflow-Panel im Portal.Mietvertrag:ReadLesen

GET /api/v1/partner/mietvertraege/:vertragsId/workflow

Zeigt den GenioFlow-Status des Vermietungs-Workflows eines Mietvertrags (currentState, isTerminal) + erlaubte Aktionen inkl. Payload-Felder — wie das Workflow-Panel im Portal. Vor jeder Transition aufrufen.

Parameter von mietvertrag_workflow_status
ParameterTypBeschreibung
vertragsId PflichtstringUUID des Mietvertrags (z. B. aus der jeweiligen Liste).
mietvertrag_workflow_transitionSchreibenFührt EINE GenioFlow-Transition des Vermietungs-Workflows aus (kein Bypass).Mietvertrag:TransitionBearbeiten

POST /api/v1/partner/mietvertraege/:vertragsId/workflow/transition

Führt EINE GenioFlow-Transition des Vermietungs-Workflows aus (kein Bypass). Wichtige Events: kuendigung_eingegangen (Mietvertrag kuendigen — legt die Kündigung an + startet das Kündigungs-Sub-Workflow), kuendigung_widerrufen, einzug_planen, skip_uebergabe, beenden, abbrechen. Pflicht-Payload je Event siehe mietvertrag_workflow_status.

Parameter von mietvertrag_workflow_transition
ParameterTypBeschreibung
vertragsId PflichtstringUUID des Mietvertrags (z. B. aus der jeweiligen Liste).
event PflichtstringAuszulösendes Workflow-Event (muss im aktuellen State erlaubt sein; siehe mietvertrag_workflow_status).
payloadobjectEvent-spezifische Felder (optional; Pflichtfelder siehe payloadSchema aus mietvertrag_workflow_status).
mieterhoehungen_auflistenLesenListet die Mieterhöhungen eines Mietvertrags, jüngste zuerst: id, Status (Begehren, Zugestimmt, Abgelehnt, Zurückgezogen), Datum des Schreibens (begehrenDatum), Zugang, wirksam ab (gueltigAb), neue Kaltmiete, Zustimmung, Rechtsgrundlage, Notiz.Mietvertrag:ReadLesen

GET /api/v1/partner/mietvertraege/:vertragsId/mieterhoehungen

Listet die Mieterhöhungen eines Mietvertrags, jüngste zuerst: id, Status (Begehren, Zugestimmt, Abgelehnt, Zurückgezogen), Datum des Schreibens (begehrenDatum), Zugang, wirksam ab (gueltigAb), neue Kaltmiete, Zustimmung, Rechtsgrundlage, Notiz. Die jüngste zugestimmte Erhöhung ist der Bezugspunkt der 15-Monats-Wartefrist nach § 558 BGB. Braucht Mietvertrag:Read.

Parameter von mieterhoehungen_auflisten
ParameterTypBeschreibung
vertragsId PflichtstringUUID des Mietvertrags (z. B. aus der jeweiligen Liste).
mieterhoehung_historisch_erfassenSchreibenTrägt eine Mieterhöhung ein, die vor immoGenio abgeschlossen wurde — etwa aus einer Liste des Vorsystems.Mieterhoehung:CreateBearbeiten

POST /api/v1/partner/mietvertraege/:vertragsId/mieterhoehungen/historisch

Trägt eine Mieterhöhung ein, die vor immoGenio abgeschlossen wurde — etwa aus einer Liste des Vorsystems. Sie zählt danach als letzte Erhöhung für die Wartefrist. Es geht kein Schreiben hinaus, es startet kein Ablauf, und Soll und Mietpreise bleiben unverändert: Die aktuelle Miete pflegt die Übernahme des Bestands. Die Antwort nennt die Grundmiete laut Soll (sollGrundmiete) und im hinweis, wenn sie von neueKaltmiete abweicht — das ist eine Rückfrage wert. Abgewiesen wird mit 400: ein Schreiben in der Zukunft, eine zugestimmte Erhöhung, die erst künftig wirksam wird (die gehört ins Portal), ein Wirksamkeitstag vor dem Schreiben oder außerhalb der Vertragslaufzeit; mit 409 ein zweiter Eintrag zum selben gueltigAb. Braucht Mieterhoehung:Create.

Parameter von mieterhoehung_historisch_erfassen
ParameterTypBeschreibung
vertragsId PflichtstringUUID des Mietvertrags (z. B. aus der jeweiligen Liste).
begehrenDatum PflichtstringDatum des Erhöhungsschreibens (YYYY-MM-DD).
zugangDatumstringZugang beim Mieter, falls bekannt (YYYY-MM-DD).
gueltigAb PflichtstringAb wann die neue Miete gilt (YYYY-MM-DD).
neueKaltmiete PflichtnumberNeue monatliche Kaltmiete (Grundmiete) in Euro.
status PflichtZugestimmt | Abgelehnt | ZurueckgezogenAusgang der Erhöhung.
zustimmungDatumstringTag der Zustimmung, falls bekannt — nur bei Zugestimmt (YYYY-MM-DD).
rechtsgrundlagestringRechtsgrundlage, Vorgabe „§558 BGB".
notizstringHerkunft und Besonderheiten, etwa „Übernommen aus Liste Mieterhöhungen 2026, bisher 494,62 €".
mietvertrag_sollbestandteile_lesenLesenListet die Mietbestandteile eines Mietvertrags mit Verlauf: je Zeile Sollart (schluessel, bezeichnung), Betrag in Euro, gültig ab/bis, Herkunft (uebernahme, manuell, vertrag, mietpreis), Notiz und gestellt (der Monat steckt schon in einer Sollstellung).Mietvertrag:ReadLesen

GET /api/v1/partner/mietvertraege/:vertragsId/sollbestandteile

Listet die Mietbestandteile eines Mietvertrags mit Verlauf: je Zeile Sollart (schluessel, bezeichnung), Betrag in Euro, gültig ab/bis, Herkunft (uebernahme, manuell, vertrag, mietpreis), Notiz und gestellt (der Monat steckt schon in einer Sollstellung). Je Sollart gilt die Zeile mit dem jüngsten gueltigAb bis heute; ein Betrag 0 heißt: beendet. Zeilen mit gueltigAb in der Zukunft sind vorgemerkt. Das ist die Miete, die die Sollstellung stellt — nicht die Felder kaltmiete/nkVorauszahlung von mietvertrag_details. Braucht Mietvertrag:Read.

Parameter von mietvertrag_sollbestandteile_lesen
ParameterTypBeschreibung
vertragsId PflichtstringUUID des Mietvertrags (z. B. aus der jeweiligen Liste).
mietvertrag_sollbestandteil_setzenSchreibenÄndert einen Mietbestandteil zu einem Datum oder beendet ihn — etwa Vorauszahlung erhöht, Stellplatz gekündigt, Garage dazu.Mietvertrag:UpdateBearbeiten

POST /api/v1/partner/mietvertraege/:vertragsId/sollbestandteile

Ändert einen Mietbestandteil zu einem Datum oder beendet ihn — etwa Vorauszahlung erhöht, Stellplatz gekündigt, Garage dazu. aktion "aendern": neuer Betrag ab gueltigAb (auch für eine Sollart, die der Vertrag noch nicht führt); der bisherige Betrag bleibt bis zum Vortag. aktion "beenden": der Bestandteil entfällt ab dem Tag nach letzterTag. Wird nur einer von mehreren Stellplätzen gekündigt, ist das "aendern" mit dem Restbetrag. Die Grundmiete (schluessel "grundmiete") wird mit 400 abgewiesen — sie ändert sich über Mieterhöhung, Staffel oder Index. Die Schlüssel nennt mietvertrag_sollbestandteile_lesen (z. B. bk_vorauszahlung, hk_vorauszahlung, stellplatz, garage). Ist der Monat schon gestellt, sagt das der hinweis: Dann muss er im Portal nachgestellt werden. Es geht kein Schreiben an den Mieter. Zurücknehmen einer vorgemerkten Änderung geht nur im Portal. Braucht Mietvertrag:Update.

Parameter von mietvertrag_sollbestandteil_setzen
ParameterTypBeschreibung
vertragsId PflichtstringUUID des Mietvertrags (z. B. aus der jeweiligen Liste).
aktion Pflichtaendern | beenden"aendern" = neuer Betrag ab Datum, "beenden" = entfällt nach letzterTag.
schluessel PflichtstringSchlüssel der Sollart, z. B. "stellplatz" oder "bk_vorauszahlung".
betragnumberNur bei "aendern": neuer Monatsbetrag in Euro (netto), z. B. 63.25.
gueltigAbstringNur bei "aendern": ab wann der Betrag gilt (YYYY-MM-DD), meist ein Monatserster.
letzterTagstringNur bei "beenden": letzter Tag, an dem der Bestandteil noch gilt (YYYY-MM-DD).
notizstringAnlass, etwa „Stellplatz Nr. 49 gekündigt zum 30.11.2026“.
mietvertrag_sollbestandteil_korrigierenSchreibenKorrigiert den Betrag eines Mietbestandteils, der von Anfang an falsch erfasst war — etwa eine Vorauszahlung, die aus der Datenübernahme falsch kam oder deren Anpassung von einer jüngeren Zeile überdeckt wird und deshalb nicht wirkt.Mietvertrag:KorrigierenBearbeiten

POST /api/v1/partner/mietvertraege/:vertragsId/sollbestandteile/:bestandteilId/korrektur

Korrigiert den Betrag eines Mietbestandteils, der von Anfang an falsch erfasst war — etwa eine Vorauszahlung, die aus der Datenübernahme falsch kam oder deren Anpassung von einer jüngeren Zeile überdeckt wird und deshalb nicht wirkt. Anders als mietvertrag_sollbestandteil_setzen (neuer Betrag ab einem Datum, der bisherige bleibt als Verlauf) ersetzt das den Betrag der Zeile über ihren ganzen Zeitraum: ab dem Datum der Zeile, das feststeht. Geht für jede Zeile und auch für die Grundmiete (ein Tippfehler ist keine Erhöhung; eine Erhöhung läuft weiter über Mieterhöhung, Staffel oder Index). Schon gestellte Monate werden in derselben Transaktion nachgestellt — die Antwort nennt sie; festgeschriebene Monate bucht die Nachstellung im offenen Monat. entferneUeberdeckte entfernt die von Hand gesetzte Anpassung derselben Sollart, die nie gewirkt hat. bestandteilId (und stand) nennt mietvertrag_sollbestandteile_lesen; weicht stand ab, hat inzwischen jemand anderes geändert (409 veraltet). Es geht kein Schreiben an den Mieter. Braucht Mietvertrag:Korrigieren (Vertrag ändern und Buchungsstapel erstellen).

Parameter von mietvertrag_sollbestandteil_korrigieren
ParameterTypBeschreibung
vertragsId PflichtstringUUID des Mietvertrags (z. B. aus der jeweiligen Liste).
bestandteilId PflichtstringUUID der zu korrigierenden Zeile (aus mietvertrag_sollbestandteile_lesen) (z. B. aus der jeweiligen Liste).
betrag PflichtnumberDer richtige Monatsbetrag in Euro (netto), z. B. 130.49.
anlassstringWarum — erscheint im Änderungsprotokoll, etwa „Tippfehler bei der Übernahme“.
entferneUeberdecktebooleantrue = die wirkungslose, überdeckte Anpassung derselben Sollart entfernen.
standstringDer gelesene stand der Zeile; schützt vor dem Überschreiben einer gleichzeitigen Änderung.
nk_vorauszahlungen_haus_lesenLesenListet für ein Haus die Mietverträge, die am Tag gueltigAb laufen, je mit Einheit, Mieter und den Vorauszahlungen am Vortag (sollartId, Bezeichnung, Betriebs- oder Heizkosten, bisher in Euro).Mietvertrag:ReadLesen

GET /api/v1/partner/objekte/:objektNr/vorauszahlungen

Listet für ein Haus die Mietverträge, die am Tag gueltigAb laufen, je mit Einheit, Mieter und den Vorauszahlungen am Vortag (sollartId, Bezeichnung, Betriebs- oder Heizkosten, bisher in Euro). Grundlage für nk_vorauszahlungen_haus_anpassen — etwa nach einer Betriebskostenabrechnung, wenn sich die Vorauszahlungen aller Mieter zum selben Tag ändern. Braucht Mietvertrag:Read.

Parameter von nk_vorauszahlungen_haus_lesen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
gueltigAb PflichtstringAb wann die neuen Vorauszahlungen gelten sollen (YYYY-MM-DD).
nk_vorauszahlungen_haus_anpassenSchreibenPasst die Vorauszahlungen mehrerer Verträge eines Hauses zum selben Tag an — je Vertrag eine NK-VZ-Anpassung mit Verlauf und Widerspruch, alle in einer Transaktion: Scheitert ein Vertrag, wird nichts geschrieben, und die Meldung nennt Einheit und Mieter.Mietvertrag:UpdateBearbeiten

POST /api/v1/partner/objekte/:objektNr/vorauszahlungen

Passt die Vorauszahlungen mehrerer Verträge eines Hauses zum selben Tag an — je Vertrag eine NK-VZ-Anpassung mit Verlauf und Widerspruch, alle in einer Transaktion: Scheitert ein Vertrag, wird nichts geschrieben, und die Meldung nennt Einheit und Mieter. Je Vertrag die neuen Beträge je Vorauszahlung (sollartId aus nk_vorauszahlungen_haus_lesen); eine Vorauszahlung ohne Angabe bleibt beim bisherigen Betrag. Nur Verträge mitschicken, die sich ändern. Es geht kein Schreiben an die Mieter. Braucht Mietvertrag:Update.

Parameter von nk_vorauszahlungen_haus_anpassen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
gueltigAb PflichtstringAb wann die neuen Beträge gelten (YYYY-MM-DD), meist ein Monatserster.
mitteilungDatum PflichtstringDatum der Mitteilung an die Mieter (YYYY-MM-DD).
zugangDatumstringZugang beim Mieter, falls bekannt (YYYY-MM-DD).
anlassstringAnlass, Vorgabe „NK-Abrechnung“.
notizstring
vertraege PflichtListe (object)
mieter_auflistenLesenListet Mieter (ID, Name, Debitorenkonto, aktiv, Kommunikationskanal, Mietvertrags-Counts).Mieter:ReadLesen

GET /api/v1/partner/mieter

Listet Mieter (ID, Name, Debitorenkonto, aktiv, Kommunikationskanal, Mietvertrags-Counts). Ohne Kontaktdaten (Scope Mieter:Read). Filter: Suche (Name), aktiv.

Parameter von mieter_auflisten
ParameterTypBeschreibung
pageintegerSeitennummer (ab 1).
pageSizeintegerEinträge pro Seite (max. 200).
searchstringNach Name suchen (Teilstring).
aktivbooleanNach Aktiv-Status filtern.
mieter_detailsLesenZeigt einen Mieter mit seinen Mietverträgen.Mieter:ReadLesen

GET /api/v1/partner/mieter/:mieterId

Zeigt einen Mieter mit seinen Mietverträgen. Ein Mieter ist immer genau eine Vertragspartei und ein Debitor: typ person, gemeinschaft (Eheleute, WG — die Menschen stehen in `mitglieder`, je mit wohntSelbst und hatZugang) oder firma. Kontaktdaten (Telefon/E-Mail/Geburtsdatum/Vor-/Nachname, auch der Mitglieder) nur mit Scope Mieter:ReadPII. Bankdaten werden nie geliefert.

Parameter von mieter_details
ParameterTypBeschreibung
mieterId PflichtstringUUID des Mieters (z. B. aus der jeweiligen Liste).
mieter_dokumente_auflistenLesenListet die Dokument-Metadaten eines Mieters (Kategorie, Titel, Größe, Datum) — ohne Dateiinhalt/Download.Mieter:ReadPIILesen mit Kontaktdaten

GET /api/v1/partner/mieter/:mieterId/dokumente

Listet die Dokument-Metadaten eines Mieters (Kategorie, Titel, Größe, Datum) — ohne Dateiinhalt/Download. Erfordert Scope Mieter:ReadPII.

Parameter von mieter_dokumente_auflisten
ParameterTypBeschreibung
mieterId PflichtstringUUID des Mieters (z. B. aus der jeweiligen Liste).
mieter_anlegenSchreibenLegt einen neuen Mieter an (legt zugehöriges Debitorenkonto mit an).Mieter:CreateBearbeiten

POST /api/v1/partner/mieter

Legt einen neuen Mieter an (legt zugehöriges Debitorenkonto mit an). Bankdaten können nicht gesetzt werden.

Parameter von mieter_anlegen
ParameterTypBeschreibung
name PflichtstringVoller Name des Mieters (Pflicht).
debitorenkontostringDebitorenkonto-Nr. (optional).
kontaktTelstringTelefon (optional, PII).
kontaktEmailstringE-Mail (optional, PII).
bemerkungenstringBemerkungen (optional).
mieter_aktualisierenSchreibenAktualisiert einen Mieter (nur übergebene Felder).Mieter:UpdateBearbeiten

PATCH /api/v1/partner/mieter/:mieterId

Aktualisiert einen Mieter (nur übergebene Felder). Vor-/Nachname berechnen den Namen. Keine Bankdaten. Haben mehrere den Vertrag unterschrieben (Eheleute, WG), wird der Mieter eine Gemeinschaft (typ=gemeinschaft) — NIE einen zweiten Mieter anlegen: die bisherigen Angaben werden das erste Mitglied, weitere kommen mit mieter_mitglied_hinzufuegen dazu. Die Debitorennummer bleibt.

Parameter von mieter_aktualisieren
ParameterTypBeschreibung
mieterId PflichtstringUUID des Mieters (z. B. aus der jeweiligen Liste).
namestringVoller Name.
vornamestringVorname (Name wird daraus berechnet).
nachnamestringNachname.
debitorenkontostringDebitorenkonto-Nummer.
kontaktTelstringTelefonnummer (PII).
kontaktEmailstringE-Mail-Adresse (PII).
bemerkungenstringFreitext-Bemerkungen.
aktivbooleanAktiv-Flag.
geburtsdatumstringGeburtsdatum (YYYY-MM-DD, PII).
kommunikationemail | post | portalBevorzugter Kommunikationskanal.
strassestringPostanschrift für Rechnungen und Briefe: Straße und Hausnummer (PII). Nur mit PLZ und Ort vollständig; leer: die Anschrift der gemieteten Einheit.
plzstringPostleitzahl der Postanschrift (PII).
ortstringOrt der Postanschrift (PII).
typperson | gemeinschaft | firmaArt der Vertragspartei. gemeinschaft → person nur mit höchstens einem Mitglied.
gemeinschaftArteheleute | lebenspartner | wohngemeinschaft | sonstige | nullNur bei gemeinschaft.
gemeinschaftBezeichnungbeliebigNur bei gemeinschaft, z. B. „Eheleute Haubner“. Leer: Namen der Mitglieder.
wohntSelbstbooleanNur bei person: lebt der Mieter selbst in der Wohnung? Nein etwa beim Vater, der für den Sohn mietet.
mieter_mitglied_hinzufuegenSchreibenFügt einer Gemeinschaft (Mieter mit typ=gemeinschaft) ein Mitglied hinzu — eine eben mit person_anlegen angelegte Person, die sonst nirgends steht (eine vorhandene Person wird mit 409 abgewiesen).Mieter:UpdateBearbeiten

POST /api/v1/partner/mieter/:mieterId/mitglieder

Fügt einer Gemeinschaft (Mieter mit typ=gemeinschaft) ein Mitglied hinzu — eine eben mit person_anlegen angelegte Person, die sonst nirgends steht (eine vorhandene Person wird mit 409 abgewiesen). Für Ehepartner und WG-Mitglieder, die den Vertrag mit unterschrieben haben. Wer nur dort wohnt, ist Bewohner, kein Mitglied. Antwort: alle Mitglieder.

Parameter von mieter_mitglied_hinzufuegen
ParameterTypBeschreibung
mieterId PflichtstringUUID des Mieters (Gemeinschaft) (z. B. aus der jeweiligen Liste).
personId PflichtintegerID der mit person_anlegen angelegten Person.
wohntSelbstbooleanLebt das Mitglied in der Wohnung? Vorgabe ja.
gueltigAbstringEintritt (optional).
mieter_mitglied_aendernSchreibenÄndert ein Mitglied einer Gemeinschaft: wohntSelbst, Eintritt, Austritt (gueltigBis — danach endet sein Zugang).Mieter:UpdateBearbeiten

PATCH /api/v1/partner/mieter/:mieterId/mitglieder/:mitgliedId

Ändert ein Mitglied einer Gemeinschaft: wohntSelbst, Eintritt, Austritt (gueltigBis — danach endet sein Zugang). mitgliedId aus mieter_details.

Parameter von mieter_mitglied_aendern
ParameterTypBeschreibung
mieterId PflichtstringUUID des Mieters (Gemeinschaft) (z. B. aus der jeweiligen Liste).
mitgliedId PflichtstringUUID des Mitglieds (z. B. aus der jeweiligen Liste).
wohntSelbstboolean
gueltigAbbeliebig
gueltigBisbeliebig
mieter_mitglied_entfernenLöschenEntfernt ein Mitglied aus einer Gemeinschaft (falsch erfasst).Mieter:UpdateBearbeiten

DELETE /api/v1/partner/mieter/:mieterId/mitglieder/:mitgliedId

Entfernt ein Mitglied aus einer Gemeinschaft (falsch erfasst). Eine Gemeinschaft behält mindestens zwei Mitglieder — sonst 409; dann mieter_aktualisieren mit typ=person. Wer auszieht, aber im Vertrag bleibt oder austritt, bekommt besser einen Austritt (mieter_mitglied_aendern).

Parameter von mieter_mitglied_entfernen
ParameterTypBeschreibung
mieterId PflichtstringUUID des Mieters (Gemeinschaft) (z. B. aus der jeweiligen Liste).
mitgliedId PflichtstringUUID des Mitglieds (z. B. aus der jeweiligen Liste).

[05]30 Tools

Eigentümer und Personen

eigentuemerwechsel_auflistenLesenListet die Eigentümerwechsel (Verkauf einer Eigentumswohnung) des Mandanten innerhalb der Objekt- und Einheitengrenze des Zugangs: Vorgangsnummer, Objekt, Einheit, Stand des Ablaufs, Kaufvertrag, Übergang, vollzogen am, zurückgezogen.Eigentuemerwechsel:ReadLesen

GET /api/v1/partner/eigentuemerwechsel

Listet die Eigentümerwechsel (Verkauf einer Eigentumswohnung) des Mandanten innerhalb der Objekt- und Einheitengrenze des Zugangs: Vorgangsnummer, Objekt, Einheit, Stand des Ablaufs, Kaufvertrag, Übergang, vollzogen am, zurückgezogen. Die Namen der Parteien nur mit Eigentuemer:Read; nie Notizen, Gründe oder Kontaktdaten. Filter: objektNr, einheitId, offen=true (noch nicht vollzogen und nicht zurückgezogen). Die Vorgangsnummer braucht eigentuemerwechsel_fall_lesen. Scope: Eigentuemerwechsel:Read.

Parameter von eigentuemerwechsel_auflisten
ParameterTypBeschreibung
objektNrintegerObjekt-Nr. (Ganzzahl).
einheitIdstringUUID der Einheit (z. B. aus der jeweiligen Liste).
offenbooleantrue = nur Vorgänge, die weder vollzogen noch zurückgezogen sind.
eigentuemerwechsel_fall_lesenLesenDer Eigentümerwechsel einer Wohnung als geführter Fall: vom Eingang der Verkaufsmeldung bis zur Abgrenzung des Wechseljahres, in sieben Phasen (Auskunft, Zustimmung, Kaufvertrag, Übergang, Erwerber, Mieter, Wechseljahr).Eigentuemerwechsel:ReadLesen

GET /api/v1/partner/eigentuemerwechsel/:id/fall

Der Eigentümerwechsel einer Wohnung als geführter Fall: vom Eingang der Verkaufsmeldung bis zur Abgrenzung des Wechseljahres, in sieben Phasen (Auskunft, Zustimmung, Kaufvertrag, Übergang, Erwerber, Mieter, Wechseljahr). Liefert den Vorgang (Einheit, Datum von Kaufvertrag, Übergang und Nutzen und Lasten, Kostentragung, Stand), das Band (der eine Stichtag der Aufteilung, Zustimmungspflicht laut Objekt, Abgrenzung, offene Posten des Veräußerers), das Ergebnis des Nachlaufs (Erwerber eingeladen, Mandat des Verkäufers beendet, Zugang endet) und alle Schritte mit Stand (erledigt, automatisch_erledigt, dran, wartet, spaeter, entfaellt), Frist, Grund, einer Warnung (Zustimmung nach § 12 WEG fehlt vor dem Vollzug) und den Verweisen zum Datensatz. `jetzt_dran` nennt höchstens drei Schritte, `erster_schritt` den nächsten. Ob ein Schritt erledigt ist, liest der Server aus den vorhandenen Daten; nur Praxisschritte ohne Datenquelle (`haken: true`) lassen sich von Hand abhaken. Der Plan ist reine Auskunft — Kaufvertrag, Vollzug, Zurückziehen und Abschließen gibt es für den KI-Zugang nicht, sie bleiben ein Klick im Portal. Die Namen der Parteien nur mit Eigentuemer:Read; Notizen, Gründe von Hand entfallener Schritte, der Abbruchgrund und Fehlertexte des Nachlaufs nur mit Eigentuemerwechsel:Update. Die Vorgangsnummer steht im Vorgangsnummer nennt eigentuemerwechsel_auflisten. Scope: Eigentuemerwechsel:Read.

Parameter von eigentuemerwechsel_fall_lesen
ParameterTypBeschreibung
id PflichtintegerVorgangsnummer des Eigentümerwechsels (aus eigentuemerwechsel_auflisten).
eigentuemerwechsel_haken_setzenSchreibenHakt einen Praxisschritt des Eigentümerwechsels ab, lässt ihn mit Begründung entfallen oder nimmt den Haken zurück — derselbe Weg wie die Knöpfe im Fall in immoGenio.Eigentuemerwechsel:UpdateBearbeiten

PUT /api/v1/partner/eigentuemerwechsel/:encodeURIComponent/fall/haken/:encodeURIComponent

Hakt einen Praxisschritt des Eigentümerwechsels ab, lässt ihn mit Begründung entfallen oder nimmt den Haken zurück — derselbe Weg wie die Knöpfe im Fall in immoGenio. Haken-Codes: erwerber_pruefen und verkaufsunterlagen (nur `entfaellt`, mit Grund), zustimmung_andere, vermietung (`erledigt` = vermietet, `entfaellt` = nicht vermietet), vermieterwechsel, mieter_informiert, kaution, zwischenablesung. `erledigt` nur bei Schritten mit `haken: true`, `entfaellt` nur bei Schritten mit `darf_entfallen: true` und mit `grund` (mindestens 8 Zeichen), `offen` nimmt einen Haken zurück. Ein Schritt, der erst nach einem anderen dran ist oder in dieser Konstellation ohnehin entfällt, lässt sich nicht abhaken (409). Der Haken ändert nichts in den Daten und löst keinen Vollzug aus. Antwort: der neue Plan wie eigentuemerwechsel_fall_lesen. Vorher eigentuemerwechsel_fall_lesen. Die Eintragung im Grundbuch (grundbuch) und die geprüfte Vorschau (vollzug_geprueft) gibt es hier nicht: Sie bestätigt nur ein Mensch im Portal (403), weil sie den Vollzug freigeben. Braucht Eigentuemerwechsel:Update.

Parameter von eigentuemerwechsel_haken_setzen
ParameterTypBeschreibung
id PflichtintegerVorgangsnummer des Eigentümerwechsels.
code PflichtstringSchrittcode aus eigentuemerwechsel_fall_lesen (z. B. vermietung, vermieterwechsel, kaution, zwischenablesung).
stand Pflichterledigt | entfaellt | offenerledigt = abgehakt, entfaellt = entfällt mit Grund, offen = Haken zurücknehmen.
notizbeliebigNotiz zum Haken, z. B. Fundstelle oder Tag der Eintragung (optional, höchstens 2.000 Zeichen).
grundbeliebigPflicht bei stand=entfaellt: warum der Schritt entfällt (mindestens 8 Zeichen).
eigentuemer_auflistenLesenListet Eigentümer (ID, Name, Typ person/gemeinschaft/firma, Gemeinschafts-Bezeichnung, Objekt-/Einheit-Counts).Eigentuemer:ReadLesen

GET /api/v1/partner/eigentuemer

Listet Eigentümer (ID, Name, Typ person/gemeinschaft/firma, Gemeinschafts-Bezeichnung, Objekt-/Einheit-Counts). Ohne Kontaktdaten (Scope Eigentuemer:Read). Filter: Suche (Name), Typ.

Parameter von eigentuemer_auflisten
ParameterTypBeschreibung
pageintegerSeitennummer (ab 1).
pageSizeintegerEinträge pro Seite (max. 200).
searchstringNach Name suchen (Teilstring).
typperson | gemeinschaft | firmaNach Eigentümer-Typ filtern.
eigentuemer_detailsLesenZeigt einen Eigentümer.Eigentuemer:ReadLesen

GET /api/v1/partner/eigentuemer/:eigentuemerId

Zeigt einen Eigentümer. Kontaktdaten (Adresse/E-Mail/Telefon/Geburtsdatum/Vor-/Nachname) nur mit Scope Eigentuemer:ReadPII. Bank-/Steuerdaten werden nie geliefert.

Parameter von eigentuemer_details
ParameterTypBeschreibung
eigentuemerId PflichtstringUUID des Eigentuemers (z. B. aus der jeweiligen Liste).
firmen_auflistenLesenListet die Firmen des Unternehmens je mit id, name, rechtsform und rollen.Eigentuemer:UpdateBearbeiten

GET /api/v1/partner/firmen

Listet die Firmen des Unternehmens je mit id, name, rechtsform und rollen. Eine Firma ist eine Entität: Unternehmen, Dienstleister, Makler, Versicherer, Kreditor, fremde Verwaltung und Eigentümer sind ihre Rollen (rollen nennt sie mit Anzahl), eine Änderung an einer Rolle gilt für alle. Die id ist der Wert für firmaId bei eigentuemer_anlegen und eigentuemer_aktualisieren — so ist etwa ein Dienstleister zugleich Eigentümer. Braucht Scope Eigentuemer:Update (die Liste gilt für das ganze Unternehmen). Anschrift und Kontakt nur mit Scope Eigentuemer:ReadPII.

firma_detailsLesenZeigt eine Firma des Unternehmens (wie firmen_auflisten, für eine id).Eigentuemer:ReadLesen

GET /api/v1/partner/firmen/:firmaId

Zeigt eine Firma des Unternehmens (wie firmen_auflisten, für eine id). Mit Scope Eigentuemer:Read nur eine Firma, die ein sichtbarer Eigentümer nennt (Feld firmaId).

Parameter von firma_details
ParameterTypBeschreibung
firmaId PflichtintegerID der Firma.
eigentuemer_objekteLesenListet die Objekte eines Eigentümers inkl. Anteil.Eigentuemer:ReadLesen

GET /api/v1/partner/eigentuemer/:eigentuemerId/objekte

Listet die Objekte eines Eigentümers inkl. Anteil.

Parameter von eigentuemer_objekte
ParameterTypBeschreibung
eigentuemerId PflichtstringUUID des Eigentuemers (z. B. aus der jeweiligen Liste).
eigentuemer_einheitenLesenListet die Einheiten eines Eigentümers inkl. Anteil.Eigentuemer:ReadLesen

GET /api/v1/partner/eigentuemer/:eigentuemerId/einheiten

Listet die Einheiten eines Eigentümers inkl. Anteil.

Parameter von eigentuemer_einheiten
ParameterTypBeschreibung
eigentuemerId PflichtstringUUID des Eigentuemers (z. B. aus der jeweiligen Liste).
eigentuemer_anlegenSchreibenLegt einen Eigentümer an (Typ person/gemeinschaft/firma).Eigentuemer:CreateBearbeiten

POST /api/v1/partner/eigentuemer

Legt einen Eigentümer an (Typ person/gemeinschaft/firma). Pflichtfelder je Typ: Person → Nachname; Firma → firmaId aus firmen_auflisten (bevorzugt) oder Name + Rechtsform; Gemeinschaft → Name oder Bezeichnung. Bank-/Steuerdaten können nicht gesetzt werden.

Parameter von eigentuemer_anlegen
ParameterTypBeschreibung
typperson | gemeinschaft | firmaEigentuemer-Typ.
namestringName (Firma/Gemeinschaft) bzw. Vollname.
vornamestringVorname (bei Person).
nachnamestringNachname (bei Person).
anredestringAnrede (Herr/Frau).
titelstringTitel (Dr./Prof.).
emailstringE-Mail (PII).
telefonstringTelefon (PII).
strassestringStrasse (PII).
plzstringPLZ (PII).
ortstringOrt (PII).
landstringLand.
kommunikationemail | post | portalKommunikationskanal.
notizstringInterne Notiz.
geburtsdatumstringGeburtsdatum (YYYY-MM-DD, PII).
familienstandstringFamilienstand (PII).
rechtsformstringGesellschaftsform (bei Firma) als Kürzel aus rechtsformen_auflisten (Feld code, z. B. "GmbH"). Ein anderer Wert wird mit 422 abgewiesen.
handelsregisterGerichtstringHandelsregister-Gericht.
handelsregisterNrstringHandelsregister-Nummer.
gemeinschaftBezeichnungstringBezeichnung der Gemeinschaft.
firmaIdbeliebigVerweis auf eine Firma aus firmen_auflisten (Feld id) — z. B. einen Dienstleister, der Eigentümer ist. Name, Gesellschaftsform, Anschrift und Kontakt kommen dann aus der Firma und folgen jeder Änderung dort; typ wird firma, Name und Rechtsform entfallen als Pflicht. null löst den Verweis.
eigentuemer_aktualisierenSchreibenAktualisiert einen Eigentümer (nur übergebene Felder).Eigentuemer:UpdateBearbeiten

PATCH /api/v1/partner/eigentuemer/:eigentuemerId

Aktualisiert einen Eigentümer (nur übergebene Felder). Keine Bank-/Steuerdaten.

Parameter von eigentuemer_aktualisieren
ParameterTypBeschreibung
eigentuemerId PflichtstringUUID des Eigentuemers (z. B. aus der jeweiligen Liste).
typperson | gemeinschaft | firmaEigentuemer-Typ.
namestringName (Firma/Gemeinschaft) bzw. Vollname.
vornamestringVorname (bei Person).
nachnamestringNachname (bei Person).
anredestringAnrede (Herr/Frau).
titelstringTitel (Dr./Prof.).
emailstringE-Mail (PII).
telefonstringTelefon (PII).
strassestringStrasse (PII).
plzstringPLZ (PII).
ortstringOrt (PII).
landstringLand.
kommunikationemail | post | portalKommunikationskanal.
notizstringInterne Notiz.
geburtsdatumstringGeburtsdatum (YYYY-MM-DD, PII).
familienstandstringFamilienstand (PII).
rechtsformstringGesellschaftsform (bei Firma) als Kürzel aus rechtsformen_auflisten (Feld code, z. B. "GmbH"). Ein anderer Wert wird mit 422 abgewiesen.
handelsregisterGerichtstringHandelsregister-Gericht.
handelsregisterNrstringHandelsregister-Nummer.
gemeinschaftBezeichnungstringBezeichnung der Gemeinschaft.
firmaIdbeliebigVerweis auf eine Firma aus firmen_auflisten (Feld id) — z. B. einen Dienstleister, der Eigentümer ist. Name, Gesellschaftsform, Anschrift und Kontakt kommen dann aus der Firma und folgen jeder Änderung dort; typ wird firma, Name und Rechtsform entfallen als Pflicht. null löst den Verweis.
eigentuemer_objekt_zuordnenSchreibenOrdnet einem Eigentümer ein Objekt mit Anteil zu (Anteil 0<x<=1, z. B. 0.5 = 50%).Eigentuemer:UpdateBearbeiten

POST /api/v1/partner/eigentuemer/:eigentuemerId/objekte

Ordnet einem Eigentümer ein Objekt mit Anteil zu (Anteil 0<x<=1, z. B. 0.5 = 50%).

Parameter von eigentuemer_objekt_zuordnen
ParameterTypBeschreibung
eigentuemerId PflichtstringUUID des Eigentuemers (z. B. aus der jeweiligen Liste).
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
anteil PflichtnumberAnteil als Dezimalbruch 0<x<=1 (0.5 = 50%).
eigentuemer_objekt_anteil_aktualisierenSchreibenÄndert den Anteil einer Eigentümer-Objekt-Zuordnung.Eigentuemer:UpdateBearbeiten

PATCH /api/v1/partner/eigentuemer/:eigentuemerId/objekte/:objektNr

Ändert den Anteil einer Eigentümer-Objekt-Zuordnung.

Parameter von eigentuemer_objekt_anteil_aktualisieren
ParameterTypBeschreibung
eigentuemerId PflichtstringUUID des Eigentuemers (z. B. aus der jeweiligen Liste).
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
anteil PflichtnumberAnteil als Dezimalbruch 0<x<=1 (0.5 = 50%).
eigentuemer_objekt_entfernenLöschenEntfernt eine Eigentümer-Objekt-Zuordnung.Eigentuemer:UpdateBearbeiten

DELETE /api/v1/partner/eigentuemer/:eigentuemerId/objekte/:objektNr

Entfernt eine Eigentümer-Objekt-Zuordnung.

Parameter von eigentuemer_objekt_entfernen
ParameterTypBeschreibung
eigentuemerId PflichtstringUUID des Eigentuemers (z. B. aus der jeweiligen Liste).
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
eigentuemer_einheit_zuordnenSchreibenOrdnet einem Eigentümer eine Einheit mit Anteil zu (0<x<=1).Eigentuemer:UpdateBearbeiten

POST /api/v1/partner/eigentuemer/:eigentuemerId/einheiten

Ordnet einem Eigentümer eine Einheit mit Anteil zu (0<x<=1). An einer WEG mit `wechselAb` als Wechsel zu diesem Tag, ohne als Korrektur.

Parameter von eigentuemer_einheit_zuordnen
ParameterTypBeschreibung
eigentuemerId PflichtstringUUID des Eigentuemers (z. B. aus der jeweiligen Liste).
einheitId PflichtstringUUID der Einheit (z. B. aus der jeweiligen Liste).
anteil PflichtnumberAnteil als Dezimalbruch 0<x<=1 (0.5 = 50%).
wechselAbstringNur an Einheiten einer WEG: Tag, ab dem die Änderung gilt (JJJJ-MM-TT, höchstens heute). Mit Datum ist es ein Wechsel — er geht in die Anteilshistorie und steht im Verlauf des Objekts. Ohne Datum ist es eine Korrektur: Der Bestand gilt dann seit dem letzten datierten Wechsel der Einheit (ohne einen: seit jeher) als so gemeint (Tippfehler, Ersterfassung). Bei einem Verkauf erst den bisherigen Eigentümer mit Datum entfernen, dann den neuen mit demselben Datum zuordnen. Ein Verkauf mit Kaufvertrag läuft besser über den Vorgang Eigentümerwechsel, der auch Hausgeld und Rücklage umhängt.
eigentuemer_einheit_anteil_aktualisierenSchreibenÄndert den Anteil einer Eigentümer-Einheit-Zuordnung.Eigentuemer:UpdateBearbeiten

PATCH /api/v1/partner/eigentuemer/:eigentuemerId/einheiten/:einheitId

Ändert den Anteil einer Eigentümer-Einheit-Zuordnung. An einer WEG mit `wechselAb` als Wechsel zu diesem Tag, ohne als Korrektur.

Parameter von eigentuemer_einheit_anteil_aktualisieren
ParameterTypBeschreibung
eigentuemerId PflichtstringUUID des Eigentuemers (z. B. aus der jeweiligen Liste).
einheitId PflichtstringUUID der Einheit (z. B. aus der jeweiligen Liste).
anteil PflichtnumberAnteil als Dezimalbruch 0<x<=1 (0.5 = 50%).
wechselAbstringNur an Einheiten einer WEG: Tag, ab dem die Änderung gilt (JJJJ-MM-TT, höchstens heute). Mit Datum ist es ein Wechsel — er geht in die Anteilshistorie und steht im Verlauf des Objekts. Ohne Datum ist es eine Korrektur: Der Bestand gilt dann seit dem letzten datierten Wechsel der Einheit (ohne einen: seit jeher) als so gemeint (Tippfehler, Ersterfassung). Bei einem Verkauf erst den bisherigen Eigentümer mit Datum entfernen, dann den neuen mit demselben Datum zuordnen. Ein Verkauf mit Kaufvertrag läuft besser über den Vorgang Eigentümerwechsel, der auch Hausgeld und Rücklage umhängt.
eigentuemer_einheit_entfernenLöschenEntfernt eine Eigentümer-Einheit-Zuordnung.Eigentuemer:UpdateBearbeiten

DELETE /api/v1/partner/eigentuemer/:eigentuemerId/einheiten/:einheitId

Entfernt eine Eigentümer-Einheit-Zuordnung. An einer WEG mit `wechselAb` als Wechsel: Der Eigentümer scheidet am Vortag aus; ohne als Korrektur.

Parameter von eigentuemer_einheit_entfernen
ParameterTypBeschreibung
eigentuemerId PflichtstringUUID des Eigentuemers (z. B. aus der jeweiligen Liste).
einheitId PflichtstringUUID der Einheit (z. B. aus der jeweiligen Liste).
wechselAbstringNur an Einheiten einer WEG: Tag, ab dem die Änderung gilt (JJJJ-MM-TT, höchstens heute). Mit Datum ist es ein Wechsel — er geht in die Anteilshistorie und steht im Verlauf des Objekts. Ohne Datum ist es eine Korrektur: Der Bestand gilt dann seit dem letzten datierten Wechsel der Einheit (ohne einen: seit jeher) als so gemeint (Tippfehler, Ersterfassung). Bei einem Verkauf erst den bisherigen Eigentümer mit Datum entfernen, dann den neuen mit demselben Datum zuordnen. Ein Verkauf mit Kaufvertrag läuft besser über den Vorgang Eigentümerwechsel, der auch Hausgeld und Rücklage umhängt.
personen_auflistenLesenListet die Personen des Mandanten — Berechtigte, Erwerber, Vertreter, Mitglieder, Bewohner und verknüpfte Eigentümer, Mieter, Arbeitnehmer — mit id, art, anzeigename und Kontakt.Person:ReadLesen mit Kontaktdaten

GET /api/v1/partner/personen-stamm

Listet die Personen des Mandanten — Berechtigte, Erwerber, Vertreter, Mitglieder, Bewohner und verknüpfte Eigentümer, Mieter, Arbeitnehmer — mit id, art, anzeigename und Kontakt. q sucht in Name, E-Mail und Ort. Vor person_anlegen prüfen, ob es die Person schon gibt. Braucht den Scope Person:Read.

Parameter von personen_auflisten
ParameterTypBeschreibung
qstringSuchbegriff (Name, E-Mail, Ort).
person_lesenLesenZeigt eine Person des Mandanten mit Name, Kontakt und Anschrift.Person:ReadLesen mit Kontaktdaten

GET /api/v1/partner/personen-stamm/:personId

Zeigt eine Person des Mandanten mit Name, Kontakt und Anschrift. Braucht den Scope Person:Read.

Parameter von person_lesen
ParameterTypBeschreibung
personId PflichtintegerID der Person (aus personen_auflisten bzw. person_anlegen). Name und Kontakt kommen aus der Person.
person_anlegenSchreibenLegt eine Person des Mandanten an und liefert ihre id — die personId für Mitglieder, Vertreter und andere Stellen, die eine Person nennen.Person:CreateBearbeiten

POST /api/v1/partner/personen-stamm

Legt eine Person des Mandanten an und liefert ihre id — die personId für Mitglieder, Vertreter und andere Stellen, die eine Person nennen. Braucht den Scope Person:Create.

Parameter von person_anlegen
ParameterTypBeschreibung
anredeherr | frau | diversAnrede.
titelstringTitel, z. B. "Dr.".
vornamestringVorname.
nachname PflichtstringNachname bzw. Name.
emailstringE-Mail (PII).
telefonstringTelefon (PII).
adressestringStraße und Hausnummer (PII).
plzstringPostleitzahl.
ortstringOrt.
geburtsdatumstringGeburtsdatum JJJJ-MM-TT (nur bei Bewohnern nötig).
person_aktualisierenSchreibenÄndert Name, Kontakt oder Anschrift einer Person (nur übergebene Felder).Person:UpdateBearbeiten

PATCH /api/v1/partner/personen-stamm/:personId

Ändert Name, Kontakt oder Anschrift einer Person (nur übergebene Felder). Gilt überall, wo sie genannt wird. Eine Person mit art eigentuemer, mieter oder arbeitnehmer wird dort gepflegt, nicht hier. Braucht den Scope Person:Update.

Parameter von person_aktualisieren
ParameterTypBeschreibung
personId PflichtintegerID der Person (aus personen_auflisten bzw. person_anlegen). Name und Kontakt kommen aus der Person.
anredeherr | frau | diversAnrede.
titelstringTitel, z. B. "Dr.".
vornamestringVorname.
nachnamestringNachname bzw. Name.
emailstringE-Mail (PII).
telefonstringTelefon (PII).
adressestringStraße und Hausnummer (PII).
plzstringPostleitzahl.
ortstringOrt.
geburtsdatumstringGeburtsdatum JJJJ-MM-TT (nur bei Bewohnern nötig).
eigentuemer_mitglieder_auflistenLesenListet externe Gemeinschafts-Mitglieder eines Eigentümers (personId, Name, Anteil, Kontakt — Name und Kontakt aus der Person).Eigentuemer:ReadLesen

GET /api/v1/partner/eigentuemer/:eigentuemerId/mitglieder

Listet externe Gemeinschafts-Mitglieder eines Eigentümers (personId, Name, Anteil, Kontakt — Name und Kontakt aus der Person).

Parameter von eigentuemer_mitglieder_auflisten
ParameterTypBeschreibung
eigentuemerId PflichtstringUUID des Eigentuemers (z. B. aus der jeweiligen Liste).
eigentuemer_mitglied_anlegenSchreibenFügt einem Eigentümer ein externes Mitglied hinzu (z. B. Gemeinschafts-Mitglied ohne Portal-Zugang).Eigentuemer:UpdateBearbeiten

POST /api/v1/partner/eigentuemer/:eigentuemerId/mitglieder

Fügt einem Eigentümer ein externes Mitglied hinzu (z. B. Gemeinschafts-Mitglied ohne Portal-Zugang). Das Mitglied ist eine Person: personId mitgeben (aus personen_auflisten oder person_anlegen); nur ohne personId legt name eine neue Person an.

Parameter von eigentuemer_mitglied_anlegen
ParameterTypBeschreibung
eigentuemerId PflichtstringUUID des Eigentuemers (z. B. aus der jeweiligen Liste).
personIdintegerID der Person (aus personen_auflisten bzw. person_anlegen). Name und Kontakt kommen aus der Person.
namestringNur ohne personId: Name einer neu anzulegenden Person.
anredestringNur ohne personId: Anrede.
emailstringNur ohne personId: E-Mail (PII).
telefonstringNur ohne personId: Telefon (PII).
adressestringNur ohne personId: Anschrift (PII).
anteilnumberAnteil als Dezimalbruch 0<x<=1 (0.5 = 50%).
istZustellungsbevollmaechtigtbooleanZustellungsbevollmaechtigt?
eigentuemer_mitglied_aktualisierenSchreibenAktualisiert ein externes Mitglied (nur übergebene Felder).Eigentuemer:UpdateBearbeiten

PATCH /api/v1/partner/eigentuemer/:eigentuemerId/mitglieder/:mitgliedId

Aktualisiert ein externes Mitglied (nur übergebene Felder). personId setzt eine andere Person; Name und Kontakt der Person ändert person_aktualisieren — die Änderung gilt überall, wo sie genannt wird.

Parameter von eigentuemer_mitglied_aktualisieren
ParameterTypBeschreibung
eigentuemerId PflichtstringUUID des Eigentuemers (z. B. aus der jeweiligen Liste).
mitgliedId PflichtintegerID des Mitglieds.
personIdintegerID der Person (aus personen_auflisten bzw. person_anlegen). Name und Kontakt kommen aus der Person.
namestringNur ohne personId: Name einer neu anzulegenden Person.
anredestringNur ohne personId: Anrede.
emailstringNur ohne personId: E-Mail (PII).
telefonstringNur ohne personId: Telefon (PII).
adressestringNur ohne personId: Anschrift (PII).
anteilnumberAnteil als Dezimalbruch 0<x<=1 (0.5 = 50%).
istZustellungsbevollmaechtigtbooleanZustellungsbevollmaechtigt?
eigentuemer_mitglied_loeschenLöschenLöscht ein externes Mitglied.Eigentuemer:UpdateBearbeiten

DELETE /api/v1/partner/eigentuemer/:eigentuemerId/mitglieder/:mitgliedId

Löscht ein externes Mitglied.

Parameter von eigentuemer_mitglied_loeschen
ParameterTypBeschreibung
eigentuemerId PflichtstringUUID des Eigentuemers (z. B. aus der jeweiligen Liste).
mitgliedId PflichtintegerID des Mitglieds.
eigentuemer_vertreter_auflistenLesenListet Vertretungsberechtigte eines Eigentümers (bei Firmen: GF/Prokurist/Vorstand).Eigentuemer:ReadLesen

GET /api/v1/partner/eigentuemer/:eigentuemerId/vertreter

Listet Vertretungsberechtigte eines Eigentümers (bei Firmen: GF/Prokurist/Vorstand).

Parameter von eigentuemer_vertreter_auflisten
ParameterTypBeschreibung
eigentuemerId PflichtstringUUID des Eigentuemers (z. B. aus der jeweiligen Liste).
eigentuemer_vertreter_anlegenSchreibenFügt einem Eigentümer einen Vertretungsberechtigten hinzu.Eigentuemer:UpdateBearbeiten

POST /api/v1/partner/eigentuemer/:eigentuemerId/vertreter

Fügt einem Eigentümer einen Vertretungsberechtigten hinzu. Der Vertreter ist eine Person: personId mitgeben (aus personen_auflisten oder person_anlegen); nur ohne personId legt name eine neue Person an.

Parameter von eigentuemer_vertreter_anlegen
ParameterTypBeschreibung
eigentuemerId PflichtstringUUID des Eigentuemers (z. B. aus der jeweiligen Liste).
personIdintegerID der Person (aus personen_auflisten bzw. person_anlegen). Name und Kontakt kommen aus der Person.
namestringNur ohne personId: Name einer neu anzulegenden Person.
rolle Pflichtgeschaeftsfuehrer | prokurist | vorstand | sonstigeVertretungsrolle.
emailstringNur ohne personId: E-Mail (PII).
telefonstringNur ohne personId: Telefon (PII).
eigentuemer_vertreter_aktualisierenSchreibenAktualisiert einen Vertretungsberechtigten (nur übergebene Felder).Eigentuemer:UpdateBearbeiten

PATCH /api/v1/partner/eigentuemer/:eigentuemerId/vertreter/:vertreterId

Aktualisiert einen Vertretungsberechtigten (nur übergebene Felder). personId setzt eine andere Person; Name und Kontakt der Person ändert person_aktualisieren.

Parameter von eigentuemer_vertreter_aktualisieren
ParameterTypBeschreibung
eigentuemerId PflichtstringUUID des Eigentuemers (z. B. aus der jeweiligen Liste).
vertreterId PflichtintegerID des Vertreters.
personIdintegerID der Person (aus personen_auflisten bzw. person_anlegen). Name und Kontakt kommen aus der Person.
namestringNur ohne personId: Name einer neu anzulegenden Person.
rollegeschaeftsfuehrer | prokurist | vorstand | sonstigeVertretungsrolle.
emailstringNur ohne personId: E-Mail (PII).
telefonstringNur ohne personId: Telefon (PII).
eigentuemer_vertreter_loeschenLöschenLöscht einen Vertretungsberechtigten.Eigentuemer:UpdateBearbeiten

DELETE /api/v1/partner/eigentuemer/:eigentuemerId/vertreter/:vertreterId

Löscht einen Vertretungsberechtigten.

Parameter von eigentuemer_vertreter_loeschen
ParameterTypBeschreibung
eigentuemerId PflichtstringUUID des Eigentuemers (z. B. aus der jeweiligen Liste).
vertreterId PflichtintegerID des Vertreters.
eigentuemer_antraege_auflistenLesenListet die Änderungsanträge, die Eigentümer in ihrer App gestellt haben (Anschrift, Bankverbindung, Zustellweg, Telefon, E-Mail, Mitglieder, Vertreter): Art, Stand (beantragt, gesperrt, freigegeben, angewendet, abgelehnt, zurückgezogen), Eigentümer, vorher und nachher, frühester Freigabezeitpunkt (Wartezeit bei IBAN-Änderungen), ob der Kontoinhaber abweicht und ob ein Nachweis vorliegt.Eigentuemeraenderung:ReadLesen mit Kontaktdaten

GET /api/v1/partner/eigentuemer-antraege

Listet die Änderungsanträge, die Eigentümer in ihrer App gestellt haben (Anschrift, Bankverbindung, Zustellweg, Telefon, E-Mail, Mitglieder, Vertreter): Art, Stand (beantragt, gesperrt, freigegeben, angewendet, abgelehnt, zurückgezogen), Eigentümer, vorher und nachher, frühester Freigabezeitpunkt (Wartezeit bei IBAN-Änderungen), ob der Kontoinhaber abweicht und ob ein Nachweis vorliegt. Die IBAN ist verdeckt. Freigeben und ablehnen kann nur ein Mensch im Portal (Vier-Augen) — dieses Tool tut es nicht. Braucht Eigentuemeraenderung:Read.

Parameter von eigentuemer_antraege_auflisten
ParameterTypBeschreibung
filteroffen | alleoffen = noch zu entscheiden oder anzuwenden.

[06]43 Tools

WEG: Versammlungen, Beschlüsse, Beirat, Bescheinigungen

versammlung_fall_lesenLesenDie Eigentümerversammlung als geführter Fall: von der Terminfestlegung bis zum umgesetzten Beschluss, in sechs Phasen (Vorbereiten, Einladen, Rückmeldungen, Durchführen, Protokoll, Umsetzen).Versammlung:ReadLesen

GET /api/v1/partner/versammlungen/:id/fall

Die Eigentümerversammlung als geführter Fall: von der Terminfestlegung bis zum umgesetzten Beschluss, in sechs Phasen (Vorbereiten, Einladen, Rückmeldungen, Durchführen, Protokoll, Umsetzen). Liefert die Versammlung, das Band mit den Fristen (Einladung spätestens drei Wochen vorher — eine Soll-Frist nach § 24 Abs. 4 WEG —, Protokoll als Praxiswert, Anfechtungsfrist nach § 45 WEG), die Stände der Jahresabrechnungs- und der Wirtschaftsplan-Akte, die Beschlüsse mit Sammlungsnummer und alle Schritte mit Stand (erledigt, automatisch_erledigt, dran, wartet, spaeter, entfaellt), Frist, Grund und den Verweisen zum Datensatz (top_id, beschluss_ids, jahresabrechnung, wirtschaftsplan_id). `jetzt_dran` nennt höchstens drei Schritte nach Frist, `erster_schritt` den nächsten. Ob ein Schritt erledigt ist, liest der Server aus den vorhandenen Daten; der Plan ist reine Auskunft — die Handlungen laufen über die vorhandenen Werkzeuge (versammlung_workflow_transition, beschluss_workflow_transition, jahresabrechnung_vorlegen, …). Die Stände der Jahresabrechnungs- und Wirtschaftsplan-Akte, Notizen und die Gründe von Hand entfallener Schritte zeigt der Plan nur mit Versammlung:Entscheiden. Die Versammlungs-ID nennt versammlungen_auflisten. Scope: Versammlung:Read.

Parameter von versammlung_fall_lesen
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
versammlung_beschluss_in_akteSchreibenÜbernimmt das Ergebnis eines Tagesordnungspunkts in seine Akte: art=jahresabrechnung ruft „Beschluss erfassen“ der Jahresabrechnungs-Akte (optional faelligAm — Vorgabe 30 Tage nach Beschluss), art=wirtschaftsplan den Beschluss-Schritt der Wirtschaftsplan-Akte — jeweils mit dem Beschluss, der aus der Abstimmung am Punkt entstanden ist.Versammlung:EntscheidenBearbeiten · nur persönlich

POST /api/v1/partner/versammlungen/:encodeURIComponent/fall/beschluss-in-akte

Übernimmt das Ergebnis eines Tagesordnungspunkts in seine Akte: art=jahresabrechnung ruft „Beschluss erfassen“ der Jahresabrechnungs-Akte (optional faelligAm — Vorgabe 30 Tage nach Beschluss), art=wirtschaftsplan den Beschluss-Schritt der Wirtschaftsplan-Akte — jeweils mit dem Beschluss, der aus der Abstimmung am Punkt entstanden ist. Voraussetzungen: Die Akte ist zu dieser Versammlung vorgelegt, ihr Punkt steht auf der Tagesordnung und es ist abgestimmt (sonst 409 mit dem Weg). Auch ein abgelehntes oder vertagtes Ergebnis wird so in die Akte übernommen. Widerspricht das Ergebnis der Beschluss-Sammlung, weist die Akte es ab; ist es schon übernommen, kommt der unveränderte Plan zurück. Antwort: der Plan wie versammlung_fall_lesen (ohne Akten-Stände, wenn dem Zugang das Schreibrecht fehlt). Nur über den persönlichen KI-Zugang, braucht Versammlung:Entscheiden und das Recht der Akte.

Parameter von versammlung_beschluss_in_akte
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
art Pflichtjahresabrechnung | wirtschaftsplanIn welche Akte der Beschluss übernommen wird.
faelligAmstringNur bei jahresabrechnung und angenommenem Beschluss: Fälligkeit der Nachschüsse (JJJJ-MM-TT).
versammlungen_auflistenLesenListet Eigentümerversammlungen (Titel, Datum, Uhrzeit, Ort, Workflow-Status, Objekt).Versammlung:ReadLesen

GET /api/v1/partner/versammlungen

Listet Eigentümerversammlungen (Titel, Datum, Uhrzeit, Ort, Workflow-Status, Objekt). Filter: Objekt-Nr., Status (z. B. geplant, eingeladen, durchgefuehrt, protokoll_versendet).

Parameter von versammlungen_auflisten
ParameterTypBeschreibung
pageintegerSeitennummer (ab 1).
pageSizeintegerEinträge pro Seite (max. 200).
objektNrintegerNur Versammlungen zu diesem Objekt (Objekt-Nr.).
statusstringNach Workflow-Status filtern (z. B. geplant, eingeladen, durchgefuehrt).
versammlung_detailsLesenZeigt eine einzelne Versammlung mit Details (inkl. Einladungs-/Protokoll-Text).Versammlung:ReadLesen

GET /api/v1/partner/versammlungen/:id

Zeigt eine einzelne Versammlung mit Details (inkl. Einladungs-/Protokoll-Text).

Parameter von versammlung_details
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
versammlung_anlegenSchreibenLegt eine neue Eigentümerversammlung für ein Objekt an.Versammlung:CreateBearbeiten

POST /api/v1/partner/versammlungen

Legt eine neue Eigentümerversammlung für ein Objekt an. Startet automatisch den Versammlungs-Workflow (Status geplant).

Parameter von versammlung_anlegen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr., zu dem die Versammlung gehört.
titel PflichtstringTitel der Versammlung.
datum PflichtstringDatum (YYYY-MM-DD).
uhrzeitstringUhrzeit (HH:MM), optional.
ortstringOrt der Versammlung, optional.
bemerkungenstringFreitext-Bemerkungen, optional.
versammlung_top_anlegenSchreibenLegt einen Tagesordnungspunkt (TOP) an eine Versammlung — dieselbe Funktion wie im Portal: Der erste TOP führt die Versammlung nach „TOPs erfasst“.Versammlung:UpdateBearbeiten

POST /api/v1/partner/versammlungen/:id/tops

Legt einen Tagesordnungspunkt (TOP) an eine Versammlung — dieselbe Funktion wie im Portal: Der erste TOP führt die Versammlung nach „TOPs erfasst“. Ohne reihenfolge kommt er hinter den letzten Punkt. abstimmungTyp: keine (Vorgabe, reiner Informations-TOP), einfache_mehrheit, qualifizierte_mehrheit oder einstimmig. beschlussVorlage ist der Wortlaut, über den abgestimmt wird. Nach Erstellung der Einladung ist die Tagesordnung gesperrt (409). Ändern und Löschen eines Punkts gehen im Portal. Braucht Versammlung:Update.

Parameter von versammlung_top_anlegen
ParameterTypBeschreibung
id PflichtintegerID der Versammlung (aus versammlungen_auflisten).
titel PflichtstringTitel des TOP.
beschreibungbeliebigErläuterung zum TOP.
beschlussVorlagebeliebigWortlaut des Beschlussvorschlags.
abstimmungTypkeine | einfache_mehrheit | qualifizierte_mehrheit | einstimmigArt der Abstimmung (Vorgabe: keine).
reihenfolgeintegerPosition in der Tagesordnung; ohne Angabe ans Ende.
versammlung_aktualisierenSchreibenAktualisiert eine Versammlung (nur übergebene Felder).Versammlung:UpdateBearbeiten

PATCH /api/v1/partner/versammlungen/:id

Aktualisiert eine Versammlung (nur übergebene Felder). Gespeicherter Einladungs- bzw. Protokoll-Text löst die jeweilige Workflow-Transition aus.

Parameter von versammlung_aktualisieren
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
titelstringNeuer Titel.
datumstringNeues Datum (YYYY-MM-DD).
uhrzeitstringNeue Uhrzeit (HH:MM).
ortstringNeuer Ort.
bemerkungenstringBemerkungen.
einladungTextstringEinladungs-Text (löst Workflow-Transition einladung_erstellt aus).
protokollTextstringProtokoll-Text (löst Workflow-Transition protokoll_erfasst aus).
versammlung_workflow_statusLesenZeigt den aktuellen GenioFlow-Status einer Eigentümerversammlung (currentState, isTerminal) und die aktuell erlaubten Aktionen — wie das Workflow-Panel im Portal.Versammlung:ReadLesen

GET /api/v1/partner/versammlungen/:id/workflow

Zeigt den aktuellen GenioFlow-Status einer Eigentümerversammlung (currentState, isTerminal) und die aktuell erlaubten Aktionen — wie das Workflow-Panel im Portal. Vor jeder Transition aufrufen.

Parameter von versammlung_workflow_status
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
versammlung_workflow_transitionSchreibenFührt EINE GenioFlow-Transition für eine Eigentümerversammlung aus (kein Bypass; Engine + Side-Effects laufen).Versammlung:UpdateBearbeiten

POST /api/v1/partner/versammlungen/:id/workflow/transition

Führt EINE GenioFlow-Transition für eine Eigentümerversammlung aus (kein Bypass; Engine + Side-Effects laufen). Lebenszyklus: geplant --tops_erfassen--> tops_erfasst --einladung_erstellen--> einladung_erstellt --einladung_versenden--> eingeladen --durchfuehren--> durchgefuehrt --protokoll_erfassen--> protokoll_erfasst --protokoll_versenden--> protokoll_versendet. Optionale Payload-Felder je Event (z. B. tops_freigabe, einladungVersandtAm, anwesende_eigentuemer_count, protokollVersandtAm); für einen Backfill genügen meist leere/minimale Payloads.

Parameter von versammlung_workflow_transition
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
event Pflichttops_erfassen | einladung_erstellen | einladung_versenden | durchfuehren | protokoll_erfassen | protokoll_versenden | vertagen | absagenAuszulösendes ETV-Workflow-Event. Muss im aktuellen State erlaubt sein (siehe versammlung_workflow_status).
payloadobjectEvent-spezifische Felder (optional). Siehe versammlung_workflow_status für payloadSchema.
beschluesse_auflistenLesenListet WEG-Beschlüsse (Beschluss-Nr., Titel, Ergebnis, Umsetzungsstatus, Workflow-Status, Objekt).Beschluss:ReadLesen

GET /api/v1/partner/beschluesse

Listet WEG-Beschlüsse (Beschluss-Nr., Titel, Ergebnis, Umsetzungsstatus, Workflow-Status, Objekt). Filter: Objekt-Nr., Workflow-Status, Jahr (nach Versammlungsdatum), Suche im Wortlaut.

Parameter von beschluesse_auflisten
ParameterTypBeschreibung
pageintegerSeitennummer (ab 1).
pageSizeintegerEinträge pro Seite (max. 200).
objektNrintegerNur Beschlüsse zu diesem Objekt (Objekt-Nr.).
statusstringNach Workflow-Status filtern (z. B. vorgeschlagen, angenommen, in_umsetzung, umgesetzt).
jahrintegerNur Beschlüsse dieses Jahres (nach Versammlungsdatum).
qstringSuchbegriff im Wortlaut: trifft Titel, Beschlusstext und Beschluss-Nr.
beschluss_detailsLesenZeigt einen einzelnen Beschluss mit Details.Beschluss:ReadLesen

GET /api/v1/partner/beschluesse/:id

Zeigt einen einzelnen Beschluss mit Details.

Parameter von beschluss_details
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
beschluss_anlegenSchreibenLegt einen neuen WEG-Beschluss an.Beschluss:CreateBearbeiten

POST /api/v1/partner/beschluesse

Legt einen neuen WEG-Beschluss an. Startet automatisch den Beschluss-Workflow (Status vorgeschlagen). Ergebnis/Status werden über den Workflow getrieben, nicht hier gesetzt.

Parameter von beschluss_anlegen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr., zu dem der Beschluss gehört.
beschlussNummer PflichtstringEindeutige Beschluss-Nummer (z. B. 2026/001).
titel PflichtstringTitel des Beschlusses.
etvDatumstringDatum der Versammlung (YYYY-MM-DD), optional.
beschreibungstringBeschreibung/Beschlusstext, optional.
jaStimmenintegerJa-Stimmen, optional.
neinStimmenintegerNein-Stimmen, optional.
enthaltungenintegerEnthaltungen, optional.
umsetzungBisstringUmsetzungs-Deadline (YYYY-MM-DD), optional.
dokumentIdintegerVerknüpftes Dokument (ID), optional.
beschluss_aktualisierenSchreibenAktualisiert einen Beschluss (nur übergebene Felder).Beschluss:UpdateBearbeiten

PATCH /api/v1/partner/beschluesse/:id

Aktualisiert einen Beschluss (nur übergebene Felder).

Parameter von beschluss_aktualisieren
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
etvIdintegerZugehörige Versammlung (ID).
etvDatumstringDatum der Versammlung (YYYY-MM-DD).
beschlussNummerstringBeschluss-Nummer.
titelstringTitel.
beschreibungstringBeschreibung/Beschlusstext.
jaStimmenintegerJa-Stimmen.
neinStimmenintegerNein-Stimmen.
enthaltungenintegerEnthaltungen.
umsetzungBisstringUmsetzungs-Deadline (YYYY-MM-DD).
dokumentIdintegerVerknüpftes Dokument (ID).
beschluss_workflow_statusLesenZeigt den aktuellen GenioFlow-Status eines Beschlusses (currentState, isTerminal) und die aktuell erlaubten Aktionen inkl. Payload-Felder — genau wie das Workflow-Panel im Portal.Beschluss:ReadLesen

GET /api/v1/partner/beschluesse/:id/workflow

Zeigt den aktuellen GenioFlow-Status eines Beschlusses (currentState, isTerminal) und die aktuell erlaubten Aktionen inkl. Payload-Felder — genau wie das Workflow-Panel im Portal. Vor jeder Transition aufrufen, um zu sehen, welches Event als Nächstes möglich ist und welche Felder der Payload braucht.

Parameter von beschluss_workflow_status
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
beschluss_workflow_transitionSchreibenFührt EINE GenioFlow-Transition für einen Beschluss aus — exakt wie ein User im Portal klickt (kein Bypass; Validierung, Guards, Stimmen-/Ergebnis-Persistenz laufen wie üblich).Beschluss:UpdateBearbeiten

POST /api/v1/partner/beschluesse/:id/workflow/transition

Führt EINE GenioFlow-Transition für einen Beschluss aus — exakt wie ein User im Portal klickt (kein Bypass; Validierung, Guards, Stimmen-/Ergebnis-Persistenz laufen wie üblich). Lebenszyklus: vorgeschlagen --in_versammlung_aufnehmen--> in_versammlung --annehmen|ablehnen|vertagen--> angenommen|abgelehnt|vertagt; angenommen --umsetzung_starten--> in_umsetzung --umsetzung_abschliessen--> umgesetzt; angenommen|in_umsetzung --anfechtung_erfolgreich--> ungueltig. Payload je Event: in_versammlung_aufnehmen {beschluss_kategorie, beschluss_typ}; annehmen|ablehnen {jaStimmen, neinStimmen, enthaltungen}; vertagen {vertagungsgrund_kategorie, vertagungsgrund, neueEtvId?}; umsetzung_starten {umsetzungsBis}; umsetzung_abschliessen {umsetzungsBericht}; anfechtung_erfolgreich {gerichtsurteilAz, urteilDatum}.

Parameter von beschluss_workflow_transition
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
event Pflichtin_versammlung_aufnehmen | annehmen | ablehnen | vertagen | umsetzung_starten | umsetzung_abschliessen | anfechtung_erfolgreichAuszulösendes Workflow-Event. Muss im aktuellen State erlaubt sein (siehe beschluss_workflow_status).
payloadobjectEvent-spezifische Felder (siehe Tool-Beschreibung bzw. payloadSchema aus beschluss_workflow_status).
beirat_schreiben_auflistenLesenListet Beirat-Schreiben (Aufforderungen, Fristsetzungen, Beanstandungen, Prüfberichte des WEG-Verwaltungsbeirats an die Hausverwaltung).BeiratSchreiben:ReadLesen

GET /api/v1/partner/beirat-schreiben

Listet Beirat-Schreiben (Aufforderungen, Fristsetzungen, Beanstandungen, Prüfberichte des WEG-Verwaltungsbeirats an die Hausverwaltung). Felder: Typ, Titel, Adressat, Frist, Workflow-Status, Objekt. Filter: Objekt-Nr., Typ, Status (z. B. entwurf, versendet, frist_laeuft, beantwortet, eskaliert).

Parameter von beirat_schreiben_auflisten
ParameterTypBeschreibung
pageintegerSeitennummer (ab 1).
pageSizeintegerEinträge pro Seite (max. 200).
objektNrintegerNur Schreiben zu diesem Objekt (Objekt-Nr.).
typbeanstandung | aufforderung | fristsetzung | schreiben | pruefberichtNach Schreiben-Typ filtern.
statusstringNach Workflow-Status filtern (z. B. entwurf, versendet, frist_laeuft, beantwortet, eskaliert, erledigt).
beirat_schreiben_detailsLesenZeigt ein einzelnes Beirat-Schreiben mit Details (inkl. Inhalt und HV-Antwort).BeiratSchreiben:ReadLesen

GET /api/v1/partner/beirat-schreiben/:id

Zeigt ein einzelnes Beirat-Schreiben mit Details (inkl. Inhalt und HV-Antwort).

Parameter von beirat_schreiben_details
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
beirat_schreiben_anlegenSchreibenLegt ein neues Beirat-Schreiben an.BeiratSchreiben:CreateBearbeiten

POST /api/v1/partner/beirat-schreiben

Legt ein neues Beirat-Schreiben an. Startet automatisch den Workflow `beirat_schreiben` (Status entwurf). Der Status wird über den Workflow getrieben, nicht hier gesetzt.

Parameter von beirat_schreiben_anlegen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr., zu dem das Schreiben gehört.
typ Pflichtbeanstandung | aufforderung | fristsetzung | schreiben | pruefberichtArt des Schreibens.
titel PflichtstringTitel/Betreff des Schreibens.
inhaltstringInhalt/Fliesstext, optional.
adressatstringEmpfänger (z. B. Hausverwaltung), optional.
fristBisstringGesetzte Frist (YYYY-MM-DD), optional.
beschlussBezugIdintegerVerknüpfter Beschluss (ID), optional.
etvBezugIdintegerVerknüpfte Versammlung (ID), optional.
dokumentIdintegerVerknüpftes Dokument/PDF (ID), optional.
beirat_schreiben_aktualisierenSchreibenAktualisiert ein Beirat-Schreiben (nur übergebene Felder).BeiratSchreiben:UpdateBearbeiten

PATCH /api/v1/partner/beirat-schreiben/:id

Aktualisiert ein Beirat-Schreiben (nur übergebene Felder). Z. B. HV-Antwort erfassen.

Parameter von beirat_schreiben_aktualisieren
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
typbeanstandung | aufforderung | fristsetzung | schreiben | pruefberichtArt des Schreibens.
titelstringTitel/Betreff.
inhaltstringInhalt/Fliesstext.
adressatstringEmpfaenger.
fristBisstringGesetzte Frist (YYYY-MM-DD).
hvAntwortstringAntwort/Reaktion der Hausverwaltung.
beschlussBezugIdintegerVerknüpfter Beschluss (ID).
etvBezugIdintegerVerknüpfte Versammlung (ID).
dokumentIdintegerVerknüpftes Dokument/PDF (ID).
beirat_schreiben_loeschenLöschenLöscht ein Beirat-Schreiben.BeiratSchreiben:DeleteBearbeiten

DELETE /api/v1/partner/beirat-schreiben/:id

Löscht ein Beirat-Schreiben.

Parameter von beirat_schreiben_loeschen
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
beirat_schreiben_workflow_statusLesenZeigt den aktuellen GenioFlow-Status eines Beirat-Schreibens (currentState, isTerminal) und die aktuell erlaubten Aktionen — wie das Workflow-Panel im Portal.BeiratSchreiben:ReadLesen

GET /api/v1/partner/beirat-schreiben/:id/workflow

Zeigt den aktuellen GenioFlow-Status eines Beirat-Schreibens (currentState, isTerminal) und die aktuell erlaubten Aktionen — wie das Workflow-Panel im Portal. Vor jeder Transition aufrufen.

Parameter von beirat_schreiben_workflow_status
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
beirat_schreiben_workflow_transitionSchreibenFührt EINE GenioFlow-Transition für ein Beirat-Schreiben aus (kein Bypass; Engine + Side-Effects laufen).BeiratSchreiben:UpdateBearbeiten

POST /api/v1/partner/beirat-schreiben/:id/workflow/transition

Führt EINE GenioFlow-Transition für ein Beirat-Schreiben aus (kein Bypass; Engine + Side-Effects laufen). Lebenszyklus: entwurf --versenden--> versendet --frist_setzen--> frist_laeuft --beantworten--> beantwortet; frist_laeuft --frist_ueberschritten--> eskaliert; beantwortet --eskalieren--> eskaliert; (versendet|frist_laeuft|beantwortet|eskaliert) --erledigen--> erledigt; jeder nicht-terminale State --zurueckziehen--> zurueckgezogen. Optionale Payload-Felder je Event (versenden {versandtAm}, frist_setzen {fristBis}, beantworten {beantwortetAm}).

Parameter von beirat_schreiben_workflow_transition
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
event Pflichtversenden | frist_setzen | beantworten | frist_ueberschritten | eskalieren | erledigen | zurueckziehenAuszulösendes Workflow-Event. Muss im aktuellen State erlaubt sein (siehe beirat_schreiben_workflow_status).
payloadobjectEvent-spezifische Felder (optional).
wirtschaftsplaene_auflistenLesenListet die Wirtschaftspläne der WEG-Objekte des Mandanten, neueste Jahre zuerst: Objekt, Jahr, Art (Jahresplan oder Nachtrag), Fassung, Stand (entwurf, intern_geprueft, vorgelegt, in_versammlung, vertagt, beschlossen, abgelehnt, zurueckgezogen), Hausgeld-Vorschüsse in Cent (Ausgaben minus Einnahmen plus Instandhaltungsrücklage), Gültigkeit ab und Datum des Inkrafttretens.Wirtschaftsplan:ReadLesen

GET /api/v1/partner/wirtschaftsplaene

Listet die Wirtschaftspläne der WEG-Objekte des Mandanten, neueste Jahre zuerst: Objekt, Jahr, Art (Jahresplan oder Nachtrag), Fassung, Stand (entwurf, intern_geprueft, vorgelegt, in_versammlung, vertagt, beschlossen, abgelehnt, zurueckgezogen), Hausgeld-Vorschüsse in Cent (Ausgaben minus Einnahmen plus Instandhaltungsrücklage), Gültigkeit ab und Datum des Inkrafttretens. Ohne Positionen — die liefert wirtschaftsplan_lesen. Filter nach Objekt und Jahr. Braucht Wirtschaftsplan:Read.

Parameter von wirtschaftsplaene_auflisten
ParameterTypBeschreibung
objektNrintegerObjekt-Nr. (Ganzzahl).
jahrintegerWirtschaftsjahr.
wirtschaftsplan_lesenLesenLiest einen Wirtschaftsplan als Akte: Kopf (Jahr, Fassung, Stand, Vorschüsse in Cent), alle Positionen (Kostenart, Bezeichnung, Betrag in Cent, Umlageschlüssel, umlagefähig, Ausgabe oder Einnahme, Bemerkung) und die Schrittleiste mit den fünf Schritten: je Schritt, ob er erledigt, aktuell oder offen ist, was noch fehlt (mit Reiter und Position als Ziel), Hinweise und die nächste Hauptaktion samt Grund, falls sie gesperrt ist.Wirtschaftsplan:ReadLesen

GET /api/v1/partner/wirtschaftsplaene/:id

Liest einen Wirtschaftsplan als Akte: Kopf (Jahr, Fassung, Stand, Vorschüsse in Cent), alle Positionen (Kostenart, Bezeichnung, Betrag in Cent, Umlageschlüssel, umlagefähig, Ausgabe oder Einnahme, Bemerkung) und die Schrittleiste mit den fünf Schritten: je Schritt, ob er erledigt, aktuell oder offen ist, was noch fehlt (mit Reiter und Position als Ziel), Hinweise und die nächste Hauptaktion samt Grund, falls sie gesperrt ist. So lässt sich beantworten, was am Plan fehlt und was als Nächstes zu tun ist. Zur Prüfung geben, Vorlegen, Beschluss erfassen und Hausgeld in Kraft setzen führt dieses Werkzeug nicht aus — die Schrittleiste zeigt sie nie als ausführbar; das macht der Verwalter in der immoGenio Verwaltung. Braucht Wirtschaftsplan:Read. Ist-Sicht: Beträge nach Zahlung (Tag des Kontoumsatzes) — eine Zahl der Soll-Sicht (Saldenliste, Offene Posten) darf davon abweichen.

Parameter von wirtschaftsplan_lesen
ParameterTypBeschreibung
id PflichtintegerID des Wirtschaftsplans (aus wirtschaftsplaene_auflisten).
wirtschaftsplan_einzelplaene_lesenLesenDie Einzelpläne eines Wirtschaftsplans: je Einheit Miteigentumsanteil (MEA und Gesamt-MEA), Jahresbetrag und Monatsbetrag in Cent und — bei einer Fortschreibung — der bisherige Monatsbetrag, dazu Summen, Rundungsdifferenz und Positionen, die sich nicht rechnen lassen.Wirtschaftsplan:ReadLesen

GET /api/v1/partner/wirtschaftsplaene/:id/einzelplaene

Die Einzelpläne eines Wirtschaftsplans: je Einheit Miteigentumsanteil (MEA und Gesamt-MEA), Jahresbetrag und Monatsbetrag in Cent und — bei einer Fortschreibung — der bisherige Monatsbetrag, dazu Summen, Rundungsdifferenz und Positionen, die sich nicht rechnen lassen. Ohne Eigentümernamen (die Zahlen mit Namen liefert hausgeld_abrechnungslauf_lesen). Im Entwurf live gerechnet, ab der Prüfung der festgeschriebene Stand (Feld quelle). Braucht Wirtschaftsplan:Read.

Parameter von wirtschaftsplan_einzelplaene_lesen
ParameterTypBeschreibung
id PflichtintegerID des Wirtschaftsplans.
wirtschaftsplan_text_lesenLesenLiest den Brieftext des Einzelwirtschaftsplans einer Einheit, wie er an den Eigentümer geht: textHtml (Absätze, Überschriften, Listen; die gerechneten Teile als leere Marken <div data-baustein="vorspann|beschlussstand|zusammenfassung"></div>), Betreff, ob und von wem bearbeitet, die Abweichungen vom Standardtext und ob der Text nach einer Änderung der Vorschüsse zu prüfen ist.Wirtschaftsplan:TextBearbeiten

GET /api/v1/partner/wirtschaftsplaene/:id/einzelplaene/:einheitId/text

Liest den Brieftext des Einzelwirtschaftsplans einer Einheit, wie er an den Eigentümer geht: textHtml (Absätze, Überschriften, Listen; die gerechneten Teile als leere Marken <div data-baustein="vorspann|beschlussstand|zusammenfassung"></div>), Betreff, ob und von wem bearbeitet, die Abweichungen vom Standardtext und ob der Text nach einer Änderung der Vorschüsse zu prüfen ist. editierbar/grund sagen, ob er sich noch ändern lässt (nur bis zum Vorlegen; danach festgeschrieben). Nennt den Eigentümer. Eine Sonderumlage hat kein Anschreiben. id und einheitId stehen in wirtschaftsplan_einzelplaene_lesen. Braucht Wirtschaftsplan:Text.

Parameter von wirtschaftsplan_text_lesen
ParameterTypBeschreibung
id PflichtintegerID des Wirtschaftsplans.
einheitId PflichtstringID der Einheit (aus wirtschaftsplan_einzelplaene_lesen).
wirtschaftsplan_text_setzenSchreibenErsetzt den Brieftext des Einzelwirtschaftsplans einer Einheit vollständig — vorher wirtschaftsplan_text_lesen und dessen textHtml als Grundlage nehmen.Wirtschaftsplan:TextBearbeiten

PUT /api/v1/partner/wirtschaftsplaene/:id/einzelplaene/:einheitId/text

Ersetzt den Brieftext des Einzelwirtschaftsplans einer Einheit vollständig — vorher wirtschaftsplan_text_lesen und dessen textHtml als Grundlage nehmen. Erlaubt sind p, h2, h3, ul, ol, li, strong, em, u, br; alles andere fällt weg. Die drei Bausteinmarken müssen genau einmal und in dieser Reihenfolge stehen (vorspann, beschlussstand, zusammenfassung), sonst 400; Zahlen lassen sich nicht schreiben. Zeitlos schreiben: Der Satz zur Versammlung wechselt mit dem Beschluss von allein, der eigene Text nicht. basiertAuf = bearbeitet.am aus dem Lesen (null beim Standardtext), sonst 409. Nach dem Vorlegen 409. Das Speichern setzt die Prüfung des Beirats nicht zurück. Keine Beträge oder Fristen zusagen, die der Plan nicht trägt. Braucht Wirtschaftsplan:Text.

Parameter von wirtschaftsplan_text_setzen
ParameterTypBeschreibung
id PflichtintegerID des Wirtschaftsplans.
einheitId PflichtstringID der Einheit.
html PflichtstringDer vollständige Brieftext mit den drei Bausteinmarken.
betreffbeliebigEigener Betreff; leer oder null = Standardbetreff.
basiertAuf Pflichtbeliebigbearbeitet.am aus wirtschaftsplan_text_lesen, null beim Standardtext.
wirtschaftsplan_text_zuruecksetzenLöschenVerwirft den bearbeiteten Brieftext des Einzelwirtschaftsplans einer Einheit; er wird wieder vollständig erzeugt.Wirtschaftsplan:TextBearbeiten

DELETE /api/v1/partner/wirtschaftsplaene/:id/einzelplaene/:einheitId/text

Verwirft den bearbeiteten Brieftext des Einzelwirtschaftsplans einer Einheit; er wird wieder vollständig erzeugt. Nur bis zum Vorlegen. Braucht Wirtschaftsplan:Text.

Parameter von wirtschaftsplan_text_zuruecksetzen
ParameterTypBeschreibung
id PflichtintegerID des Wirtschaftsplans.
einheitId PflichtstringID der Einheit.
wirtschaftsplan_text_uebertragenSchreibenÜberträgt den bearbeiteten Brieftext eines Einzelwirtschaftsplans auf die übrigen Einzelpläne desselben Plans.Wirtschaftsplan:TextBearbeiten

POST /api/v1/partner/wirtschaftsplaene/:id/einzelplaene/:einheitId/text/uebertragen

Überträgt den bearbeiteten Brieftext eines Einzelwirtschaftsplans auf die übrigen Einzelpläne desselben Plans. Die Anrede wird je Eigentümer ersetzt. Einzelpläne mit eigenem Text bleiben, außer ersetzen=true. Nennt der Text Beträge oder den Namen des Eigentümers, wird nichts übertragen (409). Antwort: uebertragen, uebersprungen (mit anteilId). Braucht Wirtschaftsplan:Text.

Parameter von wirtschaftsplan_text_uebertragen
ParameterTypBeschreibung
id PflichtintegerID des Wirtschaftsplans.
einheitId PflichtstringEinheit mit dem bearbeiteten Text.
ersetzenbooleanAuch Einzelpläne mit eigenem Text überschreiben. Vorgabe false.
zieleListe (string)Nur diese Einzelpläne (anteilId aus uebersprungen); sonst alle des Plans.
wirtschaftsplan_position_setzenSchreibenSetzt Betrag und/oder Bemerkung einer vorhandenen Position — nur im Entwurf.Wirtschaftsplan:UpdateBearbeiten

PUT /api/v1/partner/wirtschaftsplaene/:id/positionen/:positionId

Setzt Betrag und/oder Bemerkung einer vorhandenen Position — nur im Entwurf. Ist der Plan schon zur Prüfung gegeben, vorgelegt oder beschlossen, antwortet die API mit 409 nicht_im_entwurf und nennt den Weg: ein geprüfter Plan wird in der immoGenio Verwaltung über „Zurück in den Entwurf“ wieder geöffnet, ein vorgelegter über „Neue Fassung anlegen“, ein beschlossener nur über einen Nachtrag mit eigenem Beschluss — das macht der Verwalter, nicht dieses Werkzeug. Betrag in Cent (nicht Euro); bemerkung=null löscht die Bemerkung, ohne Angabe bleibt sie. Mindestens eines von beiden. Gibt nichts zur Prüfung, legt nichts vor und beschließt nichts. Braucht Wirtschaftsplan:Update.

Parameter von wirtschaftsplan_position_setzen
ParameterTypBeschreibung
id PflichtintegerID des Wirtschaftsplans.
positionId PflichtintegerID der Position (aus wirtschaftsplan_lesen).
betragCentintegerNeuer Jahresbetrag der Position in Cent.
bemerkungbeliebigBemerkung zur Position; null löscht sie.
wirtschaftsplan_position_anlegenSchreibenLegt eine neue Position an das Ende eines Wirtschaftsplans — nur im Entwurf (sonst 409 nicht_im_entwurf, Weg wie bei wirtschaftsplan_position_setzen).Wirtschaftsplan:UpdateBearbeiten

POST /api/v1/partner/wirtschaftsplaene/:id/positionen

Legt eine neue Position an das Ende eines Wirtschaftsplans — nur im Entwurf (sonst 409 nicht_im_entwurf, Weg wie bei wirtschaftsplan_position_setzen). Betrag in Cent. Umlageschlüssel: mea (Miteigentumsanteil), flaeche, einheit oder direkt (Beträge je Einheit trägt der Verwalter in der immoGenio Verwaltung ein; bis dahin meldet wirtschaftsplan_lesen die Position als nicht rechenbar). art=einnahme (z. B. Miete für Gemeinschaftseigentum) mindert das Hausgeld, verteilt sich immer nach MEA und ist nie umlagefähig. Gibt nichts zur Prüfung, legt nichts vor und beschließt nichts. Braucht Wirtschaftsplan:Update.

Parameter von wirtschaftsplan_position_anlegen
ParameterTypBeschreibung
id PflichtintegerID des Wirtschaftsplans.
kostenart PflichtstringKostenart (Code oder Name wie bei den übrigen Positionen des Plans).
bezeichnung PflichtstringBezeichnung der Position.
betragCent PflichtintegerJahresbetrag in Cent.
umlageschluessel Pflichtmea | flaeche | einheit | direktVerteilung auf die Einheiten.
umlagefaehigbooleanAuf Mieter umlagefähig (Vorgabe: ja; bei Einnahmen immer nein).
artausgabe | einnahmeAusgabe (Vorgabe) oder Einnahme.
bemerkungbeliebigBemerkung zur Position.
wirtschaftsplan_anlegenSchreibenLegt den Entwurf eines Wirtschaftsplans (Jahresplan) für ein Objekt und ein Jahr an — dieselbe Funktion wie „Plan anlegen“ im Portal.Wirtschaftsplan:CreateBearbeiten

POST /api/v1/partner/wirtschaftsplaene

Legt den Entwurf eines Wirtschaftsplans (Jahresplan) für ein Objekt und ein Jahr an — dieselbe Funktion wie „Plan anlegen“ im Portal. grundlage=leer (Vorgabe) beginnt ohne Positionen, grundlage=vorjahr übernimmt die Positionen des Vorjahresplans (mit anpassungProzent, z. B. 3 für + 3 %). Je Objekt und Jahr gibt es höchstens einen laufenden Plan (409); nach einer Ablehnung entsteht die nächste Fassung im Portal. Danach: Positionen mit wirtschaftsplan_position_anlegen. Der Entwurf wird nicht geprüft, nicht vorgelegt und nicht beschlossen — das macht der Verwalter im Portal. Braucht Wirtschaftsplan:Create.

Parameter von wirtschaftsplan_anlegen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerWirtschaftsjahr.
grundlageleer | vorjahrleer (Vorgabe) oder die Positionen des Vorjahresplans übernehmen.
anpassungProzentnumberPauschale Anpassung der übernommenen Kosten in Prozent (nur bei grundlage=vorjahr).
notizenbeliebigInterne Notiz zum Plan.
wirtschaftsplan_hausgeld_vorschauLesenZeigt, was das Hausgeld eines beschlossenen Wirtschaftsplans stellen würde — ohne etwas zu schreiben: Monate, wie viele Zeilen neu, geändert oder unverändert sind, gesperrte Zeilen (schon bezahlt, gemahnt oder im Lastschriftlauf), Nachforderung, Summe je Monat in Cent und Hindernisse (leer heißt: ausführbar).Wirtschaftsplan:HausgeldBearbeiten · nur persönlich

GET /api/v1/partner/wirtschaftsplaene/:id/hausgeld-vorschau

Zeigt, was das Hausgeld eines beschlossenen Wirtschaftsplans stellen würde — ohne etwas zu schreiben: Monate, wie viele Zeilen neu, geändert oder unverändert sind, gesperrte Zeilen (schon bezahlt, gemahnt oder im Lastschriftlauf), Nachforderung, Summe je Monat in Cent und Hindernisse (leer heißt: ausführbar). Zahlen, keine Namen. Vor wirtschaftsplan_hausgeld_nachstellen immer ansehen und dem Menschen nennen. Nur über den persönlichen KI-Zugang. Braucht Wirtschaftsplan:Hausgeld.

Parameter von wirtschaftsplan_hausgeld_vorschau
ParameterTypBeschreibung
id PflichtintegerID des Wirtschaftsplans.
wirtschaftsplan_hausgeld_nachstellenSchreibenStellt das Hausgeld eines beschlossenen Wirtschaftsplans nach, der im Portal schon in Kraft gesetzt wurde: Was fehlt (neue Einheit, neuer Eigentümer), kommt hinzu, geänderte Beträge werden angepasst, Gebuchtes, Bezahltes, Gemahntes und Eingezogenes bleibt stehen (409 mit dem Weg, wenn ein Monat gesperrt ist).Wirtschaftsplan:HausgeldBearbeiten · nur persönlich

POST /api/v1/partner/wirtschaftsplaene/:id/hausgeld-nachstellen

Stellt das Hausgeld eines beschlossenen Wirtschaftsplans nach, der im Portal schon in Kraft gesetzt wurde: Was fehlt (neue Einheit, neuer Eigentümer), kommt hinzu, geänderte Beträge werden angepasst, Gebuchtes, Bezahltes, Gemahntes und Eingezogenes bleibt stehen (409 mit dem Weg, wenn ein Monat gesperrt ist). Ein Plan, der noch nicht in Kraft ist, wird abgewiesen (409 nicht_in_kraft): Das erste Inkraftsetzen und der Beschluss sind Handlungen des Verwalters im Portal. Es geht keine Mitteilung an die Eigentümer hinaus und keine Lastschrift. VORHER wirtschaftsplan_hausgeld_vorschau lesen und die Zahlen dem Menschen nennen. Nur über den persönlichen KI-Zugang. Braucht Wirtschaftsplan:Hausgeld.

Parameter von wirtschaftsplan_hausgeld_nachstellen
ParameterTypBeschreibung
id PflichtintegerID des Wirtschaftsplans.
versammlung_meine_teilnahme_lesenLesenLiest, was der angemeldete Eigentümer zu einer Versammlung angegeben hat: seine Rückmeldung (vor_ort, online, vertretung, nicht oder offen), ob online bzw. vor Ort möglich ist, und seine erteilten und erhaltenen Vollmachten samt Weisungen.Versammlung:TeilnahmeBearbeiten · nur persönlich

GET /api/v1/partner/versammlungen/:etvId/meine-teilnahme

Liest, was der angemeldete Eigentümer zu einer Versammlung angegeben hat: seine Rückmeldung (vor_ort, online, vertretung, nicht oder offen), ob online bzw. vor Ort möglich ist, und seine erteilten und erhaltenen Vollmachten samt Weisungen. Die Gemeinschaft ergibt sich aus der Versammlung, der Eigentümer aus dem Konto. Nur über den persönlichen KI-Zugang. Braucht Versammlung:Teilnahme.

Parameter von versammlung_meine_teilnahme_lesen
ParameterTypBeschreibung
etvId PflichtintegerID des Datensatzes.
versammlung_teilnahme_meldenSchreibenMeldet die Teilnahme des angemeldeten Eigentümers an einer Versammlung: vor_ort, online, vertretung oder nicht; null nimmt die Rückmeldung zurück.Versammlung:TeilnahmeBearbeiten · nur persönlich

PUT /api/v1/partner/versammlungen/:etvId/meine-teilnahme

Meldet die Teilnahme des angemeldeten Eigentümers an einer Versammlung: vor_ort, online, vertretung oder nicht; null nimmt die Rückmeldung zurück. online gibt es nur bei einer Hybrid- oder virtuellen Versammlung, vor_ort nicht bei einer virtuellen; vertretung setzt eine aktive Vollmacht voraus (versammlung_vollmacht_erteilen). Änderbar, bis die Anwesenheit erfasst wird. Nur über den persönlichen KI-Zugang. Braucht Versammlung:Teilnahme.

Parameter von versammlung_teilnahme_melden
ParameterTypBeschreibung
etvId PflichtintegerID des Datensatzes.
art Pflichtvor_ort | online | vertretung | nicht | nullDie Rückmeldung; null nimmt sie zurück.
versammlung_vollmacht_erteilenSchreibenErteilt eine Vollmacht des angemeldeten Eigentümers an einen anderen Eigentümer derselben Gemeinschaft (§ 25 Abs. 3 WEG, Textform: Bestätigung per E-Mail an beide).Versammlung:VollmachtBearbeiten · nur persönlich

POST /api/v1/partner/versammlungen/:etvId/vollmacht

Erteilt eine Vollmacht des angemeldeten Eigentümers an einen anderen Eigentümer derselben Gemeinschaft (§ 25 Abs. 3 WEG, Textform: Bestätigung per E-Mail an beide). Je Tagesordnungspunkt kann eine Weisung mitgegeben werden (ja, nein, enthaltung, frei); fehlende Punkte gelten als frei. Pro Versammlung nur eine aktive Vollmacht; Zirkel werden abgewiesen. Den Vertreter nennt vollmachtnehmer_id (UUID des Eigentümers aus der Gemeinschaft). Nur über den persönlichen KI-Zugang. Braucht Versammlung:Vollmacht.

Parameter von versammlung_vollmacht_erteilen
ParameterTypBeschreibung
etvId PflichtintegerID des Datensatzes.
vollmachtnehmer_id PflichtstringUUID des Eigentümers, der vertreten soll (z. B. aus der jeweiligen Liste).
weisungenListe (object)Eine Weisung je Tagesordnungspunkt.
versammlung_vollmacht_widerrufenSchreibenWiderruft eine eigene Vollmacht (nur der Vollmachtgeber; nicht mehr, wenn sie schon ausgeübt wurde).Versammlung:VollmachtBearbeiten · nur persönlich

POST /api/v1/partner/vollmachten/:vollmachtId/widerruf

Widerruft eine eigene Vollmacht (nur der Vollmachtgeber; nicht mehr, wenn sie schon ausgeübt wurde). Die Rückmeldung „vertretung" fällt damit zurück auf offen. Die Vollmacht-ID steht in versammlung_meine_teilnahme_lesen. Nur über den persönlichen KI-Zugang. Braucht Versammlung:Vollmacht.

Parameter von versammlung_vollmacht_widerrufen
ParameterTypBeschreibung
vollmachtId PflichtintegerID des Datensatzes.
bescheinigungen_auflistenLesenListet den Eingang der Bescheinigungs-Anfragen von Eigentümern: Art (Hausgeldbescheinigung, Bescheinigung nach § 35a, Verkaufsunterlagen, Jahresübersicht, Verwalterzustimmung), Objekt und Einheit, Stand (offen, freigegeben, erledigt, abgelehnt, zurueckgezogen) und die Gebühr brutto, wo eine anfällt.Bescheinigung:ReadLesen

GET /api/v1/partner/bescheinigungen

Listet den Eingang der Bescheinigungs-Anfragen von Eigentümern: Art (Hausgeldbescheinigung, Bescheinigung nach § 35a, Verkaufsunterlagen, Jahresübersicht, Verwalterzustimmung), Objekt und Einheit, Stand (offen, freigegeben, erledigt, abgelehnt, zurueckgezogen) und die Gebühr brutto, wo eine anfällt. Ohne die Angaben des Eigentümers. Mit status=offen sind es die, auf die die Verwaltung noch antworten muss. Braucht Bescheinigung:Read.

Parameter von bescheinigungen_auflisten
ParameterTypBeschreibung
statusoffen | freigegeben | erledigt | abgelehnt | zurueckgezogenNur Anforderungen in diesem Stand.
bescheinigung_lesenLesenLiest eine Anforderung des Eingangs (Art, Objekt, Stand, Gebühr brutto) — ohne die Angaben des Eigentümers.Bescheinigung:ReadLesen

GET /api/v1/partner/bescheinigungen/:id

Liest eine Anforderung des Eingangs (Art, Objekt, Stand, Gebühr brutto) — ohne die Angaben des Eigentümers. Zum Prüfen siehe bescheinigung_pruefung_lesen. Braucht Bescheinigung:Read.

Parameter von bescheinigung_lesen
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
bescheinigung_pruefung_lesenLesenLiest, was zum Entscheiden nötig ist: die Angaben des Eigentümers, die Hinweise des Systems (zum Beispiel Rückstand) und die Prüfliste (Pflichtpunkte mit schluessel).Bescheinigung:EntscheidenBearbeiten · nur persönlich

GET /api/v1/partner/bescheinigungen/:id/pruefung

Liest, was zum Entscheiden nötig ist: die Angaben des Eigentümers, die Hinweise des Systems (zum Beispiel Rückstand) und die Prüfliste (Pflichtpunkte mit schluessel). Nur über den persönlichen KI-Zugang. Braucht Bescheinigung:Entscheiden.

Parameter von bescheinigung_pruefung_lesen
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
bescheinigung_freigebenSchreibenGibt eine Anforderung frei: Die Unterlage entsteht und liegt beim Eigentümer, der eine Nachricht bekommt; eine vereinbarte Gebühr wird mit der Freigabe in Rechnung gestellt.Bescheinigung:EntscheidenBearbeiten · nur persönlich

POST /api/v1/partner/bescheinigungen/:id/freigabe

Gibt eine Anforderung frei: Die Unterlage entsteht und liegt beim Eigentümer, der eine Nachricht bekommt; eine vereinbarte Gebühr wird mit der Freigabe in Rechnung gestellt. pruefliste nennt die abgehakten Punkte (schluessel aus bescheinigung_pruefung_lesen) — ohne alle Pflichtpunkte wird abgewiesen. gebuehr_erlass verzichtet auf die Gebühr, nur mit Begründung (mindestens 10 Zeichen, steht im Verlauf). Das ist die Entscheidung des Menschen hinter dem Zugang: erst die Vorschau und die Hinweise lesen, nie ungefragt freigeben. Nur über den persönlichen KI-Zugang. Braucht Bescheinigung:Entscheiden.

Parameter von bescheinigung_freigeben
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
pruefliste PflichtListe (string)Die abgehakten Punkte der Prüfliste (schluessel).
gebuehr_erlassobject
bescheinigung_ablehnenSchreibenLehnt eine Anforderung ab.Bescheinigung:EntscheidenBearbeiten · nur persönlich

POST /api/v1/partner/bescheinigungen/:id/ablehnung

Lehnt eine Anforderung ab. Der Grund (mindestens 10 Zeichen) wird dem Eigentümer gezeigt; es entsteht weder Dokument noch Rechnung. Nur über den persönlichen KI-Zugang. Braucht Bescheinigung:Entscheiden.

Parameter von bescheinigung_ablehnen
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
grund PflichtstringDer Grund der Ablehnung — der Eigentümer liest ihn.

[07]66 Tools

Finanzen: Bank, Rechnungen, Buchungen

honorare_auflistenLesenListet die Honorarrechnungen der Verwaltung an ihre Kunden (Eigentümer von WEGs und Mietobjekten), die ohne Buchung im Mandanten gestellt wurden: Rechnungsnummer, Datum, Fälligkeit, Brutto, gezahlt, offen (getrennt nach Hauptforderung, Mahnkosten und Verzugszinsen), Stand, Tage überfällig, Mahnstufe, Mandant und Betreff.Honorare:ReadLesen

GET /api/v1/partner/honorare

Listet die Honorarrechnungen der Verwaltung an ihre Kunden (Eigentümer von WEGs und Mietobjekten), die ohne Buchung im Mandanten gestellt wurden: Rechnungsnummer, Datum, Fälligkeit, Brutto, gezahlt, offen (getrennt nach Hauptforderung, Mahnkosten und Verzugszinsen), Stand, Tage überfällig, Mahnstufe, Mandant und Betreff. ACHTUNG: Die Liste umfasst ALLE Kunden der Verwaltung, nicht nur den Mandanten des Tokens. Offene Beträge sind Cent-Ganzzahlen; eine Zahlung tilgt zuerst Kosten, dann Zinsen, dann die Hauptforderung (§ 367 BGB). meta.kennzahlen nennt Summe und Anzahl offener und überfälliger Rechnungen — für diese Fragen nicht selbst summieren. Den Empfängernamen liefert nur der Scope Honorare:ReadPII. Braucht den Scope Honorare:Read.

Parameter von honorare_auflisten
ParameterTypBeschreibung
standoffen | ueberfaellig | alleoffen = noch nicht vollständig bezahlt (ohne aufgehobene); ueberfaellig = offen und nach Fälligkeit; alle = auch bezahlte und aufgehobene der letzten zwei Jahre.
honorar_detailsLesenZeigt eine Honorarrechnung der Verwaltung mit den zugeordneten Zahlungen (Buchungstag, Betrag, Tilgungsgrund, ggf. aufgehoben) und den Mahnungen (Stufe, Frist, Mahnkosten, Verzugszinsen, Status).Honorare:ReadLesen

GET /api/v1/partner/honorare/:id

Zeigt eine Honorarrechnung der Verwaltung mit den zugeordneten Zahlungen (Buchungstag, Betrag, Tilgungsgrund, ggf. aufgehoben) und den Mahnungen (Stufe, Frist, Mahnkosten, Verzugszinsen, Status). Die id ist eine UUID aus honorare_auflisten. Namen von Empfänger und Zahlendem nur mit Scope Honorare:ReadPII. Braucht den Scope Honorare:Read.

Parameter von honorar_details
ParameterTypBeschreibung
id PflichtstringUUID der Honorarrechnung (z. B. aus der jeweiligen Liste).
rechnungseingang_auflistenLesenListet den Eingangskorb des digitalen Rechnungsempfangs: Rechnungen, die per E-Mail an die Rechnungsadresse der Verwaltung kamen.Rechnungseingang:ReadLesen mit Kontaktdaten

GET /api/v1/partner/rechnungseingang

Listet den Eingangskorb des digitalen Rechnungsempfangs: Rechnungen, die per E-Mail an die Rechnungsadresse der Verwaltung kamen. Je Eintrag Absender (absenderPruefung.bestaetigt = DMARC/DKIM bestanden), Datei, erkannte Art (e_rechnung, pdf_rechnung, mahnung, angebot, unbekannt), erkannte Angaben (Rechnungsnummer, Brutto, Lieferant, USt-IdNr, Käufer, Referenzen, Auftrag samt Abweichung vom Angebot) und `vorschlaege` mit Begründung — `tatsache=true` ist belegt (Adresse, Referenz, Auftrag, Leistungsort), `tatsache=false` nur ähnlich. `widerspruch` heißt: zwei Tatsachen zeigen auf verschiedene Mandanten — dann nicht raten. ACHTUNG: umfasst ALLE Kunden der Verwaltung. meta.mandanten nennt die möglichen Ziele. Braucht Rechnungseingang:Read.

Parameter von rechnungseingang_auflisten
ParameterTypBeschreibung
filteroffen | uebernommen | aussortiert | alleoffen = wartet auf Zuordnung; uebernommen = liegt im Mandanten; aussortiert = verworfen, keine Rechnung oder Dublette.
suchestringFreitext in Absender, Betreff, Dateiname, Rechnungsnummer, Lieferant.
limitintegerEinträge je Seite.
offsetintegerVersatz zum Blättern.
rechnungseingang_lesenLesenLiefert ein Eingangsdokument mit der Mail (Empfängeradresse, Textauszug) und den übrigen Anhängen derselben Mail — PFLICHT vor rechnungseingang_zuordnen.Rechnungseingang:ReadLesen mit Kontaktdaten

GET /api/v1/partner/rechnungseingang/:id

Liefert ein Eingangsdokument mit der Mail (Empfängeradresse, Textauszug) und den übrigen Anhängen derselben Mail — PFLICHT vor rechnungseingang_zuordnen. Die Datei selbst liefert das Tool nicht. Braucht Rechnungseingang:Read.

Parameter von rechnungseingang_lesen
ParameterTypBeschreibung
id PflichtstringUUID des Eingangsdokuments (aus rechnungseingang_auflisten) (z. B. aus der jeweiligen Liste).
rechnungseingang_zuordnenSchreibenOrdnet ein offenes Eingangsdokument einem Mandanten zu und übernimmt es dort — als E-Rechnung (geprüft, IBAN-Positivliste) bzw. als Beleg (OCR, kostet Credits).Rechnungseingang:AssignBearbeiten

POST /api/v1/partner/rechnungseingang/:id/zuordnung

Ordnet ein offenes Eingangsdokument einem Mandanten zu und übernimmt es dort — als E-Rechnung (geprüft, IBAN-Positivliste) bzw. als Beleg (OCR, kostet Credits). VORHER rechnungseingang_lesen. Nur zuordnen, wenn eine Tatsache den Mandanten belegt oder der Inhalt ihn eindeutig nennt; bei `widerspruch` oder bloßen Ähnlichkeiten nicht zuordnen. Antwortet 409, wenn dieselbe Rechnung im Mandanten schon vorliegt — dann aussortieren (status=dublette) statt trotzDublette. Es wird nichts freigegeben und nichts bezahlt. Braucht Rechnungseingang:Assign.

Parameter von rechnungseingang_zuordnen
ParameterTypBeschreibung
id PflichtstringUUID des Eingangsdokuments (z. B. aus der jeweiligen Liste).
tenantId PflichtstringMandant (id aus meta.mandanten von rechnungseingang_auflisten).
trotzDublettebooleanNur auf ausdrückliche Anweisung eines Menschen.
rechnungseingang_aussortierenSchreibenNimmt ein offenes Eingangsdokument aus dem Korb, ohne etwas anzulegen: status=keine_rechnung (Werbung, Rückfrage, Mahnung ohne neue Rechnung), dublette (liegt schon vor) oder verworfen (unlesbar, falscher Empfänger).Rechnungseingang:AssignBearbeiten

POST /api/v1/partner/rechnungseingang/:id/aussortieren

Nimmt ein offenes Eingangsdokument aus dem Korb, ohne etwas anzulegen: status=keine_rechnung (Werbung, Rückfrage, Mahnung ohne neue Rechnung), dublette (liegt schon vor) oder verworfen (unlesbar, falscher Empfänger). grund ist Pflicht (mind. 3 Zeichen) und erscheint im Portal. Umkehrbar im Portal. Braucht Rechnungseingang:Assign.

Parameter von rechnungseingang_aussortieren
ParameterTypBeschreibung
id PflichtstringUUID des Eingangsdokuments (z. B. aus der jeweiligen Liste).
status Pflichtverworfen | keine_rechnung | dubletteWie aussortiert wird.
grund PflichtstringBegründung, lesbar für den Verwalter.
bankkonten_auflistenLesenListet die Bankkonten des Mandanten: id (für die Kontoauszug-Tools), Bezeichnung, IBAN, BIC, Bank, kontotyp (giro, tagesgeld, ruecklage, mietkaution, sonstiges), verwendung, aktiv, anbindung (manual = ohne automatischen Abruf, sonst der Anbieter des Kontoabrufs) und letzter_auszug — Nummer, Buchungsdatum bis und Schlusssaldo (Cent) des zuletzt als Datei eingelesenen Auszugs.Bankkonto:ReadLesen mit Kontaktdaten

GET /api/v1/partner/bankkonten

Listet die Bankkonten des Mandanten: id (für die Kontoauszug-Tools), Bezeichnung, IBAN, BIC, Bank, kontotyp (giro, tagesgeld, ruecklage, mietkaution, sonstiges), verwendung, aktiv, anbindung (manual = ohne automatischen Abruf, sonst der Anbieter des Kontoabrufs) und letzter_auszug — Nummer, Buchungsdatum bis und Schlusssaldo (Cent) des zuletzt als Datei eingelesenen Auszugs. Daran setzt die Lückenprüfung der nächsten Datei an. Konten anlegen oder ändern geht nur im Portal. Braucht Bankkonto:Read.

kontoauszug_vorschauLesenPrüft eine Kontoauszug-Datei (MT940, CAMT.052, CAMT.053 oder CSV-Umsatzexport von norisbank/Deutscher Bank — das Format wird am Inhalt erkannt) gegen ein Bankkonto, ohne etwas zu schreiben — dieselbe Vorschau wie der Dialog im Portal.Bankkonto:ReadLesen mit Kontaktdaten

POST /api/v1/partner/bankkonten/:bankkontoId/kontoauszug/vorschau

Prüft eine Kontoauszug-Datei (MT940, CAMT.052, CAMT.053 oder CSV-Umsatzexport von norisbank/Deutscher Bank — das Format wird am Inhalt erkannt) gegen ein Bankkonto, ohne etwas zu schreiben — dieselbe Vorschau wie der Dialog im Portal. PFLICHT vor kontoauszug_importieren. Liefert Format, Zahl der Auszüge und Bewegungen, je Auszug Warnungen (Lücke zum vorigen Auszug, Sprung in der Auszugsnummer, Salden passen nicht zur Summe der Buchungen) und falschesKonto (IBAN der Datei passt nicht zum Konto), dazu bereitsVorhanden (schon eingelesene Auszüge) und das Protokoll unlesbarer Zeilen. inhaltBase64 sind die ROHEN BYTES der Datei, nicht der dekodierte Text: MT940 ist oft ISO-8859-1 oder CP850, und der Zeichensatz wird an den Bytes erkannt. Höchstens 20 MB. Braucht Bankkonto:Read.

Parameter von kontoauszug_vorschau
ParameterTypBeschreibung
bankkontoId PflichtstringUUID des Bankkontos (aus bankkonten_auflisten) (z. B. aus der jeweiligen Liste).
inhaltBase64 PflichtstringDateiinhalt als Base64 der unveränderten Bytes.
dateiname PflichtstringDateiname, z. B. aus dem Mail-Anhang (erscheint am Auszug).
kontoauszug_importierenSchreibenLiest eine Kontoauszug-Datei (MT940, CAMT.052, CAMT.053 oder CSV-Umsatzexport) am Bankkonto ein: legt die Bewegungen an und stößt das Matching an (Zuordnung zu Mietern und offenen Posten, Buchungsregeln als Vorschlag).Kontoauszug:ImportBearbeiten

POST /api/v1/partner/bankkonten/:bankkontoId/kontoauszug

Liest eine Kontoauszug-Datei (MT940, CAMT.052, CAMT.053 oder CSV-Umsatzexport) am Bankkonto ein: legt die Bewegungen an und stößt das Matching an (Zuordnung zu Mietern und offenen Posten, Buchungsregeln als Vorschlag). Es wird NICHTS gebucht und nichts bezahlt — Journal-Einträge entstehen erst über „buchen" im Kontoauszug des Portals. VORHER kontoauszug_vorschau. Meldet die Vorschau eine Lücke, einen Saldenwiderspruch oder falschesKonto, NICHT importieren, sondern dem Menschen melden. Eine schon eingelesene Datei legt nichts an und steht in bereitsVorhanden. Gleiche Parameter wie kontoauszug_vorschau. Braucht Kontoauszug:Import.

Parameter von kontoauszug_importieren
ParameterTypBeschreibung
bankkontoId PflichtstringUUID des Bankkontos (aus bankkonten_auflisten) (z. B. aus der jeweiligen Liste).
inhaltBase64 PflichtstringDateiinhalt als Base64 der unveränderten Bytes.
dateiname PflichtstringDateiname, z. B. aus dem Mail-Anhang (erscheint am Auszug).
gemeinsame_bankkonten_auflistenLesenListet die gemeinsamen Bankkonten, die der Mandant nutzt — Konten, über die mehrere Mandanten desselben Unternehmens laufen (Privatkunde mit mehreren Häusern, ein Konto).GemeinsamesKonto:ReadLesen mit Kontaktdaten

GET /api/v1/partner/gemeinsame-bankkonten

Listet die gemeinsamen Bankkonten, die der Mandant nutzt — Konten, über die mehrere Mandanten desselben Unternehmens laufen (Privatkunde mit mehreren Häusern, ein Konto). Je Konto: id (für den Eingang), IBAN, Bank, Kontoinhaber, mein_bankkonto (Bankkonto dieses Mandanten mit anteil_cent = Anteil dieses Mandanten am Konto, nicht der Kontostand der Bank), die anderen Mandanten, offen_anzahl (noch nicht verteilte Umsätze), darf_verteilen und — nur mit darf_verteilen — abstimmung: Kontostand laut Bank = Anteile der Mandanten + privat + noch nicht verteilt, mit differenz_cent. Braucht GemeinsamesKonto:Read.

gemeinsames_konto_eingang_lesenLesenLiest die noch nicht verteilten Umsätze eines gemeinsamen Kontos mit Vorschlag: art mandant (tenant_id), teile (je tenant_id oder null = privat ein Betrag in Cent), privat oder mehrdeutig (tenant_ids), dazu grund und quelle (regel, kenntnis = IBAN oder Vertragsnummer in einem Mandanten bekannt, verlauf = wie zuletzt).GemeinsamesKonto:ReadLesen mit Kontaktdaten

GET /api/v1/partner/gemeinsame-bankkonten/:kontoId/eingang

Liest die noch nicht verteilten Umsätze eines gemeinsamen Kontos mit Vorschlag: art mandant (tenant_id), teile (je tenant_id oder null = privat ein Betrag in Cent), privat oder mehrdeutig (tenant_ids), dazu grund und quelle (regel, kenntnis = IBAN oder Vertragsnummer in einem Mandanten bekannt, verlauf = wie zuletzt). erlaubte_mandanten nennt, wem der Umsatz an seinem Buchungstag zugewiesen werden darf. Mit nur_eindeutige=true fehlt dem Menschen hinter dem Zugang das Recht in den anderen Mandanten: Es stehen nur Umsätze da, die eindeutig diesem Mandanten gehören, verdeckt nennt die übrigen als Zahl. Braucht GemeinsamesKonto:Read.

Parameter von gemeinsames_konto_eingang_lesen
ParameterTypBeschreibung
kontoId PflichtstringUUID des gemeinsamen Kontos (aus gemeinsame_bankkonten_auflisten) (z. B. aus der jeweiligen Liste).
gemeinsamen_umsatz_verteilenSchreibenVerteilt einen Umsatz aus dem Eingang eines gemeinsamen Kontos — genau einmal: ziel.art mandant mit tenant_id (ganzer Betrag an diesen Mandanten), teile mit [{tenant_id oder null für privat, cent}] (mindestens zwei, Summe genau der Betrag, Vorzeichen wie der Umsatz) oder privat (gehört keinem Mandanten).GemeinsamesKonto:VerteilenBearbeiten

POST /api/v1/partner/gemeinsame-bankkonten/:kontoId/eingang/:umsatzId/verteilen

Verteilt einen Umsatz aus dem Eingang eines gemeinsamen Kontos — genau einmal: ziel.art mandant mit tenant_id (ganzer Betrag an diesen Mandanten), teile mit [{tenant_id oder null für privat, cent}] (mindestens zwei, Summe genau der Betrag, Vorzeichen wie der Umsatz) oder privat (gehört keinem Mandanten). Es wird NICHTS gebucht: Im Mandanten entsteht ein Umsatz, der dort zugeordnet und gebucht wird wie jeder andere. Übernimm den Vorschlag aus gemeinsames_konto_eingang_lesen; bei mehrdeutig oder ohne Vorschlag NICHT raten, sondern den Menschen fragen. Ohne Recht in allen Mandanten geht nur ein eindeutiger Vorschlag an diesen Mandanten. Braucht GemeinsamesKonto:Verteilen.

Parameter von gemeinsamen_umsatz_verteilen
ParameterTypBeschreibung
kontoId PflichtstringUUID des gemeinsamen Kontos (z. B. aus der jeweiligen Liste).
umsatzId PflichtstringUUID des Umsatzes im Eingang (aus gemeinsames_konto_eingang_lesen) (z. B. aus der jeweiligen Liste).
ziel PflichtobjectWohin der Umsatz geht.
gemeinsame_verteilung_zuruecknehmenSchreibenNimmt die Verteilung eines Umsatzes aus einem gemeinsamen Konto ganz zurück (alle Teile); er steht danach wieder im Eingang.GemeinsamesKonto:VerteilenBearbeiten

POST /api/v1/partner/gemeinsame-bankkonten/umsaetze/:bankTransaktionId/zuruecknehmen

Nimmt die Verteilung eines Umsatzes aus einem gemeinsamen Konto ganz zurück (alle Teile); er steht danach wieder im Eingang. Entweder mit kontoId und umsatzId (Umsatz im Eingang, nur mit Recht in allen Mandanten des Kontos) oder mit bankTransaktionId (der Umsatz in diesem Mandanten; eine Aufteilung braucht das Recht in allen). Geht nicht, solange ein Teil gebucht, ausgeglichen oder in einem Zahllauf ist — dann zuerst dort zurücknehmen (Antwort 409 nennt den Mandanten). Braucht GemeinsamesKonto:Verteilen.

Parameter von gemeinsame_verteilung_zuruecknehmen
ParameterTypBeschreibung
kontoIdstringUUID des gemeinsamen Kontos (z. B. aus der jeweiligen Liste).
umsatzIdstringUUID des Umsatzes im Eingang (z. B. aus der jeweiligen Liste).
bankTransaktionIdstringUUID des Umsatzes im Bankkonto dieses Mandanten (z. B. aus der jeweiligen Liste).
zahlungseingaenge_auflistenLesenListet die Zahlungseingänge des Mandanten, die noch nicht ausgeglichen sind — der Eingangskorb des Portals.Bankkonto:ReadLesen mit Kontaktdaten

GET /api/v1/partner/zahlungseingaenge

Listet die Zahlungseingänge des Mandanten, die noch nicht ausgeglichen sind — der Eingangskorb des Portals. Je Eintrag: Bewegung (id, Datum, Betrag, offen_cent, Gegenpartei, Verwendungszweck), stapel (bestaetigen = Zahler sicher erkannt und jeder Posten voll getilgt, klaeren = ein Mensch muss entscheiden, in_klaerung = bereits in Klärung), bei klaeren der grund (kein_zahler, zahler_unsicher, keine_offenen_posten, ueberzahlung, bestimmung_unklar, rest_fuer_weiteren_zahler, ruecklastschrift), der erkannte Zahler (partner), die Begründung, die Zeilen, die beim Bestätigen gebucht würden, und der fingerabdruck dieses Ausgleichs. kopf zählt Eingänge, ausgeglichene und offene Posten. Nur ansehen: Mit art=ausgleich und stapel=bestaetigen geht es weiter mit zahlungseingaenge_bestaetigen, bei klaeren mit zahlungseingang_vorschlag_lesen — niemals raten. konto (aus bankkonten_auflisten) grenzt ein; bei einer auf Objekte oder Einheiten begrenzten Rolle ist es Pflicht. Braucht Bankkonto:Read. Ist-Sicht: Beträge nach Zahlung (Tag des Kontoumsatzes) — eine Zahl der Soll-Sicht (Saldenliste, Offene Posten) darf davon abweichen.

Parameter von zahlungseingaenge_auflisten
ParameterTypBeschreibung
kontostringUUID des Bankkontos (aus bankkonten_auflisten) (z. B. aus der jeweiligen Liste).
vonstringBuchungsdatum ab (JJJJ-MM-TT).
bisstringBuchungsdatum bis (JJJJ-MM-TT).
zahlerstringNur Eingänge dieses Zahlers: "mieter:<ID>" oder "eigentuemer:<ID>" — erkannt oder mit passendem Betrag.
bankabgleichbooleantrue: auch Regelbuchungen und Rücklastschriften (art=regel bzw. ruecklastschrift) — die gehören einem Menschen.
zahlungseingang_vorschlag_lesenLesenLiest den Ausgleichs-Dialog zu einem Zahlungseingang: Eingang, die offenen Posten des Zahlers (id, Monat, offen_cent) und den Vorschlag nach § 366 BGB (zuordnungen mit posten_id und betrag_cent), dazu erkannte Tilgungsbestimmung, Rest, bisherige Vorgänge und Guthaben.Zahlungsausgleich:ReadLesen mit Kontaktdaten

GET /api/v1/partner/zahlungseingaenge/:bewegungId/vorschlag

Liest den Ausgleichs-Dialog zu einem Zahlungseingang: Eingang, die offenen Posten des Zahlers (id, Monat, offen_cent) und den Vorschlag nach § 366 BGB (zuordnungen mit posten_id und betrag_cent), dazu erkannte Tilgungsbestimmung, Rest, bisherige Vorgänge und Guthaben. Schreibt nichts. Ohne erkannten Zahler mieter_id oder eigentuemer_id (genau eines) mitgeben — das ist der Weg, eine andere Zuordnung zu prüfen, bevor zahlungseingang_ausgleichen sie bucht. Braucht Zahlungsausgleich:Read.

Parameter von zahlungseingang_vorschlag_lesen
ParameterTypBeschreibung
bewegungId PflichtstringUUID der Bank-Bewegung (id aus zahlungseingaenge_auflisten) (z. B. aus der jeweiligen Liste).
mieter_idstringUUID des Mieters, dessen offene Posten gezeigt werden (z. B. aus der jeweiligen Liste).
eigentuemer_idstringUUID des Eigentümers, dessen Hausgeldforderungen gezeigt werden (z. B. aus der jeweiligen Liste).
zahlungseingaenge_bestaetigenSchreibenBestätigt Eingänge, die zahlungseingaenge_auflisten mit stapel=bestaetigen gezeigt hat, und gleicht sie aus.Zahlungsausgleich:CreateBearbeiten

POST /api/v1/partner/zahlungseingaenge/bestaetigung

Bestätigt Eingänge, die zahlungseingaenge_auflisten mit stapel=bestaetigen gezeigt hat, und gleicht sie aus. Gebucht wird nur, was der Server unverändert wiederfindet: Jeder Eintrag trägt den fingerabdruck, den die Liste lieferte; hat sich Zahler, Betrag oder Aufteilung inzwischen geändert, wird der Eintrag übersprungen (vorschlag_geaendert). Der Ausgleich geht als Entwurf in den Stapel; festgeschrieben wird im Portal. Höchstens 50 je Aufruf. NICHT bestätigen, wenn der Zahler unklar ist, mehr überwiesen wurde als offen ist, die Periode gesperrt ist (423) oder der Mensch es nicht ausdrücklich will — dann dem Menschen melden. Regelbuchungen als geprüft zu übernehmen ist die Freigabe eines Menschen und geht hier nie. Jedes Ergebnis nennt ausgeglichen oder übersprungen mit Grund. Braucht Zahlungsausgleich:Create.

Parameter von zahlungseingaenge_bestaetigen
ParameterTypBeschreibung
eintraege PflichtListe (object)Die zu bestätigenden Eingänge.
zahlungseingang_ausgleichenSchreibenGleicht einen Zahlungseingang mit eigener Aufteilung aus — der Weg, wenn der Vorschlag nicht passt oder der Eingang stapel=klaeren hatte.Zahlungsausgleich:CreateBearbeiten

POST /api/v1/partner/zahlungseingaenge/:bewegungId/ausgleich

Gleicht einen Zahlungseingang mit eigener Aufteilung aus — der Weg, wenn der Vorschlag nicht passt oder der Eingang stapel=klaeren hatte. VORHER zahlungseingang_vorschlag_lesen für den Zahler; zuordnungen nennt je Posten (postenId aus dem Vorschlag) den Betrag in Cent, die Summe darf den Eingang (bzw. anteilCent) nicht übersteigen. Genau einer von mieterId und eigentuemerId. Mehr überwiesen als zugeordnet: nur mit ueberzahlungAlsGuthaben=true oder differenzkontoId (Differenz unter 10 €) — beides nur auf ausdrückliche Anweisung. tilgungsgrund: gesetzlich (Vorgabe), verwendungszweck oder manuell, wenn Sie die Aufteilung selbst bestimmt haben. merkmalLernen=false, wenn der Zahler nicht sicher ist: Sonst merkt sich das System die IBAN für diesen Zahler. Bucht in den Stapel (Entwurf); festgeschrieben wird im Portal. Eine gesperrte Periode (423) oder 409 nicht umgehen, sondern melden. Braucht Zahlungsausgleich:Create.

Parameter von zahlungseingang_ausgleichen
ParameterTypBeschreibung
bewegungId PflichtstringUUID der Bank-Bewegung (id aus zahlungseingaenge_auflisten) (z. B. aus der jeweiligen Liste).
zuordnungen PflichtListe (object)Wohin wie viel geht. Leer nur zusammen mit ueberzahlungAlsGuthaben.
mieterIdstringUUID des Mieters (z. B. aus der jeweiligen Liste).
eigentuemerIdstringUUID des Eigentümers (Hausgeld) (z. B. aus der jeweiligen Liste).
tilgungsgrundgesetzlich | verwendungszweck | manuellWoher die Aufteilung stammt.
anteilCentintegerNur der Teil der Bewegung, der diesem Zahler gehört (Überweisung für mehrere).
ueberzahlungAlsGuthabenbooleanDen Rest als Guthaben des Zahlers buchen — nur auf Anweisung.
differenzkontoIdstringUUID des Kontos für eine kleine Differenz — nur auf Anweisung (z. B. aus der jeweiligen Liste).
merkmalLernenbooleanfalse: die IBAN dieser Zahlung nicht diesem Zahler zuordnen lernen.
bemerkungstringInterne Notiz am Vorgang.
ausgleich_zuruecknehmenSchreibenNimmt einen Ausgleich als Fehlzuordnung zurück: Die Gegenbuchung hebt ihn auf, die Posten sind wieder offen, der Eingang wieder zu klären.Zahlungsausgleich:UpdateBearbeiten

POST /api/v1/partner/ausgleiche/:vorgangId/ruecknahme

Nimmt einen Ausgleich als Fehlzuordnung zurück: Die Gegenbuchung hebt ihn auf, die Posten sind wieder offen, der Eingang wieder zu klären. vorgangId steht im Ergebnis von zahlungseingang_ausgleichen bzw. an einem erledigten Eintrag von zahlungseingaenge_auflisten (vorgang_id). merkmalSperren=true, wenn die IBAN diesen Zahler künftig nicht mehr erkennen soll. Eine Rücklastschrift erkennt das System selbst; über ihre Gebühr entscheidet ein Mensch im Portal. Gesperrte Periode (423) melden, nicht umgehen. Braucht Zahlungsausgleich:Update.

Parameter von ausgleich_zuruecknehmen
ParameterTypBeschreibung
vorgangId PflichtstringUUID des Ausgleichs-Vorgangs (z. B. aus der jeweiligen Liste).
merkmalSperrenbooleanDie IBAN erkennt diesen Zahler künftig nicht mehr, bis ein Ausgleich von Hand sie bestätigt.
bemerkungstringWarum — erscheint am Vorgang.
bankbewegungen_auflistenLesenListet die Umsätze eines Bankkontos — Eingänge und Ausgaben — mit Stand (offen, vorgeschlagen, teilweise_ausgeglichen, zugeordnet, gebucht), Gegenpartei, Verwendungszweck, IBAN, erkannter Buchungsregel und Journal-Verweis.Bankkonto:ReadLesen mit Kontaktdaten

GET /api/v1/partner/bankbewegungen

Listet die Umsätze eines Bankkontos — Eingänge und Ausgaben — mit Stand (offen, vorgeschlagen, teilweise_ausgeglichen, zugeordnet, gebucht), Gegenpartei, Verwendungszweck, IBAN, erkannter Buchungsregel und Journal-Verweis. Der Weg zu den Ausgaben, die noch zu buchen sind (status=offen, dann bankbewegung_buchen). konto ist der Filter (aus bankkonten_auflisten); bei einer begrenzten Rolle Pflicht. meta nennt Gesamtzahl, Restbestand (offen, in Klärung, gesamt) und Saldo. Braucht Bankkonto:Read. Ist-Sicht: Beträge nach Zahlung (Tag des Kontoumsatzes) — eine Zahl der Soll-Sicht (Saldenliste, Offene Posten) darf davon abweichen.

Parameter von bankbewegungen_auflisten
ParameterTypBeschreibung
kontostringUUID des Bankkontos (aus bankkonten_auflisten) (z. B. aus der jeweiligen Liste).
statusoffen | vorgeschlagen | teilweise_ausgeglichen | zugeordnet | gebuchtNur Umsätze in diesem Stand.
vonstringBuchungsdatum ab (JJJJ-MM-TT).
bisstringBuchungsdatum bis (JJJJ-MM-TT).
qstringFreitext in Gegenpartei, Verwendungszweck; ein Betrag wie "1.234,50" sucht den Betrag.
limitintegerEinträge je Seite.
offsetintegerVersatz zum Blättern.
buchhaltung_konten_auflistenLesenListet die wählbaren Konten des aktiven Kontenrahmens (SKR03/SKR04) mit der Konto-ID, die jede Buchung braucht, Nummer, Bezeichnung, Kontenart und Steuersatz.Kontenplan:ReadLesen

GET /api/v1/partner/buchhaltung/konten

Listet die wählbaren Konten des aktiven Kontenrahmens (SKR03/SKR04) mit der Konto-ID, die jede Buchung braucht, Nummer, Bezeichnung, Kontenart und Steuersatz. q sucht in Nummer und Bezeichnung ("Instandhaltung", "4800"). Ohne Kontenrahmen ist die Liste leer — dann dem Menschen melden, dass er im Portal erst einen aktivieren muss. Braucht Kontenplan:Read.

Parameter von buchhaltung_konten_auflisten
ParameterTypBeschreibung
qstringSuchtext in Kontonummer und Bezeichnung.
aktivbooleanfalse zeigt auch stillgelegte Konten.
limitintegerHöchstzahl der Konten.
sollarten_auflistenLesenListet den Sollarten-Katalog des Mandanten: die Bestandteile, in die sich eine Miete zerlegt (schluessel, bezeichnung, Erlöskonto, umlagefaehig, abrechnungsart, aktiv).Sollart:ReadLesen

GET /api/v1/partner/buchhaltung/sollarten

Listet den Sollarten-Katalog des Mandanten: die Bestandteile, in die sich eine Miete zerlegt (schluessel, bezeichnung, Erlöskonto, umlagefaehig, abrechnungsart, aktiv). Die Schlüssel (bk_vorauszahlung, hk_vorauszahlung, stellplatz, garage …) verlangen mietvertrag_anlegen (weitereBestandteile, heizkostenVorauszahlung) und mietvertrag_sollbestandteil_setzen. Ist die Liste leer oder fehlt ein Standardschlüssel, trägt sollarten_standard_anlegen den mitgelieferten Katalog ein. Braucht Sollart:Read.

Parameter von sollarten_auflisten
ParameterTypBeschreibung
aktivbooleantrue blendet stillgelegte Sollarten aus.
sollarten_standard_anlegenSchreibenTrägt den mitgelieferten Sollarten-Katalog im Mandanten ein — derselbe Standard, den ein neuer Mandant im Portal bekommt: grundmiete, bk_vorauszahlung, hk_vorauszahlung, bk_pauschale, stellplatz, garage, moeblierungszuschlag, untermietzuschlag, kabel_medien, kautionsrate, sonstiges.Sollart:CreateBearbeiten

POST /api/v1/partner/buchhaltung/sollarten/standard

Trägt den mitgelieferten Sollarten-Katalog im Mandanten ein — derselbe Standard, den ein neuer Mandant im Portal bekommt: grundmiete, bk_vorauszahlung, hk_vorauszahlung, bk_pauschale, stellplatz, garage, moeblierungszuschlag, untermietzuschlag, kabel_medien, kautionsrate, sonstiges. Idempotent: Es kommen nur fehlende Schlüssel dazu, Vorhandenes (auch umbenannt oder stillgelegt) bleibt unverändert; ein zweiter Aufruf ändert nichts. Die Antwort nennt unter angelegt, was neu entstand. Das Erlöskonto bleibt leer und gilt dann aus dem Sollstellungslauf; ein eigenes setzt sollart_aktualisieren. Der Weg, wenn mietvertrag_anlegen meldet, dass im Katalog die Betriebs- oder Heizkostenvorauszahlung fehlt. Nur ohne Objekt- oder Einheitengrenze der Rolle. Braucht Sollart:Create.

sollart_anlegenSchreibenLegt eine eigene Sollart an, die der Standardkatalog nicht kennt (etwa "waschkueche").Sollart:CreateBearbeiten

POST /api/v1/partner/buchhaltung/sollarten

Legt eine eigene Sollart an, die der Standardkatalog nicht kennt (etwa "waschkueche"). schluessel: Kleinbuchstaben, Ziffern und Unterstrich, 2 bis 40 Zeichen, je Mandant einmalig (sonst 409). erloeskontoId ist optional und kommt aus buchhaltung_konten_auflisten; ohne gilt das im Sollstellungslauf gewählte Erlöskonto. abrechnungsart "betriebskosten" oder "heizkosten" rechnet die Sollart gegen die Abrechnung gegen. Die mitgelieferten Sollarten trägt sollarten_standard_anlegen ein. Nur ohne Objekt- oder Einheitengrenze der Rolle. Braucht Sollart:Create.

Parameter von sollart_anlegen
ParameterTypBeschreibung
schluessel PflichtstringEindeutiger Schlüssel, z. B. "waschkueche".
bezeichnung PflichtstringAnzeigename, z. B. "Waschküche".
erloeskontoIdbeliebigKonto-ID aus buchhaltung_konten_auflisten; null/weglassen = Erlöskonto des Sollstellungslaufs.
umlagefaehigbooleanOb der Bestandteil in die Betriebskostenabrechnung eingeht. Vorgabe false.
abrechnungsartbetriebskosten | heizkosten | nullGegen welche Abrechnung die Sollart gegengerechnet wird.
steuersatznumberUmsatzsteuersatz in Prozent, Vorgabe 0.
sortierungintegerReihenfolge in Listen, Vorgabe 100.
aktivbooleanVorgabe true.
notizbeliebig
sollart_aktualisierenSchreibenÄndert eine Sollart des Mandanten, nur die gesendeten Felder: Bezeichnung, Erlöskonto (erloeskontoId, null nimmt die Zuordnung zurück), Umlage, Abrechnungsart, Steuersatz, Sortierung, Notiz — oder legt sie mit aktiv=false still.Sollart:UpdateBearbeiten

PATCH /api/v1/partner/buchhaltung/sollarten/:encodeURIComponent

Ändert eine Sollart des Mandanten, nur die gesendeten Felder: Bezeichnung, Erlöskonto (erloeskontoId, null nimmt die Zuordnung zurück), Umlage, Abrechnungsart, Steuersatz, Sortierung, Notiz — oder legt sie mit aktiv=false still. Der Schlüssel ändert sich nie. Den Bestand nennt sollarten_auflisten. Nur ohne Objekt- oder Einheitengrenze der Rolle. Braucht Sollart:Update.

Parameter von sollart_aktualisieren
ParameterTypBeschreibung
schluessel PflichtstringSchlüssel der Sollart, z. B. "stellplatz".
bezeichnungstring
erloeskontoIdbeliebigKonto-ID aus buchhaltung_konten_auflisten; null nimmt die Zuordnung zurück.
umlagefaehigboolean
abrechnungsartbetriebskosten | heizkosten | null
steuersatznumber
sortierunginteger
aktivbooleanfalse legt die Sollart still.
notizbeliebig
buchhaltung_perioden_auflistenLesenListet die Buchungsperioden (Monate) des Mandanten mit Stand: offen (es wird noch gebucht), vorlaeufig_abgeschlossen (zur Festschreibung vorgelegt — für Buchungen gesperrt), festgeschrieben oder abgeschlossen (Jahr abgeschlossen).Buchungsperiode:ReadLesen

GET /api/v1/partner/buchhaltung/perioden

Listet die Buchungsperioden (Monate) des Mandanten mit Stand: offen (es wird noch gebucht), vorlaeufig_abgeschlossen (zur Festschreibung vorgelegt — für Buchungen gesperrt), festgeschrieben oder abgeschlossen (Jahr abgeschlossen). Vor einer Buchung ansehen: Liegt das Buchungsdatum in einer nicht offenen Periode, nimmt der Dienst die Buchung nicht an (423) — dann nicht erfassen, sondern dem Menschen melden. Mehr zum Stand eines Monats: monatsabschluss_lesen, eines Jahres: buchungsjahre_auflisten. Braucht Buchungsperiode:Read.

monatsabschluss_lesenLesenLiest den Monatsabschluss: ohne monat das Jahresband (zwölf Monate mit Stand, nächstem Schritt, Frist „Buchen bis“ und Berichten, dazu ob sich das Jahr abschließen lässt); mit monat die Akte des Monats — Schrittleiste, Hauptaktion samt Sperrgrund, Prüfliste (Sollstellung, Kontoauszüge, offene und in Klärung stehende Bewegungen, Belege ohne Buchung, Stapelsätze, Vormonat) und Abstimmung (Bank gegen Sachkonto zum Monatsletzten, Verrechnungskonten).Buchungsperiode:ReadLesen

GET /api/v1/partner/monatsabschluss/:monat

Liest den Monatsabschluss: ohne monat das Jahresband (zwölf Monate mit Stand, nächstem Schritt, Frist „Buchen bis“ und Berichten, dazu ob sich das Jahr abschließen lässt); mit monat die Akte des Monats — Schrittleiste, Hauptaktion samt Sperrgrund, Prüfliste (Sollstellung, Kontoauszüge, offene und in Klärung stehende Bewegungen, Belege ohne Buchung, Stapelsätze, Vormonat) und Abstimmung (Bank gegen Sachkonto zum Monatsletzten, Verrechnungskonten). Jeder offene Punkt nennt den Weg. Braucht Buchungsperiode:Read; Bankkonten nur mit Bankkonto:Read. Soll-Sicht: Beträge nach Sollstellung und Rechnung, nicht nach Zahlung — eine Zahl der Ist-Sicht (Jahresabrechnung, Anlage V, Kontoumsätze) darf davon abweichen.

Parameter von monatsabschluss_lesen
ParameterTypBeschreibung
monatstringMonat JJJJ-MM — ohne: Jahresband.
jahrintegerJahr des Jahresbands (ohne monat), Vorgabe das laufende.
monatsabschluss_vorlegenSchreibenLegt einen vergangenen Monat zur Festschreibung vor, wenn die Prüfliste keinen offenen Punkt hat — sonst 422 mit dem ersten Punkt und seinem Weg.Buchungsperiode:FestschreibenBearbeiten · nur persönlich

POST /api/v1/partner/monatsabschluss/:monat/vorlegen

Legt einen vergangenen Monat zur Festschreibung vor, wenn die Prüfliste keinen offenen Punkt hat — sonst 422 mit dem ersten Punkt und seinem Weg. Der Monat ist danach für Buchungen gesperrt; eine zweite Person schreibt ihn fest. Nur über den persönlichen KI-Zugang. Braucht Buchungsperiode:Festschreiben.

Parameter von monatsabschluss_vorlegen
ParameterTypBeschreibung
monat PflichtstringMonat JJJJ-MM.
monatsabschluss_festschreibenSchreibenSchreibt einen vorgelegten Monat endgültig fest, nach bestandener Integritätsprüfung.Buchungsperiode:FestschreibenBearbeiten · nur persönlich

POST /api/v1/partner/monatsabschluss/:monat/festschreiben

Schreibt einen vorgelegten Monat endgültig fest, nach bestandener Integritätsprüfung. Wer den Monat vorgelegt hat, kann ihn nicht selbst festschreiben (Vier-Augen) — außer im Unternehmen gibt es keine zweite Person mit dem Recht. Danach ist eine Korrektur nur als Storno in einem offenen Monat möglich. Nur über den persönlichen KI-Zugang. Braucht Buchungsperiode:Festschreiben.

Parameter von monatsabschluss_festschreiben
ParameterTypBeschreibung
monat PflichtstringMonat JJJJ-MM.
monatsbericht_lesenLesenLiest die Monatsberichte an die Eigentümer: ohne objektNr je Objekt Überschuss, Bestand, Empfänger je Weg und Stand der Freigabe; mit objektNr den Bericht selbst — nach der Freigabe die eingefrorene Fassung, vorher die Vorschau.Monatsbericht:ReadLesen mit Kontaktdaten

GET /api/v1/partner/monatsberichte/:monat

Liest die Monatsberichte an die Eigentümer: ohne objektNr je Objekt Überschuss, Bestand, Empfänger je Weg und Stand der Freigabe; mit objektNr den Bericht selbst — nach der Freigabe die eingefrorene Fassung, vorher die Vorschau. Beim Mietshaus mit offenen Mieten je Einheit und Mietername, bei der Gemeinschaft Rückstände nur als Quote. Braucht Monatsbericht:Read. Soll- und Ist-Sicht: gestellt (nach Sollstellung) und gezahlt (nach Kontoumsatz) stehen getrennt.

Parameter von monatsbericht_lesen
ParameterTypBeschreibung
monat PflichtstringMonat JJJJ-MM.
objektNrintegerObjekt-Nr. (Ganzzahl).
monatsbericht_freigebenSchreibenGibt die Monatsberichte eines festgeschriebenen Monats frei (ohne objektNrs: alle noch nicht freigegebenen), friert je Objekt die Fassung ein und stellt zu: App bzw. Portal, E-Mail mit Kernzahlen, ohne digitalen Weg Druckliste.Monatsbericht:FreigebenBearbeiten · nur persönlich

POST /api/v1/partner/monatsberichte/:monat/freigeben

Gibt die Monatsberichte eines festgeschriebenen Monats frei (ohne objektNrs: alle noch nicht freigegebenen), friert je Objekt die Fassung ein und stellt zu: App bzw. Portal, E-Mail mit Kernzahlen, ohne digitalen Weg Druckliste. Vor der Festschreibung 409. Nur über den persönlichen KI-Zugang. Braucht Monatsbericht:Freigeben.

Parameter von monatsbericht_freigeben
ParameterTypBeschreibung
monat PflichtstringMonat JJJJ-MM.
objektNrsListe (integer)Nur diese Objekte.
buchungsjahre_auflistenLesenListet die Buchungsjahre des Mandanten, jüngstes zuerst: Stand (laufend, im Abschluss, abgeschlossen, kommend), Zahl der festgeschriebenen Monate, ob der Anfangsbestand (EB-Wert) noch vorläufig ist, wer wann abgeschlossen hat — dazu Buchhaltungsbeginn, Stand der Eröffnung und Rechnungslegung (Gemeinschaft, Überschussrechnung, Bilanz).Buchungsperiode:ReadLesen

GET /api/v1/partner/buchungsjahre

Listet die Buchungsjahre des Mandanten, jüngstes zuerst: Stand (laufend, im Abschluss, abgeschlossen, kommend), Zahl der festgeschriebenen Monate, ob der Anfangsbestand (EB-Wert) noch vorläufig ist, wer wann abgeschlossen hat — dazu Buchhaltungsbeginn, Stand der Eröffnung und Rechnungslegung (Gemeinschaft, Überschussrechnung, Bilanz). Gebucht werden darf vom Buchhaltungsbeginn bis zum 31.12. des Folgejahres, nie in ein abgeschlossenes Jahr (422 mit Weg). Braucht Buchungsperiode:Read.

eroeffnung_lesenLesenLiest die Eröffnung: Buchhaltungsbeginn (bzw. Vorschlag), Stichtag der Anfangsbestände (Tag davor), schon erfasste Anfangsbestände mit Stand der Stapelsätze und Probe (Rest = Vermögen zum Beginn) — und solange nichts erfasst ist, Vorschläge: Bankkonten mit Kontostand laut Bank, Rückstände je Debitor, offene Rechnungen je Kreditor, Kautionen (Konto wählen), bei der Gemeinschaft die Erhaltungsrücklage.Buchungsperiode:ReadLesen

GET /api/v1/partner/eroeffnung

Liest die Eröffnung: Buchhaltungsbeginn (bzw. Vorschlag), Stichtag der Anfangsbestände (Tag davor), schon erfasste Anfangsbestände mit Stand der Stapelsätze und Probe (Rest = Vermögen zum Beginn) — und solange nichts erfasst ist, Vorschläge: Bankkonten mit Kontostand laut Bank, Rückstände je Debitor, offene Rechnungen je Kreditor, Kautionen (Konto wählen), bei der Gemeinschaft die Erhaltungsrücklage. Ein Vorschlag ist nie gebucht. Personenkonten tragen Namen nur mit OffenerPosten:Read. Braucht Buchungsperiode:Read.

eroeffnung_erfassenSchreibenLiefert die Anfangsbestände zum Buchhaltungsbeginn als Stapelsätze im Belegkreis EB ein — je Zeile Konto und Saldo in Cent (positiv: Bestand im Soll wie Bank oder Forderung, negativ: im Haben wie Kaution oder Verbindlichkeit); das Gegenkonto (9000/9008/9009) wählt der Dienst.Buchungsstapel:CreateBearbeiten

POST /api/v1/partner/eroeffnung

Liefert die Anfangsbestände zum Buchhaltungsbeginn als Stapelsätze im Belegkreis EB ein — je Zeile Konto und Saldo in Cent (positiv: Bestand im Soll wie Bank oder Forderung, negativ: im Haben wie Kaution oder Verbindlichkeit); das Gegenkonto (9000/9008/9009) wählt der Dienst. Der Beginn muss vorher im Portal festgelegt sein. Bei Rechnungslegung Bilanz muss die Eröffnung aufgehen (Rest aufs Kapitalkonto). Freigegeben und festgeschrieben wird im Portal von einer zweiten Person. Ist schon eine Eröffnung erfasst, 409. Braucht Buchungsstapel:Create.

Parameter von eroeffnung_erfassen
ParameterTypBeschreibung
zeilen PflichtListe (object)
jahresabschluss_lesenLesenLiest die Akte „Jahresabschluss“ eines Jahres: Schrittleiste (Monate · Abschlussbuchungen · Abstimmen zum 31.12.Buchungsperiode:ReadLesen

GET /api/v1/partner/jahresabschluss/:jahr

Liest die Akte „Jahresabschluss“ eines Jahres: Schrittleiste (Monate · Abschlussbuchungen · Abstimmen zum 31.12. · Abschließen · Ausgaben), Hauptaktion samt Sperrgrund, Prüfliste mit Weg je offenem Punkt, die zwölf Monate mit Stand, Bankabstimmung und Verrechnungskonten zum 31.12., nach dem Abschluss die Schlussfassung (Endbestand je Konto = EB-Wert des Folgejahres) und die Ausgaben (Vermögensbericht, Anlage V bzw. Saldenliste und DATEV). Braucht Buchungsperiode:Read; Bankkonten nur mit Bankkonto:Read. Soll-Sicht: Beträge nach Sollstellung und Rechnung, nicht nach Zahlung — eine Zahl der Ist-Sicht (Jahresabrechnung, Anlage V, Kontoumsätze) darf davon abweichen.

Parameter von jahresabschluss_lesen
ParameterTypBeschreibung
jahr PflichtintegerBuchungsjahr.
jahresabschluss_assistent_lesenLesenLiest den Plan des Jahresabschluss-Assistenten eines Jahres: was vor dem Vorlegen fehlt, geordnet in Eröffnung · Bankstände zum 31.12.Buchungsperiode:ReadLesen

GET /api/v1/partner/jahresabschluss/:jahr/assistent

Liest den Plan des Jahresabschluss-Assistenten eines Jahres: was vor dem Vorlegen fehlt, geordnet in Eröffnung · Bankstände zum 31.12. · Prüfen — mit Stand und Zahl offener Punkte je Schritt, je Bankkonto Buchsaldo, Saldo laut Bank, Quelle (Kontoauszug, Abruf oder Handeingabe), Beleg und Differenz sowie die Punkte, die nur ein Mensch klärt. Nur lesend: Anfangsbestände gehen über eroeffnung_erfassen, der Saldo laut Bank wird im Portal mit seinem Beleg eingetragen, vorgelegt wird mit jahresabschluss_vorlegen. Der Buchsaldo ersetzt nie den Saldo laut Bank. Braucht Buchungsperiode:Read; Bankkonten nur mit Bankkonto:Read. Soll-Sicht: Beträge nach Sollstellung und Rechnung, nicht nach Zahlung — eine Zahl der Ist-Sicht (Jahresabrechnung, Anlage V, Kontoumsätze) darf davon abweichen.

Parameter von jahresabschluss_assistent_lesen
ParameterTypBeschreibung
jahr PflichtintegerBuchungsjahr.
jahresabschluss_vorlegenSchreibenLegt ein vergangenes Jahr zum Abschluss vor, wenn die Prüfliste keinen offenen Punkt hat — sonst 422 mit dem ersten Punkt und seinem Weg (alle zwölf Monate festgeschrieben, Vorjahr abgeschlossen, Bank = Buch zum 31.12., bei Bilanz Abschlussbuchungen festgeschrieben).Buchungsperiode:FestschreibenBearbeiten · nur persönlich

POST /api/v1/partner/jahresabschluss/:jahr/vorlegen

Legt ein vergangenes Jahr zum Abschluss vor, wenn die Prüfliste keinen offenen Punkt hat — sonst 422 mit dem ersten Punkt und seinem Weg (alle zwölf Monate festgeschrieben, Vorjahr abgeschlossen, Bank = Buch zum 31.12., bei Bilanz Abschlussbuchungen festgeschrieben). Eine zweite Person schließt ab. Nur über den persönlichen KI-Zugang. Braucht Buchungsperiode:Festschreiben.

Parameter von jahresabschluss_vorlegen
ParameterTypBeschreibung
jahr PflichtintegerBuchungsjahr.
jahresabschluss_abschliessenSchreibenSchließt ein vorgelegtes Jahr endgültig ab: speichert die Schlussfassung (Endbestand je Konto zum 31.12.) und setzt alle Perioden auf abgeschlossen.Buchungsperiode:AbschliessenBearbeiten · nur persönlich

POST /api/v1/partner/jahresabschluss/:jahr/abschliessen

Schließt ein vorgelegtes Jahr endgültig ab: speichert die Schlussfassung (Endbestand je Konto zum 31.12.) und setzt alle Perioden auf abgeschlossen. Danach sind Buchungen und Stornos im Jahr unmöglich; Korrekturen gehen ins laufende Jahr mit „betrifft“. Es gibt kein Zurücknehmen. Wer vorgelegt hat, kann nicht selbst abschließen (Vier-Augen) — außer im Unternehmen gibt es keine zweite Person mit dem Recht. Nur über den persönlichen KI-Zugang. Braucht Buchungsperiode:Abschliessen.

Parameter von jahresabschluss_abschliessen
ParameterTypBeschreibung
jahr PflichtintegerBuchungsjahr.
buchungsvorlagen_auflistenLesenListet die aktiven Buchungsvorlagen des Mandanten: benannte Sätze mit Kürzel, Soll- und Habenkonto, Buchungstext und gegebenenfalls festem Betrag.Buchungsstapel:ReadLesen

GET /api/v1/partner/buchungsvorlagen

Listet die aktiven Buchungsvorlagen des Mandanten: benannte Sätze mit Kürzel, Soll- und Habenkonto, Buchungstext und gegebenenfalls festem Betrag. Die id geht als vorlageId in buchung_erfassen. Braucht Buchungsstapel:Read.

buchungsstapel_auflistenLesenListet die Zeilen des Buchungsstapels — was erfasst, aber noch nicht festgeschrieben ist, und was festgeschrieben wurde: Stand (entwurf, vorgeschlagen, geprueft, festgeschrieben, verworfen, storniert), Datum, Beleg, Konten, Betrag in Cent, Text, Herkunft (manuell, bank_transaktion, beleg, regel) und wer erfasst bzw. freigegeben hat.Buchungsstapel:ReadLesen

GET /api/v1/partner/buchungsstapel

Listet die Zeilen des Buchungsstapels — was erfasst, aber noch nicht festgeschrieben ist, und was festgeschrieben wurde: Stand (entwurf, vorgeschlagen, geprueft, festgeschrieben, verworfen, storniert), Datum, Beleg, Konten, Betrag in Cent, Text, Herkunft (manuell, bank_transaktion, beleg, regel) und wer erfasst bzw. freigegeben hat. Zum Prüfen, was der Assistent selbst erfasst hat, und zum Finden einer Zeile, die verworfen werden soll. Nur für Rollen ohne Objektgrenze. Braucht Buchungsstapel:Read.

Parameter von buchungsstapel_auflisten
ParameterTypBeschreibung
statusentwurf | vorgeschlagen | geprueft | festgeschrieben | verworfen | storniertNur Zeilen in diesem Stand.
quellemanuell | bank_transaktion | beleg | regelNur Zeilen dieser Herkunft.
jahrintegerNur Buchungsdatum in diesem Jahr.
limitintegerEinträge je Seite.
offsetintegerVersatz zum Blättern.
buchung_erfassenSchreibenErfasst einen Buchungssatz im Stapel — dieselbe Buchungsmaske wie im Portal (Soll an Haben, brutto), danach läuft der Freigabeweg.Buchungsstapel:CreateBearbeiten

POST /api/v1/partner/buchungsstapel

Erfasst einen Buchungssatz im Stapel — dieselbe Buchungsmaske wie im Portal (Soll an Haben, brutto), danach läuft der Freigabeweg. Der Satz steht als Entwurf da; FREIGEGEBEN und FESTGESCHRIEBEN wird im Portal von einer zweiten Person. Konten (sollkontoId, habenkontoId) aus buchhaltung_konten_auflisten, betragCent in Cent brutto. Mit vorlageId kommen Konten, Text, Steuersatz, Kostenstelle und ein fester Betrag aus der Vorlage; was Sie zusätzlich angeben, gilt vor ihr. belegId hängt einen Beleg des Buchhaltungsarchivs an, quelleBelegId bucht einen bar bezahlten Beleg des Posteingangs. Eine Rechnung eines Lieferanten gehört nicht hierher, sondern über beleg_buchen (Kreditor und offener Posten). NICHT erfassen, wenn Konto, Betrag oder Zeitraum unklar sind oder die Periode nicht offen ist — dem Menschen melden. Splitbuchungen mit mehreren Positionen gibt es nur im Portal. Mit aufteilung teilen Sie die Kosten auf Wohnungen und Bereiche des Objekts auf (Konzept 184); ohne Angabe teilt ein Verteilschema der Vorlage auf. Braucht Buchungsstapel:Create.

Parameter von buchung_erfassen
ParameterTypBeschreibung
buchungsdatum PflichtstringBuchungsdatum (JJJJ-MM-TT) — bestimmt die Periode.
belegdatumstringDatum des Belegs (JJJJ-MM-TT); Vorgabe: Buchungsdatum.
belegkreisstringBelegkreis, z. B. ER (Eingangsrechnung), AR, KB (Kasse), SB (Sonstige).
belegnummerstringEigene Belegnummer; ohne Angabe vergibt der Dienst sie beim Festschreiben.
vorlageIdstringUUID der Buchungsvorlage (aus buchungsvorlagen_auflisten) (z. B. aus der jeweiligen Liste).
sollkontoIdstringUUID des Sollkontos (aus buchhaltung_konten_auflisten) (z. B. aus der jeweiligen Liste).
habenkontoIdstringUUID des Habenkontos (aus buchhaltung_konten_auflisten) (z. B. aus der jeweiligen Liste).
betragCentintegerBruttobetrag in Cent.
buchungstextstringBuchungstext — Pflicht ohne Vorlage.
steuersatzIdstringUUID des Steuersatzes (z. B. aus der jeweiligen Liste).
steuerCentintegerEnthaltene Steuer in Cent, wenn der Satz sie nennt.
kostenstelleIdstringUUID der Kostenstelle (Objekt) (z. B. aus der jeweiligen Liste).
aufteilungListe (object)Aufteilung auf Unterkostenstellen unter der Kostenstelle des Objekts: [{ unterkostenstelleId, betragCent }], Betrag in Cent, Summe höchstens der Bruttobetrag (der Rest bleibt „am Objekt“). Die ids aus unterkostenstellen_auflisten. Nicht angeben = unverändert; [] = Aufteilung entfernen. Ändert sich Kostenstelle oder Betrag, entfällt sie.
belegIdstringUUID eines Belegs im Buchhaltungsarchiv (z. B. aus der jeweiligen Liste).
quelleBelegIdintegerID eines bar bezahlten Belegs des Posteingangs (nicht für Rechnungen auf Kreditor).
notizstringInterne Notiz an der Buchung.
buchungsstapel_verwerfenSchreibenVerwirft Stapelzeilen, die noch niemand freigegeben hat (entwurf, vorgeschlagen) — der Weg, einen Fehler im Stapel rückgängig zu machen.Buchungsstapel:UpdateBearbeiten

POST /api/v1/partner/buchungsstapel/verwerfung

Verwirft Stapelzeilen, die noch niemand freigegeben hat (entwurf, vorgeschlagen) — der Weg, einen Fehler im Stapel rückgängig zu machen. Die Zeile bleibt als verworfen im Protokoll. Eine geprüfte Zeile verwirft nur, wer sie geprüft hat (409); eine festgeschriebene Buchung wird storniert (buchung_stornieren). Die ids stehen in buchungsstapel_auflisten bzw. im Ergebnis von buchung_erfassen. Höchstens 50 je Aufruf. Braucht Buchungsstapel:Update.

Parameter von buchungsstapel_verwerfen
ParameterTypBeschreibung
ids PflichtListe (string)IDs der Stapelzeilen (Zahlen als Text).
buchungsstapel_zuweisung_kandidatenLesenWer im Team die gewählten Stapelzeilen zur Freigabe übernehmen kann (Konzept 185): je Person Name, Zahl der schon zugewiesenen Freigaben, die passenden Zeilen und je übriger Zeile der Grund (Rolle, Prüfschritt der Rechnung, Vier-Augen).Buchungsstapel:ZuweisenBearbeiten

GET /api/v1/partner/buchungsstapel/zuweisung/kandidaten

Wer im Team die gewählten Stapelzeilen zur Freigabe übernehmen kann (Konzept 185): je Person Name, Zahl der schon zugewiesenen Freigaben, die passenden Zeilen und je übriger Zeile der Grund (Rolle, Prüfschritt der Rechnung, Vier-Augen). Dazu je Zeile die nächste offene Stufe. Vor buchungsstapel_zur_freigabe_zuweisen aufrufen. Braucht Buchungsstapel:Zuweisen.

Parameter von buchungsstapel_zuweisung_kandidaten
ParameterTypBeschreibung
ids PflichtListe (string)IDs der Stapelzeilen (Zahlen als Text).
buchungsstapel_zur_freigabe_zuweisenSchreibenWeist Stapelzeilen einem Kollegen zur Freigabe zu (Konzept 185): Er bekommt eine Aufgabe mit Frist und Nachricht, die sich schließt, sobald alle Zeilen freigegeben sind.Buchungsstapel:ZuweisenBearbeiten

POST /api/v1/partner/buchungsstapel/zuweisung

Weist Stapelzeilen einem Kollegen zur Freigabe zu (Konzept 185): Er bekommt eine Aufgabe mit Frist und Nachricht, die sich schließt, sobald alle Zeilen freigegeben sind. Gibt nichts frei und sperrt niemanden. Zeilen, deren nächste Stufe er nicht zeichnen darf, bleiben und stehen mit Grund in uebrig. an ist die id aus buchungsstapel_zuweisung_kandidaten, nie sich selbst. Braucht Buchungsstapel:Zuweisen.

Parameter von buchungsstapel_zur_freigabe_zuweisen
ParameterTypBeschreibung
ids PflichtListe (string)IDs der Stapelzeilen (Zahlen als Text).
an PflichtintegerKonto des Kollegen (id aus buchungsstapel_zuweisung_kandidaten).
faelligAm PflichtstringFrist (JJJJ-MM-TT), üblich drei Werktage.
nachrichtstringKurze Nachricht an den Kollegen; steht in der Aufgabe.
bankbewegung_buchenSchreibenBucht einen Umsatz nach der Buchungsregel, die im Portal auf ihn passt (Gegenkonto, Text, Steuer) — wie „Buchen“ im Kontoauszug.Buchungsstapel:CreateBearbeiten

POST /api/v1/partner/bankbewegungen/:bankbewegungId/buchung

Bucht einen Umsatz nach der Buchungsregel, die im Portal auf ihn passt (Gegenkonto, Text, Steuer) — wie „Buchen“ im Kontoauszug. Es entsteht eine vorkontierte Zeile im Stapel (Entwurf). Ohne passende Regel antwortet der Dienst mit 422; dann entweder buchung_erfassen mit eigenem Satz oder dem Menschen melden, welche Regel fehlt. 409 heißt: bereits ausgeglichen. Eingänge von Mietern und Eigentümern gleicht zahlungseingang_ausgleichen aus, nicht dieses Tool. Die bankbewegungId steht in bankbewegungen_auflisten. Braucht Buchungsstapel:Create.

Parameter von bankbewegung_buchen
ParameterTypBeschreibung
bankbewegungId PflichtstringUUID der Bank-Bewegung (aus bankbewegungen_auflisten) (z. B. aus der jeweiligen Liste).
beleg_lesenLesenLiest einen Beleg des Posteingangs (z. B. aus rechnungseingang_zuordnen): Lieferant, Rechnungsnummer und -datum, Fälligkeit, Netto, Steuer, Brutto, vorgeschlagenes Aufwandskonto (soll_konto), Objekt, Kostenstelle, Stand und Qualität der Texterkennung.Beleg:ReadLesen

GET /api/v1/partner/belege/:id

Liest einen Beleg des Posteingangs (z. B. aus rechnungseingang_zuordnen): Lieferant, Rechnungsnummer und -datum, Fälligkeit, Netto, Steuer, Brutto, vorgeschlagenes Aufwandskonto (soll_konto), Objekt, Kostenstelle, Stand und Qualität der Texterkennung. ohne_buchung=true heißt: noch nicht gebucht; aufteilung nennt die Aufteilung auf Unterkostenstellen. Ohne Bankverbindung. Bei einer auf Objekte begrenzten Rolle nur mit Objekt innerhalb der Grenze. Zusätzlich: zusatz (USt-IdNr, Leistungszeitraum, Belegart, Zahlart, Kunden- und Auftragsnummer …), kreditor (der erkannte Lieferant im Stamm und woran), objekt_vorschlag und konto_vorschlag (mit Grund, ob vorbelegt oder nur angeboten) sowie offen: was dem Beleg zum Erfassen noch fehlt (lesung, lieferant, datum, betrag, summe, konto, objekt, kreditor_neu, hinweis; leer = bereit). Braucht Beleg:Read.

Parameter von beleg_lesen
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
beleg_aktualisierenSchreibenKorrigiert einen Beleg vor dem Buchen: was die Texterkennung falsch gelesen hat (Lieferant, Rechnungsnummer, Datum, Beträge) und die Kontierung (sollKonto = Nummer des Aufwandskontos, objektNr, kostenstelleId, aufteilung auf Unterkostenstellen).Beleg:UpdateBearbeiten

PATCH /api/v1/partner/belege/:id

Korrigiert einen Beleg vor dem Buchen: was die Texterkennung falsch gelesen hat (Lieferant, Rechnungsnummer, Datum, Beträge) und die Kontierung (sollKonto = Nummer des Aufwandskontos, objektNr, kostenstelleId, aufteilung auf Unterkostenstellen). Nur die gesendeten Felder ändern sich. Beträge in Euro (Dezimalzahl). Die Bankverbindung des Lieferanten bestätigt ein Mensch im Portal (Vier-Augen) — sie lässt sich hier nicht setzen. Ein bereits gebuchter Beleg bleibt gebucht. Braucht Beleg:Update.

Parameter von beleg_aktualisieren
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
lieferantbeliebigName des Lieferanten.
rechnungsdatumbeliebigRechnungsdatum (JJJJ-MM-TT).
rechnungsnummerbeliebigRechnungsnummer des Lieferanten.
faelligkeitbeliebigFälligkeit (JJJJ-MM-TT).
nettobeliebigNetto in Euro.
mwstbeliebigSteuer in Euro.
bruttobeliebigBrutto in Euro.
waehrungbeliebigWährung, drei Buchstaben (EUR).
beschreibungbeliebigBeschreibung der Leistung.
sollKontobeliebigNummer des Aufwandskontos (3 bis 10 Ziffern, aus buchhaltung_konten_auflisten).
buchungstextbeliebigBuchungstext; ohne Angabe „Rechnungsnummer — Lieferant“.
objektNrbeliebigObjekt, dem die Kosten gehören.
kostenstelleIdbeliebigUUID der Kostenstelle.
aufteilungListe (object)Aufteilung auf Unterkostenstellen unter der Kostenstelle des Objekts: [{ unterkostenstelleId, betragCent }], Betrag in Cent, Summe höchstens der Bruttobetrag (der Rest bleibt „am Objekt“). Die ids aus unterkostenstellen_auflisten. Nicht angeben = unverändert; [] = Aufteilung entfernen. Ändert sich Kostenstelle oder Betrag, entfällt sie.
notizbeliebigInterne Notiz.
beleg_buchenSchreibenErfasst einen Beleg des Posteingangs wie „Beleg erfassen“ im Portal: Stapelzeile Aufwand an Kreditor plus offener Posten des Lieferanten, danach läuft der Freigabeweg.Beleg:BuchenBearbeiten

POST /api/v1/partner/belege/:id/buchung

Erfasst einen Beleg des Posteingangs wie „Beleg erfassen“ im Portal: Stapelzeile Aufwand an Kreditor plus offener Posten des Lieferanten, danach läuft der Freigabeweg. Es wird nichts bezahlt und nichts festgeschrieben; festschreiben lässt sich die Rechnung erst nach ihrer Freigabe. VORHER beleg_lesen: Lieferant, Rechnungsdatum, Brutto und Aufwandskonto müssen stehen (sonst beleg_aktualisieren), das Objekt, wenn die Kosten einem gehören. 409 mit Text heißt: Etwas fehlt, die Bankverbindung ist noch nicht von einem Menschen bestätigt, oder der Beleg ist schon gebucht — dann dem Menschen melden, nicht umgehen. Rechnungen aus dem Rechnungseingang kommen zuerst über rechnungseingang_zuordnen in den Mandanten. Mit aufteilung wird sie vor dem Buchen am Beleg gesetzt und reist mit dem offenen Posten und dem Stapelsatz weiter. Braucht Beleg:Buchen.

Parameter von beleg_buchen
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
aufteilungListe (object)Aufteilung auf Unterkostenstellen unter der Kostenstelle des Objekts: [{ unterkostenstelleId, betragCent }], Betrag in Cent, Summe höchstens der Bruttobetrag (der Rest bleibt „am Objekt“). Die ids aus unterkostenstellen_auflisten. Nicht angeben = unverändert; [] = Aufteilung entfernen. Ändert sich Kostenstelle oder Betrag, entfällt sie.
buchungen_auflistenLesenListet die festgeschriebenen Buchungen des Journals (GoBD, unveränderlich): Datum, Belegnummer, Belegkreis, Soll- und Habenkonto, Betrag in Cent, Text, Periode und Storno-Verweis.Buchung:ReadLesen

GET /api/v1/partner/buchungen

Listet die festgeschriebenen Buchungen des Journals (GoBD, unveränderlich): Datum, Belegnummer, Belegkreis, Soll- und Habenkonto, Betrag in Cent, Text, Periode und Storno-Verweis. periode und konto (UUIDs) und belegkreis grenzen ein, search findet Belegnummer, Text und einen Betrag wie "1.234,50". Der Weg zur id für buchung_stornieren. Nur für Rollen ohne Objektgrenze. Braucht Buchung:Read. Soll-Sicht: Beträge nach Sollstellung und Rechnung, nicht nach Zahlung — eine Zahl der Ist-Sicht (Jahresabrechnung, Anlage V, Kontoumsätze) darf davon abweichen.

Parameter von buchungen_auflisten
ParameterTypBeschreibung
periodestringUUID der Periode (aus buchhaltung_perioden_auflisten) (z. B. aus der jeweiligen Liste).
kontostringUUID eines Kontos, das auf Soll- oder Habenseite steht (z. B. aus der jeweiligen Liste).
belegkreisstringBelegkreis, z. B. ER.
searchstringFreitext: Belegnummer, Buchungstext oder Betrag.
limitintegerEinträge je Seite.
offsetintegerVersatz zum Blättern.
buchung_stornierenSchreibenStorniert eine festgeschriebene Buchung mit einer Gegenbuchung (Generalumkehr) — der einzige zulässige Weg, eine festgeschriebene Buchung zu korrigieren; gelöscht wird nie.Buchung:StornoBearbeiten

POST /api/v1/partner/buchungen/:buchungId/storno

Storniert eine festgeschriebene Buchung mit einer Gegenbuchung (Generalumkehr) — der einzige zulässige Weg, eine festgeschriebene Buchung zu korrigieren; gelöscht wird nie. Danach ist die Buchung als storniert verknüpft und nicht noch einmal stornierbar (409). 409 meldet auch eine abgeschlossene Periode, 423 eine Zielperiode, die nicht offen ist: beides dem Menschen melden, nicht umgehen. Nur auf ausdrücklichen Wunsch eines Menschen und mit der id aus buchungen_auflisten; die Korrekturbuchung erfasst danach buchung_erfassen. Braucht Buchung:Storno.

Parameter von buchung_stornieren
ParameterTypBeschreibung
buchungId PflichtstringUUID der Journal-Buchung (aus buchungen_auflisten) (z. B. aus der jeweiligen Liste).
grund PflichtstringWarum storniert wird, in einem Satz. Steht im Protokoll der Buchhaltung.
buchungstextstringErgänzender Text; Vorgabe „Storno zu <Belegnummer>“.
zielPeriodeIdstringUUID der offenen Periode, in der die Gegenbuchung stehen soll; Vorgabe die aktuelle offene (z. B. aus der jeweiligen Liste).
sepa_mandat_anlegenSchreibenErfasst ein SEPA-Lastschriftmandat, das ein Eigentümer (Hausgeld, eigentuemerId) oder ein Mieter (Miete, mieterId) unterschrieben hat.SepaMandat:CreateBearbeiten

POST /api/v1/partner/sepa-mandate

Erfasst ein SEPA-Lastschriftmandat, das ein Eigentümer (Hausgeld, eigentuemerId) oder ein Mieter (Miete, mieterId) unterschrieben hat. unterschriftDatum ist das Datum auf dem Mandatsformular und Pflicht: Nur anlegen, wenn das unterschriebene Formular vorliegt — kein Datum raten und keines vorgeben. IBAN und BIC werden geprüft, die Mandatsreferenz vergibt das System; je Person gibt es höchstens ein aktives Mandat (409). Die Antwort nennt die IBAN nur gekürzt. Ohne Vorabinformation zieht der Lastschriftlauf das Hausgeld nicht ein (14 Tage vorher, im Portal). Braucht SepaMandat:Create.

Parameter von sepa_mandat_anlegen
ParameterTypBeschreibung
eigentuemerIdstringID des Eigentümers (aus eigentuemer_auflisten) — oder mieterId.
mieterIdstringID des Mieters (aus mieter_auflisten) — oder eigentuemerId.
iban PflichtstringIBAN des Kontos, von dem eingezogen wird.
bicbeliebigBIC, optional bei deutschen Konten.
kontoinhaber PflichtstringName des Kontoinhabers wie auf dem Formular.
unterschriftDatum PflichtstringDatum der Unterschrift auf dem Mandatsformular (YYYY-MM-DD).
sev_hausgeld_lesenLesenLiest das Hausgeld an die Gemeinschaft bei fremdverwalteten Einheiten.SevHausgeld:ReadLesen mit Kontaktdaten

GET /api/v1/partner/sev-hausgeld/einheiten/:einheit_id

Liest das Hausgeld an die Gemeinschaft bei fremdverwalteten Einheiten. Ohne einheit_id: alle Einheiten in Objekten mit verwaltungsart sev mit aktueller Rate, Rücklagenanteil, Zahlweg, Verwaltung, offenen und überfälligen Terminen — Einheiten ohne Rate haben noch kein erfasstes Hausgeld. Mit einheit_id: Fassungen (gültig ab/bis, Bestandteile in Cent, Zahlweg, Kreditor), Termine eines Jahres mit Stand (erwartet, vorschlag, ausgeglichen, ueberfaellig, offen, erinnerung, bestaetigt, ersetzt, ausgesetzt) und Vorschlägen aus dem Kontoauszug, Abrechnungen der Verwaltung mit Abgleich (Soll, gezahlt, Spitze), nachzustellende Monate, Befunde und Vorschläge (verknüpfte Gemeinschaft, wiederkehrende Abbuchungen). Beträge in Cent. Braucht SevHausgeld:Read.

Parameter von sev_hausgeld_lesen
ParameterTypBeschreibung
einheit_idstringUUID der Einheit (einheiten_auflisten) (z. B. aus der jeweiligen Liste).
objekt_nrintegerOhne einheit_id: nur dieses Objekt.
jahrintegerMit einheit_id: Termine dieses Jahres (Vorgabe: laufendes Jahr).
sev_hausgeld_fassung_erfassenSchreibenErfasst das Hausgeld einer fremdverwalteten Einheit an die Gemeinschaft oder ändert es ab einem Monat (neue Fassung; die laufende endet am Vortag, offene Termine ab dem Monat werden mit dem neuen Betrag ersetzt — bezahlte bleiben).SevHausgeld:CreateBearbeiten

POST /api/v1/partner/sev-hausgeld/einheiten/:einheit_id/fassungen

Erfasst das Hausgeld einer fremdverwalteten Einheit an die Gemeinschaft oder ändert es ab einem Monat (neue Fassung; die laufende endet am Vortag, offene Termine ab dem Monat werden mit dem neuen Betrag ersetzt — bezahlte bleiben). Beträge in Euro je Bestandteil: bewirtschaftung (Pflicht), ruecklage, heizung_warmwasser, sonstiges — die Summe ist das Hausgeld im Monat. zahlweg: lastschrift_fremdverwaltung (die Verwaltung zieht ein; der Kontoauszug wird abgeglichen), ueberweisung_verwaltung (wir überweisen; zum Fälligkeitstag entsteht ein offener Posten für den Zahllauf) oder eigentuemer_direkt (nur Erinnerung). Fehlt der Kreditor, wird die Gemeinschaft ohne Bankdaten angelegt — die IBAN trägt ein Mensch im Portal ein. Der Termin des laufenden Monats entsteht sofort; zurückliegende Monate nennt die Antwort unter nachstellen, nachgestellt wird im Portal. Ab einem Monat, für den es schon eine Fassung gibt: 409. Nur Einheiten in Objekten mit verwaltungsart sev (sonst 409). Braucht SevHausgeld:Create.

Parameter von sev_hausgeld_fassung_erfassen
ParameterTypBeschreibung
einheit_id PflichtstringUUID der Einheit (z. B. aus der jeweiligen Liste).
gueltig_ab PflichtstringAb diesem Monat (YYYY-MM-DD; gezählt wird der Monatserste).
gueltig_bisbeliebigLetzter Tag, falls befristet (Verkauf, Ende der Verwaltung).
bewirtschaftung PflichtnumberBewirtschaftung in Euro (Verwaltung, Versicherung, Betriebskosten ohne Heizung).
ruecklagenumberZuführung zur Erhaltungsrücklage in Euro; 0, wenn keine.
heizung_warmwassernumberHeiz- und Warmwasservorschuss in Euro.
sonstigesnumberSonstiges in Euro (sonstiges_text nennt was).
sonstiges_textbeliebig
faellig_tagintegerTag im Monat, an dem gezahlt bzw. eingezogen wird (Vorgabe 1).
zahlweg Pflichtlastschrift_fremdverwaltung | ueberweisung_verwaltung | eigentuemer_direkt
fremdverwaltung_idbeliebigVerwaltung zu dieser Zeit; ohne Angabe die des Objekts.
lieferant_idbeliebigKreditor; ohne Angabe die Gemeinschaft (wird angelegt).
glaeubiger_idbeliebigGläubiger-ID der Lastschrift.
mandatsreferenzbeliebigMandatsreferenz — mit der Gläubiger-ID erkennt der Kontoauszug die Abbuchung sicher.
quellewirtschaftsplan | jahresabrechnung | verknuepft | zahlungen | uebernahme | nullWoher der Betrag stammt; ohne Angabe ki_zugang.
belegbeliebigz. B. „Mail der Verwaltung vom 03.11.2026, Ticket …“.
objekt_dokument_idbeliebigWirtschaftsplan als Dokument der Objektakte (dokument_hochladen_abschliessen).
beschluss_ambeliebigTag des Beschlusses über den Wirtschaftsplan.
notizbeliebig
sev_hausgeld_fassung_beendenSchreibenBeendet das Hausgeld einer fremdverwalteten Einheit zum Tag gueltig_bis (Verkauf, Ende der Verwaltung): Spätere offene Termine werden ersetzt, bezahlte bleiben.SevHausgeld:CreateBearbeiten

POST /api/v1/partner/sev-hausgeld/einheiten/:einheit_id/fassungen/:fassung_id/beenden

Beendet das Hausgeld einer fremdverwalteten Einheit zum Tag gueltig_bis (Verkauf, Ende der Verwaltung): Spätere offene Termine werden ersetzt, bezahlte bleiben. fassung_id aus sev_hausgeld_lesen; nur die letzte Fassung lässt sich beenden (sonst 409). Braucht SevHausgeld:Create.

Parameter von sev_hausgeld_fassung_beenden
ParameterTypBeschreibung
einheit_id PflichtstringUUID der Einheit (z. B. aus der jeweiligen Liste).
fassung_id PflichtstringUUID der Fassung (sev_hausgeld_lesen) (z. B. aus der jeweiligen Liste).
gueltig_bis PflichtstringLetzter Tag (YYYY-MM-DD).
sev_hausgeld_einmalig_erfassenSchreibenErfasst eine einmalige Zahlung an die Gemeinschaft einer fremdverwalteten Einheit: art einmalig (Nachforderung aus einem rückwirkend beschlossenen Wirtschaftsplan, Sonderumlage) oder rueckstand (Rückstand, den die Verwaltung bei der Übernahme nennt).SevHausgeld:CreateBearbeiten

POST /api/v1/partner/sev-hausgeld/einheiten/:einheit_id/einmalig

Erfasst eine einmalige Zahlung an die Gemeinschaft einer fremdverwalteten Einheit: art einmalig (Nachforderung aus einem rückwirkend beschlossenen Wirtschaftsplan, Sonderumlage) oder rueckstand (Rückstand, den die Verwaltung bei der Übernahme nennt). Beträge in Euro je Bestandteil wie beim Hausgeld. Ohne zahlweg gilt der des Hausgelds. Überweisen wir, entsteht der offene Posten. Braucht SevHausgeld:Create.

Parameter von sev_hausgeld_einmalig_erfassen
ParameterTypBeschreibung
einheit_id PflichtstringUUID der Einheit (z. B. aus der jeweiligen Liste).
art Pflichteinmalig | rueckstand
bezeichnung Pflichtstringz. B. „Nachforderung Wirtschaftsplan 2027, Januar bis Juni“.
faellig_am Pflichtstring
bewirtschaftung Pflichtnumber
ruecklagenumber
heizung_warmwassernumber
sonstigesnumber
zahlweglastschrift_fremdverwaltung | ueberweisung_verwaltung | eigentuemer_direkt | null
sev_hausgeld_abrechnung_erfassenSchreibenErfasst die Jahresabrechnung der Verwaltung der Gemeinschaft für eine fremdverwaltete Einheit (Einzelabrechnung).SevHausgeld:UpdateBearbeiten

PUT /api/v1/partner/sev-hausgeld/einheiten/:einheit_id/abrechnungen/:jahr

Erfasst die Jahresabrechnung der Verwaltung der Gemeinschaft für eine fremdverwaltete Einheit (Einzelabrechnung). Beträge in Euro: ergebnis (Kosten und Rücklage der Einheit), vorschuesse_soll und vorschuesse_gezahlt laut Abrechnung, Aufteilung (heizung_warmwasser, erhaltung, uebrige, ruecklage_zufuehrung, ruecklage_entnahme) und die umlagefähigen Anteile je Kostenart (kostenanteile, kostenart_id aus nk_kostenarten_auflisten) — die gehen in die Betriebskostenabrechnung des Mieters. Ohne spitze gilt ergebnis minus vorschuesse_soll. Die Antwort trägt den Abgleich mit den eigenen Terminen und Zahlungen. Die Spitze (Nachzahlung oder Guthaben) wird hier nicht gestellt — das ist ein Klick im Portal. Wieder aufgerufen ersetzt es die Werte des Jahres; eine gestellte Spitze lässt sich nicht mehr ändern (409). Ist die Betriebskostenabrechnung des Jahres schon freigegeben, werden die Kostenanteile abgewiesen (409). Braucht SevHausgeld:Update.

Parameter von sev_hausgeld_abrechnung_erfassen
ParameterTypBeschreibung
einheit_id PflichtstringUUID der Einheit (z. B. aus der jeweiligen Liste).
jahr Pflichtinteger
zeitraum_vonbeliebigVorgabe 01.01. des Jahres.
zeitraum_bisbeliebigVorgabe 31.12. des Jahres.
beschluss_ambeliebig
faellig_ambeliebigFälligkeit der Spitze laut Beschluss.
ergebnis PflichtnumberErgebnis der Einheit in Euro (Kosten plus Rücklagenzuführung).
vorschuesse_soll PflichtnumberBeschlossene Vorschüsse des Jahres in Euro.
vorschuesse_gezahltbeliebigLaut Abrechnung gezahlte Vorschüsse in Euro.
spitzebeliebigSpitze in Euro: positiv Nachzahlung, negativ Guthaben.
heizung_warmwasserbeliebig
erhaltungbeliebigErhaltung (Anlage V Zeile 55).
uebrigebeliebigÜbrige, nicht umlagefähige Kosten (Verwaltung, Bank — Anlage V Zeile 76).
ruecklage_zufuehrungbeliebig
ruecklage_entnahmebeliebigEigener Anteil an Entnahmen aus der Rücklage für Erhaltung.
kostenanteilebeliebig
objekt_dokument_idbeliebigAbrechnung als Dokument der Objektakte.
notizbeliebig
darlehen_auflistenLesenListet die Darlehen des Mandanten mit Konditionen (Bank, Art, Ursprungsbetrag, Zinssatz in Prozent, Laufzeit, Tilgungsbeginn, Zinsbindung_bis, Buchungskonten), kennzahlen (heutige Restschuld, nächste Rate, Monate bis Ende der Zinsbindung), abgleich (Stand der Raten im Journal: fehlende Raten und Tilgung, Ist-Saldo des Darlehenskontos, Differenz zum Plan) und handlungsbedarf (zinsbindung_fehlt, zinsbindung_endet, raten_fehlen, konto_fehlt).Darlehen:ReadLesen

GET /api/v1/partner/darlehen

Listet die Darlehen des Mandanten mit Konditionen (Bank, Art, Ursprungsbetrag, Zinssatz in Prozent, Laufzeit, Tilgungsbeginn, Zinsbindung_bis, Buchungskonten), kennzahlen (heutige Restschuld, nächste Rate, Monate bis Ende der Zinsbindung), abgleich (Stand der Raten im Journal: fehlende Raten und Tilgung, Ist-Saldo des Darlehenskontos, Differenz zum Plan) und handlungsbedarf (zinsbindung_fehlt, zinsbindung_endet, raten_fehlen, konto_fehlt). Beträge in Euro. Optional nur ein Objekt. Braucht Darlehen:Read.

Parameter von darlehen_auflisten
ParameterTypBeschreibung
objekt_nrintegerNur Darlehen dieses Objekts.
darlehen_lesenLesenLiest ein Darlehen mit allen Konditionen, Restschuld heute, Restlaufzeit, Gesamtzinsen und raten_abgleich (stand, beginn, fehlend = Raten ohne Buchung im Journal, fehlend_tilgung).Darlehen:ReadLesen

GET /api/v1/partner/darlehen/:nr

Liest ein Darlehen mit allen Konditionen, Restschuld heute, Restlaufzeit, Gesamtzinsen und raten_abgleich (stand, beginn, fehlend = Raten ohne Buchung im Journal, fehlend_tilgung). Die einzelnen Raten liefert darlehen_raten_lesen. nr aus darlehen_auflisten. Braucht Darlehen:Read.

Parameter von darlehen_lesen
ParameterTypBeschreibung
nr PflichtintegerDarlehensnummer (darlehen_auflisten).
darlehen_raten_lesenLesenLiest jede Planzeile eines Darlehens mit ihrem Stand im Journal: gebucht (mit gebucht_am), fehlt, faellig, kommt oder nicht_pruefbar (Konto fehlt oder geteilt, noch keine Buchung).Darlehen:ReadLesen

GET /api/v1/partner/darlehen/:nr/raten

Liest jede Planzeile eines Darlehens mit ihrem Stand im Journal: gebucht (mit gebucht_am), fehlt, faellig, kommt oder nicht_pruefbar (Konto fehlt oder geteilt, noch keine Buchung). Je Rate faelligkeit, rate, zins, tilgung, restschuld in Euro. Optional nur ein Jahr. Braucht Darlehen:Read.

Parameter von darlehen_raten_lesen
ParameterTypBeschreibung
nr PflichtintegerDarlehensnummer (darlehen_auflisten).
jahrintegerNur Raten, die in diesem Jahr fällig sind.
darlehen_tilgungsplan_lesenLesenLiest den Tilgungsplan eines Darlehens (Monat, Fälligkeit, Rate, Zins- und Tilgungsanteil, Restschuld in Euro), wie er sich aus den Konditionen und den Sondertilgungen ergibt.Darlehen:ReadLesen

GET /api/v1/partner/darlehen/:nr/tilgungsplan

Liest den Tilgungsplan eines Darlehens (Monat, Fälligkeit, Rate, Zins- und Tilgungsanteil, Restschuld in Euro), wie er sich aus den Konditionen und den Sondertilgungen ergibt. Ob die Raten gebucht sind, zeigt darlehen_raten_lesen. Braucht Darlehen:Read.

Parameter von darlehen_tilgungsplan_lesen
ParameterTypBeschreibung
nr PflichtintegerDarlehensnummer (darlehen_auflisten).
darlehen_anlegenSchreibenLegt ein Darlehen an einem Objekt an und erzeugt den Tilgungsplan.Darlehen:CreateBearbeiten

POST /api/v1/partner/darlehen

Legt ein Darlehen an einem Objekt an und erzeugt den Tilgungsplan. nr weglassen — der Server vergibt die nächste freie Nummer. zinsbindung_bis (Ende der Sollzinsbindung, bei Vollzahlern ohne Bindung das Laufzeitende) ist Pflicht. Zinssatz in Prozent p. a., ursprungsbetrag in Euro. darlehensart: annuitaet, tilgung oder endfaellig. buchungskonto ist das Konto der Tilgung (Verbindlichkeit, 4 bis 10 Ziffern), konto_zins der Zinsaufwand (ohne Angabe das des Kontenrahmens). Ein Objekt außerhalb der Rolle ist 404. Löschen gibt es nur im Portal. Braucht Darlehen:Create.

Parameter von darlehen_anlegen
ParameterTypBeschreibung
nrintegerDarlehensnummer — weglassen, dann vergibt sie der Server.
kurzname_selector PflichtstringKurzname, unter dem das Darlehen in Listen erscheint (z. B. „Sparkasse Haus 1“).
bank PflichtstringKreditgeber.
darlehensnummerbeliebigVertragsnummer bei der Bank.
objekt_nr PflichtintegerObjekt, das mit dem Darlehen finanziert wird (objekte_auflisten).
darlehensart Pflichtannuitaet | tilgung | endfaellig
ursprungsbetrag PflichtnumberDarlehensbetrag in Euro.
zinssatz PflichtnumberSollzins in Prozent p. a. (3,45 für 3,45 %).
laufzeit_monate Pflichtinteger
tilgungsbeginn PflichtstringFälligkeit der ersten Rate (YYYY-MM-DD).
zinsbindung_bis PflichtstringEnde der Sollzinsbindung (YYYY-MM-DD).
buchungskonto PflichtstringKonto der Tilgung (Darlehensverbindlichkeit).
konto_zinsstringKonto des Zinsaufwands; ohne Angabe das des Kontenrahmens.
zinsen_umlagefaehigbooleanZinsen sind auf Mieter umlagefähig (selten).
bemerkungenstring
darlehen_aktualisierenSchreibenÄndert ein Darlehen — nur die gesendeten Felder (Konditionen, zinsbindung_bis nach einer Anschlussfinanzierung, Konten, Bemerkung).Darlehen:UpdateBearbeiten

PUT /api/v1/partner/darlehen/:nr

Ändert ein Darlehen — nur die gesendeten Felder (Konditionen, zinsbindung_bis nach einer Anschlussfinanzierung, Konten, Bemerkung). Ändern sich Betrag, Zinssatz, Laufzeit oder Tilgungsbeginn, wird der Tilgungsplan neu erzeugt. Ein Zielobjekt außerhalb der Rolle ist 404. Braucht Darlehen:Update.

Parameter von darlehen_aktualisieren
ParameterTypBeschreibung
nr PflichtintegerDarlehensnummer (darlehen_auflisten).
kurzname_selectorstring
bankstring
darlehensnummerbeliebig
objekt_nrintegerObjekt-Nr. (Ganzzahl).
darlehensartannuitaet | tilgung | endfaellig
ursprungsbetragnumberEuro.
zinssatznumberProzent p. a.
laufzeit_monateinteger
tilgungsbeginnstring
zinsbindung_bisbeliebigEnde der Sollzinsbindung (YYYY-MM-DD).
buchungskontostring
konto_zinsstring
zinsen_umlagefaehigboolean
bemerkungenstring
darlehen_sondertilgung_erfassenSchreibenErfasst eine Sondertilgung (Betrag in Euro, Datum) und erzeugt den Tilgungsplan neu — Restschuld und Laufzeit ändern sich.Darlehen:UpdateBearbeiten

POST /api/v1/partner/darlehen/:nr/sondertilgungen

Erfasst eine Sondertilgung (Betrag in Euro, Datum) und erzeugt den Tilgungsplan neu — Restschuld und Laufzeit ändern sich. Gebucht wird dabei nichts: Die Zahlung selbst kommt über den Kontoauszug ins Journal und erscheint dann im Raten-Abgleich. Eine Sondertilgung wieder zu löschen geht über datensatz_loeschen mit art sondertilgung (id aus dieser Antwort; braucht Sondertilgung:Delete). Braucht Darlehen:Update.

Parameter von darlehen_sondertilgung_erfassen
ParameterTypBeschreibung
nr PflichtintegerDarlehensnummer (darlehen_auflisten).
datum PflichtstringTag der Sondertilgung (YYYY-MM-DD).
betrag PflichtnumberEuro.
notizenbeliebig
angebote_auflistenLesenListet die Angebote des Mandanten (Konzept 165): Nummer (AN-…, erst nach dem Versand), Betreff, Empfänger (Mieter, Eigentümer oder Person), Objekt, Angebotsdatum, gueltig_bis, Beträge in Cent und stand (entwurf, versandt, abgelaufen, angenommen, abgelehnt, widerrufen — abgelaufen wird aus gueltig_bis gerechnet).Angebot:ReadLesen mit Kontaktdaten

GET /api/v1/partner/angebote

Listet die Angebote des Mandanten (Konzept 165): Nummer (AN-…, erst nach dem Versand), Betreff, Empfänger (Mieter, Eigentümer oder Person), Objekt, Angebotsdatum, gueltig_bis, Beträge in Cent und stand (entwurf, versandt, abgelaufen, angenommen, abgelehnt, widerrufen — abgelaufen wird aus gueltig_bis gerechnet). Nicht das Verwaltungsangebot der Akquise. Braucht Angebot:Read.

angebot_lesenLesenLiest ein Angebot mit Positionen (Bezeichnung, Menge, Einheit, Einzelpreis in Cent), Anschreiben und Stand.Angebot:ReadLesen mit Kontaktdaten

GET /api/v1/partner/angebote/:String

Liest ein Angebot mit Positionen (Bezeichnung, Menge, Einheit, Einzelpreis in Cent), Anschreiben und Stand. id aus angebote_auflisten. Braucht Angebot:Read.

Parameter von angebot_lesen
ParameterTypBeschreibung
id PflichtstringUUID des Angebots (z. B. aus der jeweiligen Liste).
angebot_entwerfenSchreibenLegt ein Angebot als Entwurf an — nichts geht hinaus, eine Nummer gibt es erst beim Versand.Angebot:EntwerfenBearbeiten

POST /api/v1/partner/angebote

Legt ein Angebot als Entwurf an — nichts geht hinaus, eine Nummer gibt es erst beim Versand. Genau ein Empfänger: vertrag_id (Mieter), eigentuemer_id mit objekt_nr, oder person_id (Interessent aus personen_auflisten, objekt_nr wahlweise). gueltig_bis ist Pflicht (ohne Frist bände das Angebot bis zur Ablehnung) und liegt nicht vor dem angebotsdatum; im Portal ist die Vorgabe 14 Tage. Beim Mieter entscheidet der Vertrag über die Umsatzsteuer, sonst steuerschluessel_code oder die Leistungsart. Versenden, Annehmen und „Als Rechnung stellen“ gibt es nur im Portal. Braucht Angebot:Entwerfen.

Parameter von angebot_entwerfen
ParameterTypBeschreibung
vertrag_idbeliebigUUID des Mietvertrags (Empfänger: der Mieter) (z. B. aus der jeweiligen Liste).
eigentuemer_idbeliebigUUID des Eigentümers (z. B. aus der jeweiligen Liste).
objekt_nrbeliebigObjekt — Pflicht beim Eigentümer, wahlweise bei der Person.
person_idbeliebigFreier Empfänger (Interessent) aus personen_auflisten; braucht eine Anschrift.
steuerschluessel_codebeliebigNur Eigentümer und Person; beim Mieter entscheidet der Vertrag.
betreff Pflichtstring
angebotsdatum PflichtstringYYYY-MM-DD.
gueltig_bis PflichtstringLetzter Tag der Annahmefrist (YYYY-MM-DD).
leistungsart_idbeliebigUUID der Leistungsart (z. B. aus der jeweiligen Liste).
positionen PflichtListe (object)
anschreiben_htmlbeliebigAnschreiben über der Tabelle; ohne Angabe der Standardtext.
angebot_entwurf_aendernSchreibenErsetzt die Angaben eines Entwurfs vollständig (alle Felder wie bei angebot_entwerfen schicken — fehlende werden leer).Angebot:EntwerfenBearbeiten

PUT /api/v1/partner/angebote/:String

Ersetzt die Angaben eines Entwurfs vollständig (alle Felder wie bei angebot_entwerfen schicken — fehlende werden leer). Ein im Portal bearbeiteter Brieftext bleibt stehen. Ein versandtes Angebot lässt sich nicht ändern (409): Dafür gibt es im Portal „Neue Fassung“. Braucht Angebot:Entwerfen.

Parameter von angebot_entwurf_aendern
ParameterTypBeschreibung
id PflichtstringUUID des Angebots (z. B. aus der jeweiligen Liste).
vertrag_idbeliebigUUID des Mietvertrags (Empfänger: der Mieter) (z. B. aus der jeweiligen Liste).
eigentuemer_idbeliebigUUID des Eigentümers (z. B. aus der jeweiligen Liste).
objekt_nrbeliebigObjekt — Pflicht beim Eigentümer, wahlweise bei der Person.
person_idbeliebigFreier Empfänger (Interessent) aus personen_auflisten; braucht eine Anschrift.
steuerschluessel_codebeliebigNur Eigentümer und Person; beim Mieter entscheidet der Vertrag.
betreff Pflichtstring
angebotsdatum PflichtstringYYYY-MM-DD.
gueltig_bis PflichtstringLetzter Tag der Annahmefrist (YYYY-MM-DD).
leistungsart_idbeliebigUUID der Leistungsart (z. B. aus der jeweiligen Liste).
positionen PflichtListe (object)
anschreiben_htmlbeliebigAnschreiben über der Tabelle; ohne Angabe der Standardtext.

[08]16 Tools

Offene Posten und Mahnwesen

offene_posten_auflistenLesenListet die Schuldner mit offenen Forderungen — Mieter (Miete, Nebenkosten) und Eigentümer (Hausgeld) —, je Schuldner Name, Objekt, Einheit, offener Betrag, seit wann fällig, Tage überfällig, Zahl der Positionen und Stand der letzten Mahnung (letzter_mahnstatus, letzter_mahnstufe).OffenerPosten:ReadLesen mit Kontaktdaten

GET /api/v1/partner/offene-posten

Listet die Schuldner mit offenen Forderungen — Mieter (Miete, Nebenkosten) und Eigentümer (Hausgeld) —, je Schuldner Name, Objekt, Einheit, offener Betrag, seit wann fällig, Tage überfällig, Zahl der Positionen und Stand der letzten Mahnung (letzter_mahnstatus, letzter_mahnstufe). Sortiert nach Alter. filter: alle, faellig oder ueberfaellig (ab 14 Tagen). meta.kennzahlen nennt Summe offen, Summe überfällig und die Zahl der Schuldner. betroffener_id und typ gehören in offener_posten_lesen. Bei einer auf Objekte begrenzten Rolle nur deren Objekte, bei einer auf Einheiten begrenzten gesperrt. Mit stichtag gilt die Liste zu einem vergangenen Tag (z. B. 31.12. für den Jahresabschluss): Was danach gezahlt, zurückgenommen oder ausgebucht wurde, ist herausgerechnet; Posten, die erst danach fällig wurden, fehlen; eine spätere Änderung am Soll wirkt zurück. meta.stichtag nennt den Tag, null heißt heute. Braucht OffenerPosten:Read. Soll-Sicht: Beträge nach Sollstellung und Rechnung, nicht nach Zahlung — eine Zahl der Ist-Sicht (Jahresabrechnung, Anlage V, Kontoumsätze) darf davon abweichen.

Parameter von offene_posten_auflisten
ParameterTypBeschreibung
filteralle | faellig | ueberfaelligWelche Posten gezählt werden.
objekt_nrintegerObjekt-Nr. (Ganzzahl).
stichtagstringVergangener Tag (JJJJ-MM-TT), zu dem der Stand gelten soll, etwa der 31.12. eines Jahres — zurückgerechnet aus den datierten Zahlungen. Ohne Angabe: heute.
offener_posten_lesenLesenLiest einen Schuldner mit allen offenen Positionen: bei einem Mieter je Monat soll, ist, offen und Tage überfällig (positionen[].id ist die Kennung der Mietforderung, die mahnung_anlegen als positionenIds und forderung_ausbuchung_vorschau als mietZahlungId braucht), bei einem Eigentümer das Hausgeld.OffenerPosten:ReadLesen mit Kontaktdaten

GET /api/v1/partner/offene-posten/:typ/:id

Liest einen Schuldner mit allen offenen Positionen: bei einem Mieter je Monat soll, ist, offen und Tage überfällig (positionen[].id ist die Kennung der Mietforderung, die mahnung_anlegen als positionenIds und forderung_ausbuchung_vorschau als mietZahlungId braucht), bei einem Eigentümer das Hausgeld. typ und id (betroffener_id) stammen aus offene_posten_auflisten. Mit stichtag die Positionen zu einem vergangenen Tag, zurückgerechnet wie in offene_posten_auflisten. Braucht OffenerPosten:Read. Soll-Sicht: Beträge nach Sollstellung und Rechnung, nicht nach Zahlung — eine Zahl der Ist-Sicht (Jahresabrechnung, Anlage V, Kontoumsätze) darf davon abweichen.

Parameter von offener_posten_lesen
ParameterTypBeschreibung
typ Pflichtmieter | eigentuemerArt des Schuldners.
id PflichtstringUUID des Mieters bzw. Eigentümers (betroffener_id aus offene_posten_auflisten) (z. B. aus der jeweiligen Liste).
stichtagstringVergangener Tag (JJJJ-MM-TT), zu dem der Stand gelten soll, etwa der 31.12. eines Jahres — zurückgerechnet aus den datierten Zahlungen. Ohne Angabe: heute.
mahnkandidaten_auflistenLesenListet, wer seit mindestens `tage` Tagen im Rückstand ist und gemahnt werden könnte — je Schuldner und Objekt mit den überfälligen Positionen (id, Monat, offen, Tage überfällig) und der Summe.Mahnung:ReadLesen mit Kontaktdaten

GET /api/v1/partner/mahnungen/kandidaten

Listet, wer seit mindestens `tage` Tagen im Rückstand ist und gemahnt werden könnte — je Schuldner und Objekt mit den überfälligen Positionen (id, Monat, offen, Tage überfällig) und der Summe. Die Positions-IDs sind positionenIds von mahnung_anlegen. Eine Position, die schon in einer laufenden Mahnung steckt, weist mahnung_anlegen ab (409). Ob gemahnt wird, entscheidet der Mensch. Bei einer auf Einheiten begrenzten Rolle gesperrt. Braucht Mahnung:Read.

Parameter von mahnkandidaten_auflisten
ParameterTypBeschreibung
tageintegerMindestens so viele Tage überfällig.
typmieter | eigentuemer | alleMieter (Miete), Eigentümer (Hausgeld) oder beide.
objekt_nrintegerObjekt-Nr. (Ganzzahl).
mahnungen_auflistenLesenListet die Mahnungen des Mandanten: Stufe (1 Zahlungserinnerung, 2 erste Mahnung, 3 zweite Mahnung), Schuldner, Objekt, offener Betrag, Mahngebühr, Verzugszinsen, Gesamtbetrag, Fälligkeit, Versanddatum und Status (entwurf, versandt, bezahlt, storniert).Mahnung:ReadLesen mit Kontaktdaten

GET /api/v1/partner/mahnungen

Listet die Mahnungen des Mandanten: Stufe (1 Zahlungserinnerung, 2 erste Mahnung, 3 zweite Mahnung), Schuldner, Objekt, offener Betrag, Mahngebühr, Verzugszinsen, Gesamtbetrag, Fälligkeit, Versanddatum und Status (entwurf, versandt, bezahlt, storniert). Braucht Mahnung:Read.

Parameter von mahnungen_auflisten
ParameterTypBeschreibung
statusentwurf | versandt | bezahlt | storniertNur Mahnungen in diesem Stand.
betroffener_typmieter | eigentuemerNur Mahnungen an Mieter bzw. Eigentümer.
objekt_nrintegerObjekt-Nr. (Ganzzahl).
mahnung_lesenLesenLiest eine Mahnung mit allen Feldern (Positionen, Beträge, Fristen, Notizen, Status).Mahnung:ReadLesen mit Kontaktdaten

GET /api/v1/partner/mahnungen/:id

Liest eine Mahnung mit allen Feldern (Positionen, Beträge, Fristen, Notizen, Status). Braucht Mahnung:Read.

Parameter von mahnung_lesen
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
mahnung_anlegenSchreibenLegt eine Mahnung als ENTWURF an und startet ihren Workflow — es wird nichts verschickt.Mahnung:CreateBearbeiten

POST /api/v1/partner/mahnungen

Legt eine Mahnung als ENTWURF an und startet ihren Workflow — es wird nichts verschickt. mahnStufe: 1 Zahlungserinnerung, 2 erste Mahnung, 3 zweite Mahnung. Genau einer von mieterId und eigentuemerId; objektNr und positionenIds aus mahnkandidaten_auflisten bzw. offener_posten_lesen. mahnfristTage (Vorgabe 14). Der Dienst weist Positionen ab, die schon in einer aktiven Mahnung stecken (409) oder nicht zu Schuldner und Objekt gehören. Nur anlegen, wenn der Mensch es will — eine Mahnung ist eine Erklärung gegenüber dem Mieter; Stufe und Wortlaut gehören geprüft. Schreiben, Versand und PDF laufen im Portal (Mahnlauf freigeben). Braucht Mahnung:Create.

Parameter von mahnung_anlegen
ParameterTypBeschreibung
mahnStufe Pflicht1 | 2 | 31 Zahlungserinnerung, 2 erste Mahnung, 3 zweite Mahnung.
mieterIdstringUUID des Mieters (Miete) (z. B. aus der jeweiligen Liste).
eigentuemerIdstringUUID des Eigentümers (Hausgeld) (z. B. aus der jeweiligen Liste).
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
positionenIds PflichtListe (integer)Die Positionen, die die Mahnung aufnimmt.
mahnfristTageintegerZahlungsfrist in Tagen (Vorgabe 14).
notizenbeliebigInterne Notiz.
verzugszinsTypverbraucher | unternehmer | weg_hausgeldZinsart; ohne Angabe verbraucher (Gewerbe: unternehmer).
mahnung_workflow_statusLesenZeigt den Stand der Mahnung im Workflow (rueckstand_erkannt, erinnerung, mahnung_1, mahnung_2, mahnung_3, bezahlt, storniert, inkasso) und die Ereignisse, die der Assistent auslösen darf.Mahnung:ReadLesen mit Kontaktdaten

GET /api/v1/partner/mahnungen/:id/workflow

Zeigt den Stand der Mahnung im Workflow (rueckstand_erkannt, erinnerung, mahnung_1, mahnung_2, mahnung_3, bezahlt, storniert, inkasso) und die Ereignisse, die der Assistent auslösen darf. Braucht Mahnung:Read.

Parameter von mahnung_workflow_status
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
mahnung_workflow_transitionSchreibenMeldet einen Schritt der Mahnung im Workflow.Mahnung:UpdateBearbeiten

POST /api/v1/partner/mahnungen/:id/workflow/transition

Meldet einen Schritt der Mahnung im Workflow. Erlaubt: erinnerung_senden (Zahlungserinnerung ist hinausgegangen), mahnung_1_senden, mahnung_2_senden (Payload mahngebuehr_cent, zahlungsfrist_tage laut mahnung_workflow_status), pay (Zahlung eingegangen; Payload eingangsdatum, betrag_eingegangen_cent) und stornieren. ACHTUNG: Das Ereignis VERSCHICKT NICHTS — es hält fest, dass die Mahnung hinausging, setzt den Stand auf versandt, löst den Hinweis „Mahnstufe erreicht“ aus und startet die Zahlungsfrist. Nur melden, wenn ein Mensch das Schreiben tatsächlich verschickt hat. Kündigungsandrohung (mahnung_3_senden) und Inkasso löst allein ein Mensch im Portal aus (403). Pflicht-Payload je Ereignis siehe payloadSchema in mahnung_workflow_status. Braucht Mahnung:Update.

Parameter von mahnung_workflow_transition
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
event Pflichterinnerung_senden | mahnung_1_senden | mahnung_2_senden | pay | stornierenDas auszulösende Ereignis.
payloadobjectEreignis-Felder laut payloadSchema (optional).
forderung_ausbuchung_vorschauLesenRechnet vor, was eine Ausbuchung kostet, ohne zu buchen: offener Rest der Forderung, der Verlust netto und die Umsatzsteuer-Berichtigung.Forderung:AusbuchenBearbeiten

GET /api/v1/partner/forderungsausbuchungen/vorschau

Rechnet vor, was eine Ausbuchung kostet, ohne zu buchen: offener Rest der Forderung, der Verlust netto und die Umsatzsteuer-Berichtigung. mietZahlungId steht in offener_posten_lesen (positionen[].id). Ohne betragCent der ganze Rest. Nur für Rollen ohne Objektgrenze. Braucht Forderung:Ausbuchen.

Parameter von forderung_ausbuchung_vorschau
ParameterTypBeschreibung
mietZahlungId PflichtintegerKennung der Mietforderung (positionen[].id aus offener_posten_lesen).
betragCentintegerNur dieser Teil in Cent; ohne Angabe der ganze offene Rest.
forderung_ausbuchenSchreibenBucht eine Mietforderung ganz oder teilweise aus — als Verlust auf einem Aufwandskonto samt Berichtigung der Umsatzsteuer.Forderung:AusbuchenBearbeiten

POST /api/v1/partner/forderungsausbuchungen

Bucht eine Mietforderung ganz oder teilweise aus — als Verlust auf einem Aufwandskonto samt Berichtigung der Umsatzsteuer. Das ist eine wirtschaftliche Entscheidung mit steuerlicher Folge: NUR auf ausdrückliche Anweisung eines Menschen, nie von sich aus, und erst nach forderung_ausbuchung_vorschau. grund: uneinbringlich, verjaehrt, erlass oder vergleich; begruendung mindestens ein Satz (steht im Protokoll); verlustkontoId ist ein Aufwandskonto aus buchhaltung_konten_auflisten. Die Ausbuchung steht als Entwurf im Stapel und lässt sich mit forderung_ausbuchung_zuruecknehmen zurücknehmen, solange nichts festgeschrieben ist. Verlangt zusätzlich Buchungsstapel:Create. Braucht Forderung:Ausbuchen.

Parameter von forderung_ausbuchen
ParameterTypBeschreibung
mietZahlungId PflichtintegerKennung der Mietforderung (positionen[].id aus offener_posten_lesen).
betragCentintegerTeilbetrag in Cent; ohne Angabe der ganze offene Rest.
grund Pflichtuneinbringlich | verjaehrt | erlass | vergleichWarum die Forderung ausgebucht wird.
begruendung PflichtstringBegründung in mindestens einem Satz.
verlustkontoId PflichtstringUUID des Aufwandskontos für den Verlust (aus buchhaltung_konten_auflisten) (z. B. aus der jeweiligen Liste).
forderung_ausbuchung_zuruecknehmenSchreibenNimmt eine Ausbuchung zurück, solange ihre Buchung noch im Stapel steht und nichts festgeschrieben ist: Die Forderung ist wieder offen.Forderung:AusbuchenBearbeiten

POST /api/v1/partner/forderungsausbuchungen/:ausbuchungId/ruecknahme

Nimmt eine Ausbuchung zurück, solange ihre Buchung noch im Stapel steht und nichts festgeschrieben ist: Die Forderung ist wieder offen. begruendung mindestens ein Satz. 409 heißt: schon festgeschrieben — dann ist es ein Fall für einen Menschen im Portal. Verlangt zusätzlich Buchungsstapel:Update. Braucht Forderung:Ausbuchen.

Parameter von forderung_ausbuchung_zuruecknehmen
ParameterTypBeschreibung
ausbuchungId PflichtstringUUID der Ausbuchung (id aus forderung_ausbuchen) (z. B. aus der jeweiligen Liste).
begruendung PflichtstringWarum die Ausbuchung zurückgenommen wird.
forderungsfuehrung_lesenLesenLiest, ab welchem Monat der Mandant seine Forderungen führt (ab, leer = ab Beginn), wer es wann gesetzt hat und was davor ruht: Zahl der Posten und Monate, offener Betrag, davon mit Zahlung belegt, ausgeglichene Bankvorgänge und Sollstellungsläufe davor.Forderungsfuehrung:ReadLesen

GET /api/v1/partner/forderungsfuehrung

Liest, ab welchem Monat der Mandant seine Forderungen führt (ab, leer = ab Beginn), wer es wann gesetzt hat und was davor ruht: Zahl der Posten und Monate, offener Betrag, davon mit Zahlung belegt, ausgeglichene Bankvorgänge und Sollstellungsläufe davor. Nur für Rollen ohne Objektgrenze. Braucht Forderungsfuehrung:Read.

forderungsfuehrung_vorschauLesenRechnet vor, was ein Stichtag bewirken würde, ohne ihn zu setzen: ruhende Posten und Monate, offener Betrag, Posten mit Zahlung (Summe), Ausgleichsvorgänge und Läufe davor.Forderungsfuehrung:ReadLesen

GET /api/v1/partner/forderungsfuehrung/vorschau

Rechnet vor, was ein Stichtag bewirken würde, ohne ihn zu setzen: ruhende Posten und Monate, offener Betrag, Posten mit Zahlung (Summe), Ausgleichsvorgänge und Läufe davor. ab ist ein Monatserster (JJJJ-MM-01). Nur für Rollen ohne Objektgrenze. Braucht Forderungsfuehrung:Read.

Parameter von forderungsfuehrung_vorschau
ParameterTypBeschreibung
ab PflichtstringMonatserster JJJJ-MM-01, ab dem die Forderungen geführt würden.
forderungsfuehrung_setzenSchreibenLegt fest, ab welchem Monat der Mandant seine Forderungen führt; ab: null hebt es auf.Forderungsfuehrung:UpdateBearbeiten

PUT /api/v1/partner/forderungsfuehrung

Legt fest, ab welchem Monat der Mandant seine Forderungen führt; ab: null hebt es auf. Eine Entscheidung mit Folgen für Zuordnung, Mahnwesen und Sollstellungslauf: NUR auf ausdrückliche Anweisung eines Menschen und erst nach forderungsfuehrung_vorschau. zuordnungenLoesen nimmt die Zahlungen von ruhenden Posten zurück (mit Gegenbuchung, übernommene Zahlungen als Ganzes); laeufeZuruecknehmen nimmt die Sollstellungsläufe davor zurück und setzt zuordnungenLoesen voraus. Was sich nicht lösen lässt (festgeschrieben, Periode gesperrt), steht mit Grund in nicht_geloest; der Stichtag gilt trotzdem. Mit zuordnungenLoesen oder laeufeZuruecknehmen zusätzlich Buchungsstapel:Update. Nur für Rollen ohne Objektgrenze. Braucht Forderungsfuehrung:Update.

Parameter von forderungsfuehrung_setzen
ParameterTypBeschreibung
ab PflichtbeliebigMonatserster JJJJ-MM-01 oder null (alle Posten werden geführt).
zuordnungenLoesenbooleanZuordnungen auf ruhenden Posten lösen; die Zahlungen stehen wieder zur Zuordnung bereit.
laeufeZuruecknehmenbooleanSollstellungsläufe vor dem Stichtag zurücknehmen (nur Entwürfe ohne Zahlung).
kaution_stand_lesenLesenLiest die Kaution eines Mietvertrags: die Einbehaltsregel (was beim Auszug zurückbehalten wird, mit Herkunft Vertrag, Vorgabe des Mandanten oder Standard), die Restkaution in Cent, offene und aufgelöste Einbehalte mit Bedingung („Betriebskostenabrechnung 2026“, Datum), die Bewegungen (Einzahlung, Zinsen, Abzug, Auszahlung, Verrechnung), Auszugs- und Schlussabrechnung mit Stand und die offenen Forderungen des Vertrags, die sich verrechnen ließen.Kaution:ReadLesen

GET /api/v1/partner/kautionen/:vertragId

Liest die Kaution eines Mietvertrags: die Einbehaltsregel (was beim Auszug zurückbehalten wird, mit Herkunft Vertrag, Vorgabe des Mandanten oder Standard), die Restkaution in Cent, offene und aufgelöste Einbehalte mit Bedingung („Betriebskostenabrechnung 2026“, Datum), die Bewegungen (Einzahlung, Zinsen, Abzug, Auszahlung, Verrechnung), Auszugs- und Schlussabrechnung mit Stand und die offenen Forderungen des Vertrags, die sich verrechnen ließen. Vor dem Auszug stehen nur Regel und Abrechnungen da. Braucht Kaution:Read.

Parameter von kaution_stand_lesen
ParameterTypBeschreibung
vertragId PflichtstringUUID des Mietvertrags (aus mietvertraege_auflisten) (z. B. aus der jeweiligen Liste).
kaution_einbehalt_verrechnenSchreibenVerrechnet offene Forderungen eines Mietvertrags (z. B. eine Betriebskosten-Nachzahlung nach dem Auszug) mit der Restkaution — höchstens so viel, wie offen ist und die Restkaution trägt.Kaution:VerrechnenBearbeiten

POST /api/v1/partner/kautionen/:vertragId/verrechnen

Verrechnet offene Forderungen eines Mietvertrags (z. B. eine Betriebskosten-Nachzahlung nach dem Auszug) mit der Restkaution — höchstens so viel, wie offen ist und die Restkaution trägt. Bucht Erhaltene Kautionen an Debitor und gleicht die Forderung aus; ausgezahlt wird nichts. Mit `aufloesen` und `einbehaltId` gilt der Einbehalt danach als erledigt; sind alle erledigt, entsteht die Schlussabrechnung als Entwurf (freigegeben und ausgezahlt wird sie im Portal). Ohne `mietZahlungIds` alle offenen Forderungen des Vertrags. Nur auf ausdrücklichen Wunsch eines Menschen. Braucht Kaution:Verrechnen und Buchungsstapel:Create.

Parameter von kaution_einbehalt_verrechnen
ParameterTypBeschreibung
vertragId PflichtstringUUID des Mietvertrags (z. B. aus der jeweiligen Liste).
mietZahlungIdsListe (integer)Die Forderungen (id aus offene_forderungen von kaution_stand_lesen).
betragCentintegerHöchstens dieser Betrag in Cent.
einbehaltIdstringDer Einbehalt (id aus kaution_stand_lesen), der damit erledigt ist.
aufloesenbooleanDen Einbehalt nach der Verrechnung auflösen.
bezeichnungstringText der Verrechnung, z. B. „Nachzahlung Betriebskosten 2026“.

[09]75 Tools

Abrechnungen

nk_kostenvorschlag_lesenLesenLiest, was die Buchhaltung für ein Objekt und ein Abrechnungsjahr an Kosten hergibt: je Aufwandskonto Saldo in Cent, Zahl der Buchungen, zugeordnete Kostenart und ob die Kosten schon als Objektkosten übernommen sind.Betriebskosten:CreateBearbeiten

GET /api/v1/partner/betriebskosten/objekte/:objektNr/kostenvorschlag

Liest, was die Buchhaltung für ein Objekt und ein Abrechnungsjahr an Kosten hergibt: je Aufwandskonto Saldo in Cent, Zahl der Buchungen, zugeordnete Kostenart und ob die Kosten schon als Objektkosten übernommen sind. Stornierte Buchungen und ihre Gegenbuchungen sind herausgerechnet, Gutschriften mindern. Schreibt nichts. Der erste Schritt der Abrechnung: prüfen, ob Konten fehlen oder doppelt gebucht sind, bevor nk_objektkosten_uebernehmen sie übernimmt. datumsbasis buchungsdatum (Vorgabe) oder belegdatum. Braucht Betriebskosten:Create.

Parameter von nk_kostenvorschlag_lesen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
datumsbasisbuchungsdatum | belegdatumWelches Datum zählt für das Jahr.
nk_objektkosten_uebernehmenSchreibenÜbernimmt Kosten aus dem Kostenvorschlag als Objektkosten der Abrechnung: je gewähltem Konto (kontoNummer aus nk_kostenvorschlag_lesen) eine Zeile mit Betrag, Kostenart und Umlageschlüssel, verknüpft mit den zugrunde liegenden Buchungen.Betriebskosten:CreateBearbeiten

POST /api/v1/partner/betriebskosten/objekte/:objektNr/kostenvorschlag/uebernahme

Übernimmt Kosten aus dem Kostenvorschlag als Objektkosten der Abrechnung: je gewähltem Konto (kontoNummer aus nk_kostenvorschlag_lesen) eine Zeile mit Betrag, Kostenart und Umlageschlüssel, verknüpft mit den zugrunde liegenden Buchungen. Sind seit einer früheren Übernahme Buchungen dazugekommen, wächst die Zeile um deren Betrag; eine bestehende Zeile wird nie überschrieben. Die Antwort nennt angelegt, ergaenzt und uebersprungen (mit Grund, z. B. kein Konto mit Kostenart). Nur Konten übernehmen, die nach dem Vorschlag tatsächlich umlagefähig sind — im Zweifel dem Menschen melden. Braucht Betriebskosten:Create.

Parameter von nk_objektkosten_uebernehmen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
datumsbasisbuchungsdatum | belegdatumMuss zu nk_kostenvorschlag_lesen passen.
konten PflichtListe (object)Die zu übernehmenden Konten.
nk_aufteilungen_lesenLesenLiest, welcher Beschluss je Aufwandskonto und Jahre die Anteile einer Rechnung auf Einheiten trägt (nur WEG): je Zuordnung id, kontoNummer, Beschluss (Nummer, Titel, Ergebnis) und jahr_von bis jahr_bis.Betriebskosten:CreateBearbeiten

GET /api/v1/partner/betriebskosten/objekte/:objektNr/nk-aufteilungen

Liest, welcher Beschluss je Aufwandskonto und Jahre die Anteile einer Rechnung auf Einheiten trägt (nur WEG): je Zuordnung id, kontoNummer, Beschluss (Nummer, Titel, Ergebnis) und jahr_von bis jahr_bis. Ohne Zuordnung wirken die Anteile einer Rechnung in der Jahresabrechnung nicht. Beschlussnummern findet man über beschluesse_auflisten. Schreibt nichts. Braucht Betriebskosten:Create.

Parameter von nk_aufteilungen_lesen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
nk_aufteilung_zuordnenSchreibenOrdnet einem Aufwandskonto für die Jahre jahrVon bis jahrBis einen Beschluss zu, der die Aufteilung der Rechnungsanteile auf Einheiten trägt (beschlussId aus beschluesse_auflisten).Betriebskosten:CreateBearbeiten

POST /api/v1/partner/betriebskosten/objekte/:objektNr/nk-aufteilungen

Ordnet einem Aufwandskonto für die Jahre jahrVon bis jahrBis einen Beschluss zu, der die Aufteilung der Rechnungsanteile auf Einheiten trägt (beschlussId aus beschluesse_auflisten). Gilt nur in einer WEG; der Beschluss muss zum Objekt gehören und angenommen sein; im Zeitraum darf das Konto keine zweite Zuordnung haben (409). Besteht für eines der Jahre schon eine Jahresabrechnung, antwortet der Server mit 409 — erst den Lauf zurücknehmen oder eine neue Fassung anlegen. Bereits übernommene Kostenzeilen ändern sich nicht (löschen und neu übernehmen); die Anteile wirken erst beim Übernehmen der Kosten mit nk_objektkosten_uebernehmen. Braucht Betriebskosten:Create.

Parameter von nk_aufteilung_zuordnen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
kontoNummer PflichtstringAufwandskonto, wie in nk_kostenvorschlag_lesen.
beschlussId PflichtintegerID des angenommenen Beschlusses (beschluesse_auflisten).
jahrVon PflichtintegerErstes Abrechnungsjahr.
jahrBis PflichtintegerLetztes Abrechnungsjahr (nicht vor jahrVon).
nk_aufteilung_entfernenLöschenEntfernt eine Zuordnung von Beschluss und Konto (id aus nk_aufteilungen_lesen).Betriebskosten:CreateBearbeiten

DELETE /api/v1/partner/betriebskosten/objekte/:objektNr/nk-aufteilungen/:id

Entfernt eine Zuordnung von Beschluss und Konto (id aus nk_aufteilungen_lesen). Besteht für eines der Jahre schon eine Jahresabrechnung, antwortet der Server mit 409. Bereits übernommene Kostenzeilen bleiben unverändert (löschen und neu übernehmen). Braucht Betriebskosten:Create.

Parameter von nk_aufteilung_entfernen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
id PflichtstringID der Zuordnung (UUID).
nk_objektkosten_anlegenSchreibenLegt eine Kostenzeile der Betriebskostenabrechnung von Hand an — für Kosten, die nicht in der Buchhaltung stehen, etwa die umlagefähigen Posten aus der Hausgeldabrechnung einer fremden WEG.Betriebskosten:CreateBearbeiten

POST /api/v1/partner/betriebskosten/objekte/:objektNr/objektkosten

Legt eine Kostenzeile der Betriebskostenabrechnung von Hand an — für Kosten, die nicht in der Buchhaltung stehen, etwa die umlagefähigen Posten aus der Hausgeldabrechnung einer fremden WEG. Derselbe Weg wie „Kostenposition“ im Portal. gesamtkosten in Euro brutto. Der Lauf verteilt den Betrag vollständig auf die Einheiten des Objekts: Bei flaeche teilt er durch gesamtFlaeche (ohne Angabe die Summe der Einheitsflächen), und die Gegenprobe verlangt, dass die Anteile zusammen 1 ergeben. Für Wohnungen in einer fremden WEG deshalb nicht die Hauskosten eintragen, sondern den Anteil der eigenen Einheiten (Hauskosten × Summe ihrer Flächen / Hausfläche) ohne gesamtFlaeche. direkt: der ganze Betrag trägt die Einheit direktEinheitId. lohnanteilBetrag ist der Lohnanteil nach § 35a EStG. Vorher nk_objektkosten_auflisten — jeder Aufruf legt eine weitere Zeile an. Nur umlagefähige Kosten eintragen, im Zweifel dem Menschen melden. Ändern und Löschen nur im Portal. Braucht Betriebskosten:Create.

Parameter von nk_objektkosten_anlegen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
bezeichnung PflichtstringBezeichnung der Kostenzeile, z. B. „Müllabfuhr“.
kostenartIdintegerKostenart aus nk_kostenarten_auflisten.
gesamtkosten PflichtnumberBetrag in Euro brutto, nicht 0.
umlageschluessel Pflichtflaeche | personen | einheit | mea | direktVerteilung auf die Einheiten.
gesamtFlaechenumberNur wenn abweichend von der Summe der Einheitsflächen (m²).
direktEinheitIdstringUUID der Einheit — Pflicht bei direkt, sonst nicht erlaubt.
lohnanteilBetragnumberLohnanteil nach § 35a EStG in Euro.
notizstringInterne Notiz, z. B. Herkunft und Rechenweg.
nk_objektkosten_auflistenLesenListet die Kostenzeilen der Betriebskostenabrechnung je Objekt und Jahr: Kostenart, Betrag, Umlageschlüssel (Fläche, Personen, Verbrauch, Einheiten …), Gesamtfläche und Einheiten des Objekts.Betriebskosten:ReadLesen

GET /api/v1/partner/betriebskosten/objektkosten

Listet die Kostenzeilen der Betriebskostenabrechnung je Objekt und Jahr: Kostenart, Betrag, Umlageschlüssel (Fläche, Personen, Verbrauch, Einheiten …), Gesamtfläche und Einheiten des Objekts. Die Positionen und der Umlageschlüssel, die der Lauf verteilt — vor dem Trockenlauf prüfen. Anlegen von Hand über nk_objektkosten_anlegen, Ändern nur im Portal. Braucht Betriebskosten:Read.

Parameter von nk_objektkosten_auflisten
ParameterTypBeschreibung
objekt_nrintegerObjekt-Nr. (Ganzzahl).
jahrintegerAbrechnungsjahr.
nk_kostenarten_auflistenLesenListet den Katalog der Kostenarten: Name, Bezugsfläche, Umlageschlüssel, ob gesetzlich umlagefähig, ob sie unter die Heizkostenverordnung fällt, und das Kennzeichen nach § 35a EStG samt Vorschlag.Betriebskosten:ReadLesen

GET /api/v1/partner/betriebskosten/kostenarten

Listet den Katalog der Kostenarten: Name, Bezugsfläche, Umlageschlüssel, ob gesetzlich umlagefähig, ob sie unter die Heizkostenverordnung fällt, und das Kennzeichen nach § 35a EStG samt Vorschlag. Zum Prüfen, nach welchem Schlüssel verteilt wird. Braucht Betriebskosten:Read.

nk_abrechnungslauf_vorschauSchreibenRechnet die Betriebskostenabrechnung für ein Objekt und ein Jahr als Trockenlauf — es wird nichts angelegt.Betriebskosten:CreateBearbeiten

POST /api/v1/partner/betriebskosten/laeufe/vorschau

Rechnet die Betriebskostenabrechnung für ein Objekt und ein Jahr als Trockenlauf — es wird nichts angelegt. Liefert je Einheit und Kostenart die Verteilung (Mieter, Nutzungszeitraum, Anteil, Vorauszahlung, Ergebnis), die Gegenprobe je Kostenart (verteilt gegen Gesamtkosten) und Hinweise, etwa Leerstand oder fehlende Zählerstände. Hält die Gegenprobe nicht (ok=false), KEINEN Lauf starten und nicht freigeben, sondern dem Menschen die Abweichungen melden. zeitraumVon/zeitraumBis nur bei einem Rumpfjahr (beides oder nichts). vzVorschlag=true rechnet die neue Vorauszahlung mit. Nur für Rollen ohne Einheitengrenze. Braucht Betriebskosten:Create.

Parameter von nk_abrechnungslauf_vorschau
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
abrechnungsJahr PflichtintegerAbrechnungsjahr.
zeitraumVonstringBeginn eines abweichenden Zeitraums (JJJJ-MM-TT).
zeitraumBisstringEnde eines abweichenden Zeitraums (JJJJ-MM-TT).
vzVorschlagbooleanVorschlag für die neue Vorauszahlung mitrechnen.
nk_abrechnungslauf_startenSchreibenStartet den Abrechnungslauf: legt für jeden Mietvertrag des Objekts eine Abrechnung an (Entwurf) und verteilt die Kosten.Betriebskosten:CreateBearbeiten

POST /api/v1/partner/betriebskosten/laeufe

Startet den Abrechnungslauf: legt für jeden Mietvertrag des Objekts eine Abrechnung an (Entwurf) und verteilt die Kosten. Antwortet sofort mit 202 und status=laeuft; gerechnet wird im Hintergrund. Danach nk_abrechnungslauf_lesen abfragen, bis status gerechnet (oder fehlgeschlagen) ist (fortschritt_erledigt von fortschritt_gesamt). Pro Objekt und Jahr gibt es einen Lauf; 409 heißt, er besteht schon. VORHER nk_abrechnungslauf_vorschau: Nur starten, wenn die Gegenprobe hält. Gleiche Parameter. Es wird nichts verschickt. Braucht Betriebskosten:Create.

Parameter von nk_abrechnungslauf_starten
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
abrechnungsJahr PflichtintegerAbrechnungsjahr.
zeitraumVonstringBeginn eines abweichenden Zeitraums (JJJJ-MM-TT).
zeitraumBisstringEnde eines abweichenden Zeitraums (JJJJ-MM-TT).
vzVorschlagbooleanVorschlag für die neue Vorauszahlung auf Seite 2 jeder Abrechnung.
nk_abrechnungslaeufe_auflistenLesenListet die Abrechnungsläufe: Objekt, Jahr, Zeitraum, Stand (laeuft, gerechnet, freigegeben, zurueckgenommen, fehlgeschlagen), Gegenprobe ok, Zahl der Einheiten und Abrechnungen, Gesamtkosten, Anteile Mieter und Eigentümer, Fortschritt.Betriebskosten:ReadLesen

GET /api/v1/partner/betriebskosten/laeufe

Listet die Abrechnungsläufe: Objekt, Jahr, Zeitraum, Stand (laeuft, gerechnet, freigegeben, zurueckgenommen, fehlgeschlagen), Gegenprobe ok, Zahl der Einheiten und Abrechnungen, Gesamtkosten, Anteile Mieter und Eigentümer, Fortschritt. Ohne Mieternamen. Braucht Betriebskosten:Read.

Parameter von nk_abrechnungslaeufe_auflisten
ParameterTypBeschreibung
objekt_nrintegerObjekt-Nr. (Ganzzahl).
limitintegerHöchstzahl der Läufe.
nk_abrechnungslauf_lesenLesenLiest einen Abrechnungslauf im Detail: Fortschritt, die Zeilen je Einheit (Mieter, Zeitraum, Kostenanteil, Vorauszahlung, Ergebnis, Abrechnung-ID), die Gegenprobe je Kostenart und das Protokoll des Laufs.Betriebskosten:CreateBearbeiten

GET /api/v1/partner/betriebskosten/laeufe/:laufId

Liest einen Abrechnungslauf im Detail: Fortschritt, die Zeilen je Einheit (Mieter, Zeitraum, Kostenanteil, Vorauszahlung, Ergebnis, Abrechnung-ID), die Gegenprobe je Kostenart und das Protokoll des Laufs. Das Ergebnis je Mieter steht hier; die abrechnung_id gehört in nk_abrechnung_workflow_status. Braucht Betriebskosten:Create (die Zeilen nennen Mieter).

Parameter von nk_abrechnungslauf_lesen
ParameterTypBeschreibung
laufId PflichtstringUUID des Abrechnungslaufs (aus nk_abrechnungslaeufe_auflisten) (z. B. aus der jeweiligen Liste).
nk_abrechnungslauf_freigebenSchreibenGibt einen gerechneten Lauf frei und startet für jede seiner Abrechnungen den Freigabe-Workflow (Plausibilität, Eigentümerfreigabe, Versand).Betriebskosten:UpdateBearbeiten

POST /api/v1/partner/betriebskosten/laeufe/:laufId/freigabe

Gibt einen gerechneten Lauf frei und startet für jede seiner Abrechnungen den Freigabe-Workflow (Plausibilität, Eigentümerfreigabe, Versand). Nur bei haltender Gegenprobe; sonst 409 mit den Abweichungen je Kostenart — dann dem Menschen melden. Die Freigabe ist die Entscheidung der Verwaltung, dass die Zahlen stimmen: erst nk_abrechnungslauf_lesen (Gegenprobe, Zeilen, Hinweise), nie ungefragt. Es geht noch nichts an Eigentümer oder Mieter; das beginnt erst mit nk_abrechnung_workflow_transition. Braucht Betriebskosten:Update.

Parameter von nk_abrechnungslauf_freigeben
ParameterTypBeschreibung
laufId PflichtstringUUID des Abrechnungslaufs (z. B. aus der jeweiligen Liste).
nk_abrechnungslauf_zuruecknehmenSchreibenNimmt einen Lauf zurück und räumt ab, was er angelegt hat (Abrechnungen im Entwurf), damit für Objekt und Jahr neu gerechnet werden kann.Betriebskosten:DeleteBearbeiten

POST /api/v1/partner/betriebskosten/laeufe/:laufId/ruecknahme

Nimmt einen Lauf zurück und räumt ab, was er angelegt hat (Abrechnungen im Entwurf), damit für Objekt und Jahr neu gerechnet werden kann. Bricht mit 409 ab, wenn eine Abrechnung inzwischen im Freigabe-Workflow steckt oder versendet ist — dann ist es ein Fall für einen Menschen. Braucht Betriebskosten:Delete.

Parameter von nk_abrechnungslauf_zuruecknehmen
ParameterTypBeschreibung
laufId PflichtstringUUID des Abrechnungslaufs (z. B. aus der jeweiligen Liste).
nk_abrechnung_workflow_statusLesenZeigt den Stand einer Abrechnung im Freigabe-Workflow (entwurf, intern_geprueft, eigentuemer_freigabe, freigegeben, versendet, widersprochen, akzeptiert, einwendungsfrist_abgelaufen, abgelehnt, storniert) und die Schritte, die der Assistent auslösen darf: nur stornieren.Betriebskosten:ReadLesen

GET /api/v1/partner/betriebskosten/abrechnungen/:abrechnungId/workflow

Zeigt den Stand einer Abrechnung im Freigabe-Workflow (entwurf, intern_geprueft, eigentuemer_freigabe, freigegeben, versendet, widersprochen, akzeptiert, einwendungsfrist_abgelaufen, abgelehnt, storniert) und die Schritte, die der Assistent auslösen darf: nur stornieren. Prüfen und Versenden laufen über die Akte (betriebskostenabrechnung_lesen und ihre Werkzeuge). Braucht Betriebskosten:Read.

Parameter von nk_abrechnung_workflow_status
ParameterTypBeschreibung
abrechnungId PflichtintegerID des Datensatzes.
nk_abrechnung_workflow_transitionSchreibenStorniert eine Abrechnung im Freigabe-Workflow (nur auf Anweisung des Menschen).Betriebskosten:UpdateBearbeiten

POST /api/v1/partner/betriebskosten/abrechnungen/:abrechnungId/workflow/transition

Storniert eine Abrechnung im Freigabe-Workflow (nur auf Anweisung des Menschen). Prüfen, Versenden und Korrekturen laufen über die Akte der Betriebskostenabrechnung. Guards und Übergangsrecht prüft die Engine wie im Portal (409/403). Pflicht-Payload siehe payloadSchema in nk_abrechnung_workflow_status. Braucht Betriebskosten:Update.

Parameter von nk_abrechnung_workflow_transition
ParameterTypBeschreibung
abrechnungId PflichtintegerID des Datensatzes.
event PflichtstornierenDas auszulösende Ereignis.
payloadobjectEreignis-Felder laut payloadSchema (optional).
hausgeld_abrechnungslauf_vorschauSchreibenRechnet die Hausgeld-Jahresabrechnung einer Gemeinschaft (WEG-Objekt) für ein Jahr als Trockenlauf — es wird nichts angelegt.Hausgeldabrechnung:CreateBearbeiten

POST /api/v1/partner/hausgeld-abrechnung/laeufe/vorschau

Rechnet die Hausgeld-Jahresabrechnung einer Gemeinschaft (WEG-Objekt) für ein Jahr als Trockenlauf — es wird nichts angelegt. Liefert die Quellsummen, je Eigentümer bzw. Einheit Kostenanteil, Vorauszahlung und Abrechnungsspitze sowie die Gegenprobe. Gilt nur für Objekte mit verwaltungsart weg (409 sonst). Hält die Gegenprobe nicht, nicht rechnen lassen, sondern melden. Braucht Hausgeldabrechnung:Create. Ist-Sicht: Beträge nach Zahlung (Tag des Kontoumsatzes) — eine Zahl der Soll-Sicht (Saldenliste, Offene Posten) darf davon abweichen.

Parameter von hausgeld_abrechnungslauf_vorschau
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
abrechnungsjahr PflichtintegerAbrechnungsjahr.
hausgeld_abrechnungslauf_startenSchreibenRechnet die Hausgeld-Jahresabrechnung und legt die Abrechnungen der Eigentümer an (Entwurf).Hausgeldabrechnung:CreateBearbeiten

POST /api/v1/partner/hausgeld-abrechnung/laeufe

Rechnet die Hausgeld-Jahresabrechnung und legt die Abrechnungen der Eigentümer an (Entwurf). Vorgelegt wird sie den Eigentümern, beschlossen in der Versammlung und gebucht im Portal — nichts davon geschieht hier. Pro Objekt und Jahr gibt es einen Lauf (409). VORHER hausgeld_abrechnungslauf_vorschau; hält die Gegenprobe nicht, nicht starten, sondern dem Menschen die Abweichung melden. Braucht Hausgeldabrechnung:Create.

Parameter von hausgeld_abrechnungslauf_starten
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
abrechnungsjahr PflichtintegerAbrechnungsjahr.
hausgeld_abrechnungslaeufe_auflistenLesenListet die Hausgeld-Abrechnungsläufe: Objekt, Jahr, Zeitraum, Stand, Gegenprobe, Summen und ob sie schon vorgelegt, beschlossen oder gebucht sind.Hausgeldabrechnung:ReadLesen mit Kontaktdaten

GET /api/v1/partner/hausgeld-abrechnung/laeufe

Listet die Hausgeld-Abrechnungsläufe: Objekt, Jahr, Zeitraum, Stand, Gegenprobe, Summen und ob sie schon vorgelegt, beschlossen oder gebucht sind. Braucht Hausgeldabrechnung:Read.

Parameter von hausgeld_abrechnungslaeufe_auflisten
ParameterTypBeschreibung
objekt_nrintegerObjekt-Nr. (Ganzzahl).
limitintegerHöchstzahl der Läufe.
hausgeld_abrechnungslauf_lesenLesenLiest einen Hausgeld-Abrechnungslauf: Kopf, die Zeilen je Eigentümer (Zahlen aller Eigentümer der Gemeinschaft), Gegenprobe und Protokoll.Hausgeldabrechnung:ReadLesen mit Kontaktdaten

GET /api/v1/partner/hausgeld-abrechnung/laeufe/:laufId

Liest einen Hausgeld-Abrechnungslauf: Kopf, die Zeilen je Eigentümer (Zahlen aller Eigentümer der Gemeinschaft), Gegenprobe und Protokoll. Braucht Hausgeldabrechnung:Read. Ist-Sicht: Beträge nach Zahlung (Tag des Kontoumsatzes) — eine Zahl der Soll-Sicht (Saldenliste, Offene Posten) darf davon abweichen.

Parameter von hausgeld_abrechnungslauf_lesen
ParameterTypBeschreibung
laufId PflichtstringUUID des Hausgeld-Abrechnungslaufs (aus hausgeld_abrechnungslaeufe_auflisten) (z. B. aus der jeweiligen Liste).
hausgeld_abrechnungslauf_zuruecknehmenSchreibenNimmt einen Hausgeld-Abrechnungslauf zurück und löscht die angelegten Abrechnungen, damit neu gerechnet werden kann.Hausgeldabrechnung:CreateBearbeiten

POST /api/v1/partner/hausgeld-abrechnung/laeufe/:laufId/ruecknahme

Nimmt einen Hausgeld-Abrechnungslauf zurück und löscht die angelegten Abrechnungen, damit neu gerechnet werden kann. 409, wenn der Lauf den Eigentümern schon vorgelegt, beschlossen oder gebucht ist — das ist dann ein Fall für einen Menschen im Portal. Braucht Hausgeldabrechnung:Create.

Parameter von hausgeld_abrechnungslauf_zuruecknehmen
ParameterTypBeschreibung
laufId PflichtstringUUID des Hausgeld-Abrechnungslaufs (z. B. aus der jeweiligen Liste).
jahresabrechnungen_auflistenLesenArbeitsliste der WEG-Jahresabrechnungen: je Gemeinschaft das Vorjahr (auch „nicht_angelegt“) und jedes offene Jahr mit Stand (gerechnet, in_pruefung, geprueft, vorgelegt, vertagt, beschlossen, abgelehnt, gestellt, abgeschlossen), Saldo in Cent, Fassung, Versammlung der Vorlage und Ende der Anfechtungsfrist.Jahresabrechnung:ReadLesen

GET /api/v1/partner/jahresabrechnungen

Arbeitsliste der WEG-Jahresabrechnungen: je Gemeinschaft das Vorjahr (auch „nicht_angelegt“) und jedes offene Jahr mit Stand (gerechnet, in_pruefung, geprueft, vorgelegt, vertagt, beschlossen, abgelehnt, gestellt, abgeschlossen), Saldo in Cent, Fassung, Versammlung der Vorlage und Ende der Anfechtungsfrist. Mit objektNr die Jahresleiste eines Objekts. Braucht Jahresabrechnung:Read.

Parameter von jahresabrechnungen_auflisten
ParameterTypBeschreibung
objektNrintegerObjekt-Nr. (Ganzzahl).
jahresabrechnung_lesenLesenLiest die Jahresabrechnung einer Gemeinschaft für ein Jahr als Akte: Stand, Fassung, Summen (Kosten, Nachzahlungen, Guthaben, Fälligkeit), je Einheit Abrechnungsspitze, umlagefähiger Anteil und § 35a-Arbeitskosten (Dienstleistung und Handwerk) in Cent, Zustellweg und Zugang — ohne Eigentümernamen.Jahresabrechnung:ReadLesen

GET /api/v1/partner/jahresabrechnungen/:objektNr/:jahr

Liest die Jahresabrechnung einer Gemeinschaft für ein Jahr als Akte: Stand, Fassung, Summen (Kosten, Nachzahlungen, Guthaben, Fälligkeit), je Einheit Abrechnungsspitze, umlagefähiger Anteil und § 35a-Arbeitskosten (Dienstleistung und Handwerk) in Cent, Zustellweg und Zugang — ohne Eigentümernamen. Dazu die Schrittleiste (Rechnen, Prüfen, Vorlegen, Beschließen, Spitzen): je Schritt erledigt/aktuell/offen, was fehlt (mit Reiter als Ziel) und die nächste Hauptaktion samt Grund, falls gesperrt; Fristen (Einladung, Anfechtung, Fälligkeit) und die eingefrorenen Fassungen. Braucht Jahresabrechnung:Read. Ist-Sicht: Beträge nach Zahlung (Tag des Kontoumsatzes) — eine Zahl der Soll-Sicht (Saldenliste, Offene Posten) darf davon abweichen.

Parameter von jahresabrechnung_lesen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
jahresabrechnung_zur_pruefung_gebenSchreibenGibt eine gerechnete Jahresabrechnung zur Prüfung (Schritt Rechnen → Prüfen).Hausgeldabrechnung:CreateBearbeiten

POST /api/v1/partner/jahresabrechnungen/:objektNr/:jahr/zur-pruefung

Gibt eine gerechnete Jahresabrechnung zur Prüfung (Schritt Rechnen → Prüfen). Hält die Gegenprobe nicht, antwortet die API mit 409 und dem Grund. Braucht Hausgeldabrechnung:Create.

Parameter von jahresabrechnung_zur_pruefung_geben
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
jahresabrechnung_pruefung_abschliessenSchreibenSchließt die Prüfung ab — nach der Beiratsprüfung oder ohne Beirat mit Grund (uebersprungenGrund).Jahresabrechnung:EntscheidenBearbeiten · nur persönlich

POST /api/v1/partner/jahresabrechnungen/:objektNr/:jahr/pruefung-abschliessen

Schließt die Prüfung ab — nach der Beiratsprüfung oder ohne Beirat mit Grund (uebersprungenGrund). Nur über den persönlichen KI-Zugang. Braucht Jahresabrechnung:Entscheiden.

Parameter von jahresabrechnung_pruefung_abschliessen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
uebersprungenGrundbeliebigGrund, warum ohne Beiratsprüfung weitergemacht wird.
jahresabrechnung_vorlegenSchreibenFriert die Fassung ein und legt die Einzelabrechnungen den Eigentümern vor — zu einer Versammlung (etvId) oder ohne (null, Umlaufbeschluss) — und stellt sie zu (Portal, E-Mail; Post mit der Einladung).Jahresabrechnung:EntscheidenBearbeiten · nur persönlich

POST /api/v1/partner/jahresabrechnungen/:objektNr/:jahr/vorlegen

Friert die Fassung ein und legt die Einzelabrechnungen den Eigentümern vor — zu einer Versammlung (etvId) oder ohne (null, Umlaufbeschluss) — und stellt sie zu (Portal, E-Mail; Post mit der Einladung). Ein Eigentümer ohne Zustellweg sperrt mit 409 und Weg. guthabenWeg: verrechnen (Vorgabe) oder auszahlen. Nur über den persönlichen KI-Zugang. Braucht Jahresabrechnung:Entscheiden.

Parameter von jahresabrechnung_vorlegen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
etvId PflichtbeliebigID der Eigentümerversammlung oder null.
guthabenWegverrechnen | auszahlenWas mit Guthaben geschieht.
jahresabrechnung_beschluss_erfassenSchreibenErfasst das Ergebnis der Versammlung: angenommen (mit beschlussId aus der Beschluss-Sammlung, optional faelligAm — Vorgabe 30 Tage nach Beschluss), abgelehnt oder vertagt.Jahresabrechnung:EntscheidenBearbeiten · nur persönlich

POST /api/v1/partner/jahresabrechnungen/:objektNr/:jahr/beschluss

Erfasst das Ergebnis der Versammlung: angenommen (mit beschlussId aus der Beschluss-Sammlung, optional faelligAm — Vorgabe 30 Tage nach Beschluss), abgelehnt oder vertagt. Beim Annehmen geht die Einzelabrechnung an den Eigentümer, der beim Beschluss im Grundbuch steht. Nur über den persönlichen KI-Zugang. Braucht Jahresabrechnung:Entscheiden.

Parameter von jahresabrechnung_beschluss_erfassen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
ergebnis Pflichtangenommen | abgelehnt | vertagtErgebnis der Abstimmung.
beschlussIdintegerNur bei angenommen: ID des Beschlusses.
faelligAmstringNur bei angenommen: Fälligkeit der Nachschüsse (JJJJ-MM-TT).
jahresabrechnung_spitzen_stellenSchreibenStellt die beschlossenen Abrechnungsspitzen als Forderungen bzw. Gutschriften (Fälligkeit laut Beschluss).Jahresabrechnung:EntscheidenBearbeiten · nur persönlich

POST /api/v1/partner/jahresabrechnungen/:objektNr/:jahr/spitzen

Stellt die beschlossenen Abrechnungsspitzen als Forderungen bzw. Gutschriften (Fälligkeit laut Beschluss). abrechnungskontoId ist das Sachkonto der Abrechnungsspitzen. Nur über den persönlichen KI-Zugang. Braucht Jahresabrechnung:Entscheiden.

Parameter von jahresabrechnung_spitzen_stellen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
abrechnungskontoId PflichtstringUUID des Abrechnungskontos (z. B. aus der jeweiligen Liste).
buchungsdatumstringBuchungsdatum (JJJJ-MM-TT), Vorgabe heute.
betriebskostenabrechnungen_auflistenLesenArbeitsliste der Betriebskostenabrechnungen: je Miet- und SEV-Objekt das Vorjahr (auch „nicht_angelegt“) und jedes offene Jahr mit Stand, Ergebnis in Cent, Abrechnungsfrist (Zugang beim Mieter bis — § 556 Abs. 3 BGB) und Ende der letzten Einwendungsfrist.Betriebskosten:ReadLesen

GET /api/v1/partner/betriebskostenabrechnungen

Arbeitsliste der Betriebskostenabrechnungen: je Miet- und SEV-Objekt das Vorjahr (auch „nicht_angelegt“) und jedes offene Jahr mit Stand, Ergebnis in Cent, Abrechnungsfrist (Zugang beim Mieter bis — § 556 Abs. 3 BGB) und Ende der letzten Einwendungsfrist. Mit objektNr die Jahresleiste eines Objekts. Braucht Betriebskosten:Read.

Parameter von betriebskostenabrechnungen_auflisten
ParameterTypBeschreibung
objektNrintegerObjekt-Nr. (Ganzzahl).
betriebskostenabrechnung_lesenLesenLiest die Betriebskostenabrechnung eines Objekts für ein Jahr als Akte: Kosten je Kostenart mit Vorjahr und „entfällt“, die Abrechnungen je Nutzungszeitraum (Einheit, Zeitraum, Ergebnis in Cent, Zustellweg, Versand, Zugang, Einwendungsfrist, Stand) — ohne Mieternamen —, die Schrittleiste (Kosten, Verteilen, Prüfen, Versenden, Ergebnis, Einwendungen) mit Befunden, Hauptaktion und Sperrgrund, die Fristen und die Fassungen.Betriebskosten:ReadLesen

GET /api/v1/partner/betriebskostenabrechnungen/:objektNr/:jahr

Liest die Betriebskostenabrechnung eines Objekts für ein Jahr als Akte: Kosten je Kostenart mit Vorjahr und „entfällt“, die Abrechnungen je Nutzungszeitraum (Einheit, Zeitraum, Ergebnis in Cent, Zustellweg, Versand, Zugang, Einwendungsfrist, Stand) — ohne Mieternamen —, die Schrittleiste (Kosten, Verteilen, Prüfen, Versenden, Ergebnis, Einwendungen) mit Befunden, Hauptaktion und Sperrgrund, die Fristen und die Fassungen. Braucht Betriebskosten:Read.

Parameter von betriebskostenabrechnung_lesen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
betriebskostenabrechnung_kostenart_entfaelltSchreibenVermerkt, dass eine Kostenart des Vorjahres in diesem Jahr entfällt (entfaellt=true), oder hebt den Vermerk auf.Betriebskosten:CreateBearbeiten

POST /api/v1/partner/betriebskostenabrechnungen/:objektNr/:jahr/kosten/entfaellt

Vermerkt, dass eine Kostenart des Vorjahres in diesem Jahr entfällt (entfaellt=true), oder hebt den Vermerk auf. Ohne Betrag und ohne Vermerk sperrt Schritt 1 die Verteilung. Nur bis zum Versand. Braucht Betriebskosten:Create.

Parameter von betriebskostenabrechnung_kostenart_entfaellt
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
bezeichnung PflichtstringBezeichnung der Kostenart wie in betriebskostenabrechnung_lesen.
entfaellt Pflichtbooleantrue vermerkt, false hebt auf.
betriebskostenabrechnung_verteilenSchreibenLegt den Abrechnungslauf an und verteilt die Kosten auf die Nutzungszeiträume (läuft im Hintergrund; den Fortschritt zeigt betriebskostenabrechnung_lesen).Betriebskosten:CreateBearbeiten

POST /api/v1/partner/betriebskostenabrechnungen/:objektNr/:jahr/verteilen

Legt den Abrechnungslauf an und verteilt die Kosten auf die Nutzungszeiträume (läuft im Hintergrund; den Fortschritt zeigt betriebskostenabrechnung_lesen). Gesperrt, solange Schritt 1 Befunde meldet. Braucht Betriebskosten:Create.

Parameter von betriebskostenabrechnung_verteilen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
vzVorschlagbooleanVorschlag neue Vorauszahlung je Abrechnung (Vorgabe ja).
betriebskostenabrechnung_zur_pruefung_gebenSchreibenGibt eine verteilte Betriebskostenabrechnung zur Prüfung.Betriebskosten:CreateBearbeiten

POST /api/v1/partner/betriebskostenabrechnungen/:objektNr/:jahr/zur-pruefung

Gibt eine verteilte Betriebskostenabrechnung zur Prüfung. Braucht Betriebskosten:Create.

Parameter von betriebskostenabrechnung_zur_pruefung_geben
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
betriebskostenabrechnung_pruefung_abschliessenSchreibenSchließt die interne Prüfung ab.Betriebskosten:EntscheidenBearbeiten · nur persönlich

POST /api/v1/partner/betriebskostenabrechnungen/:objektNr/:jahr/pruefung-abschliessen

Schließt die interne Prüfung ab. Nur über den persönlichen KI-Zugang. Braucht Betriebskosten:Entscheiden.

Parameter von betriebskostenabrechnung_pruefung_abschliessen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
betriebskostenabrechnung_freigabe_anfordernSchreibenFordert bei eingeschalteter Eigentümerfreigabe des Objekts die Freigabe aller noch offenen Abrechnungen der Akte bei den Eigentümern an (E-Mail mit Link, Frist 14 Tage).Betriebskosten:EntscheidenBearbeiten · nur persönlich

POST /api/v1/partner/betriebskostenabrechnungen/:objektNr/:jahr/eigentuemerfreigabe

Fordert bei eingeschalteter Eigentümerfreigabe des Objekts die Freigabe aller noch offenen Abrechnungen der Akte bei den Eigentümern an (E-Mail mit Link, Frist 14 Tage). Versendet wird erst, wenn alle freigegeben sind; eine Ablehnung wird über neu verteilen behoben. Nur über den persönlichen KI-Zugang. Braucht Betriebskosten:Entscheiden.

Parameter von betriebskostenabrechnung_freigabe_anfordern
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
kommentarstringOptionaler Hinweis an die Eigentümer.
betriebskostenabrechnung_versendenSchreibenVersendet alle Abrechnungen der Akte je Mieter auf seinem Weg (Mieterportal, E-Mail mit PDF, Brief über den Versandanbieter, sonst Druckliste), friert die Fassung ein und nennt je Abrechnung Weg, Zugang und Einwendungsfrist.Betriebskosten:EntscheidenBearbeiten · nur persönlich

POST /api/v1/partner/betriebskostenabrechnungen/:objektNr/:jahr/versand

Versendet alle Abrechnungen der Akte je Mieter auf seinem Weg (Mieterportal, E-Mail mit PDF, Brief über den Versandanbieter, sonst Druckliste), friert die Fassung ein und nennt je Abrechnung Weg, Zugang und Einwendungsfrist. Gesperrt ohne Zustelladresse oder ohne CO2-Angaben. Nur über den persönlichen KI-Zugang. Braucht Betriebskosten:Entscheiden.

Parameter von betriebskostenabrechnung_versenden
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
betriebskostenabrechnung_ergebnis_stellenSchreibenStellt Nachzahlungen und Guthaben je Abrechnung zum eigenen Zugang (Zahlungsfrist in Tagen, Vorgabe 30).Betriebskosten:EntscheidenBearbeiten · nur persönlich

POST /api/v1/partner/betriebskostenabrechnungen/:objektNr/:jahr/ergebnis

Stellt Nachzahlungen und Guthaben je Abrechnung zum eigenen Zugang (Zahlungsfrist in Tagen, Vorgabe 30). Liegt der Zugang nach Ablauf der Abrechnungsfrist, wird keine Nachforderung gestellt — außer mit nachforderungFreigaben und Begründung, dass die Verspätung nicht zu vertreten ist. Guthaben immer. Nur über den persönlichen KI-Zugang; verlangt zusätzlich das Recht, Buchungen im Stapel anzulegen. Braucht Betriebskosten:Entscheiden.

Parameter von betriebskostenabrechnung_ergebnis_stellen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
zahlungsfristTageintegerZahlungsfrist ab Zugang in Tagen.
nachforderungFreigabenListe (object)Nachforderungen trotz verspätetem Zugang, je mit Begründung.
betriebskostenabrechnung_korrektur_anlegenSchreibenLegt zu versendeten Abrechnungen je eine Korrekturabrechnung an (neue Fassung der Akte, Grund Pflicht).Betriebskosten:EntscheidenBearbeiten · nur persönlich

POST /api/v1/partner/betriebskostenabrechnungen/:objektNr/:jahr/korrekturen

Legt zu versendeten Abrechnungen je eine Korrekturabrechnung an (neue Fassung der Akte, Grund Pflicht). Die Korrektur wird danach in der immoGenio Verwaltung bearbeitet und einzeln versendet. Nur über den persönlichen KI-Zugang. Braucht Betriebskosten:Entscheiden.

Parameter von betriebskostenabrechnung_korrektur_anlegen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
abrechnungIds PflichtListe (integer)IDs aus betriebskostenabrechnung_lesen.
grund PflichtstringWarum korrigiert wird.
betriebskostenabrechnung_text_lesenLesenLiest den Brieftext einer Betriebskostenabrechnung, wie er an den Mieter geht: textHtml (Absätze, Überschriften, Listen; die gerechneten Teile als leere Marken <div data-baustein="vorspann|vermieter|kostentabelle|ergebnis"></div>), Betreff, ob und von wem bearbeitet, die Abweichungen vom Standardtext und ob der Text nach einer Neuberechnung zu prüfen ist.Betriebskosten:UpdateBearbeiten

GET /api/v1/partner/betriebskostenabrechnungen/:objektNr/:jahr/abrechnungen/:abrechnungId/text

Liest den Brieftext einer Betriebskostenabrechnung, wie er an den Mieter geht: textHtml (Absätze, Überschriften, Listen; die gerechneten Teile als leere Marken <div data-baustein="vorspann|vermieter|kostentabelle|ergebnis"></div>), Betreff, ob und von wem bearbeitet, die Abweichungen vom Standardtext und ob der Text nach einer Neuberechnung zu prüfen ist. editierbar/grund sagen, ob er sich noch ändern lässt (bis zur Freigabe des Eigentümers, nie nach dem Versand). Nennt den Mieter. Braucht Betriebskosten:Update.

Parameter von betriebskostenabrechnung_text_lesen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
abrechnungId PflichtintegerID aus betriebskostenabrechnung_lesen (abrechnungen[].abrechnungId).
betriebskostenabrechnung_text_setzenSchreibenErsetzt den Brieftext einer Betriebskostenabrechnung vollständig — vorher betriebskostenabrechnung_text_lesen und dessen textHtml als Grundlage nehmen.Betriebskosten:UpdateBearbeiten

PUT /api/v1/partner/betriebskostenabrechnungen/:objektNr/:jahr/abrechnungen/:abrechnungId/text

Ersetzt den Brieftext einer Betriebskostenabrechnung vollständig — vorher betriebskostenabrechnung_text_lesen und dessen textHtml als Grundlage nehmen. Erlaubt sind p, h2, h3, ul, ol, li, strong, em, u, br; alles andere fällt weg. Die vier Bausteinmarken müssen genau einmal und in dieser Reihenfolge stehen (vorspann, vermieter, kostentabelle, ergebnis), sonst 400; Zahlen lassen sich nicht schreiben. basiertAuf = bearbeitet.am aus dem Lesen (null beim Standardtext), sonst 409. Ist die Prüfung der Akte begonnen, setzt das Speichern sie zurück. Keine Beträge oder Fristen zusagen, die die Abrechnung nicht trägt. Braucht Betriebskosten:Update.

Parameter von betriebskostenabrechnung_text_setzen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
abrechnungId PflichtintegerID aus betriebskostenabrechnung_lesen.
html PflichtstringDer vollständige Brieftext mit den vier Bausteinmarken.
betreffbeliebigEigener Betreff; leer oder null = Standardbetreff.
basiertAuf Pflichtbeliebigbearbeitet.am aus betriebskostenabrechnung_text_lesen, null beim Standardtext.
betriebskostenabrechnung_text_zuruecksetzenLöschenVerwirft den bearbeiteten Text einer Betriebskostenabrechnung; sie wird wieder vollständig erzeugt.Betriebskosten:UpdateBearbeiten

DELETE /api/v1/partner/betriebskostenabrechnungen/:objektNr/:jahr/abrechnungen/:abrechnungId/text

Verwirft den bearbeiteten Text einer Betriebskostenabrechnung; sie wird wieder vollständig erzeugt. Nur bis zur Freigabe des Eigentümers. Braucht Betriebskosten:Update.

Parameter von betriebskostenabrechnung_text_zuruecksetzen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
abrechnungId PflichtintegerID aus betriebskostenabrechnung_lesen.
betriebskostenabrechnung_text_uebertragenSchreibenÜberträgt den bearbeiteten Text einer Betriebskostenabrechnung auf die übrigen Abrechnungen derselben Akte (Objekt und Jahr).Betriebskosten:UpdateBearbeiten

POST /api/v1/partner/betriebskostenabrechnungen/:objektNr/:jahr/abrechnungen/:abrechnungId/text/uebertragen

Überträgt den bearbeiteten Text einer Betriebskostenabrechnung auf die übrigen Abrechnungen derselben Akte (Objekt und Jahr). Anredezeile und Grußformel bleiben je Mieter die eigenen. Abrechnungen mit eigenem Text bleiben, außer ersetzen=true; nicht mehr bearbeitbare werden mit Grund übersprungen. Nennt der Text Beträge oder den Namen des Mieters, wird nichts übertragen (409). Antwort: uebertragen, uebersprungen. Braucht Betriebskosten:Update.

Parameter von betriebskostenabrechnung_text_uebertragen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
abrechnungId PflichtintegerID der Abrechnung mit dem bearbeiteten Text.
ersetzenbooleanAuch Abrechnungen mit eigenem Text überschreiben. Vorgabe false.
zieleListe (integer)Nur diese Abrechnungen (IDs aus uebersprungen); sonst alle der Akte.
jahresabrechnung_text_lesenLesenLiest den Brieftext einer Hausgeld-Einzelabrechnung, wie er an den Eigentümer geht: textHtml (Absätze, Überschriften, Listen; die gerechneten Teile als leere Marken <div data-baustein="vorspann|beschlussstand|zusammenfassung"></div>), Betreff, ob und von wem bearbeitet, die Abweichungen vom Standardtext, ob der Text nach einer Neuberechnung zu prüfen ist, ob die Abrechnung beschlossen ist.Jahresabrechnung:TextBearbeiten

GET /api/v1/partner/jahresabrechnungen/:objektNr/:jahr/abrechnungen/:abrechnungId/text

Liest den Brieftext einer Hausgeld-Einzelabrechnung, wie er an den Eigentümer geht: textHtml (Absätze, Überschriften, Listen; die gerechneten Teile als leere Marken <div data-baustein="vorspann|beschlussstand|zusammenfassung"></div>), Betreff, ob und von wem bearbeitet, die Abweichungen vom Standardtext, ob der Text nach einer Neuberechnung zu prüfen ist, ob die Abrechnung beschlossen ist. editierbar/grund sagen, ob er sich noch ändern lässt (nur bis zum Vorlegen; danach festgeschrieben). Nennt den Eigentümer. abrechnungId steht in jahresabrechnung_lesen (einheiten[].abrechnungId). Braucht Jahresabrechnung:Text.

Parameter von jahresabrechnung_text_lesen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
abrechnungId PflichtstringID aus jahresabrechnung_lesen (einheiten[].abrechnungId).
jahresabrechnung_text_setzenSchreibenErsetzt den Brieftext einer Hausgeld-Einzelabrechnung vollständig — vorher jahresabrechnung_text_lesen und dessen textHtml als Grundlage nehmen.Jahresabrechnung:TextBearbeiten

PUT /api/v1/partner/jahresabrechnungen/:objektNr/:jahr/abrechnungen/:abrechnungId/text

Ersetzt den Brieftext einer Hausgeld-Einzelabrechnung vollständig — vorher jahresabrechnung_text_lesen und dessen textHtml als Grundlage nehmen. Erlaubt sind p, h2, h3, ul, ol, li, strong, em, u, br; alles andere fällt weg. Die drei Bausteinmarken müssen genau einmal und in dieser Reihenfolge stehen (vorspann, beschlussstand, zusammenfassung), sonst 400; Zahlen lassen sich nicht schreiben. Zeitlos schreiben: Der Satz zur Versammlung wechselt mit dem Beschluss von allein, der eigene Text nicht. basiertAuf = bearbeitet.am aus dem Lesen (null beim Standardtext), sonst 409. Nach dem Vorlegen 409. Das Speichern setzt die Prüfung des Beirats nicht zurück. Keine Beträge oder Fristen zusagen, die die Abrechnung nicht trägt. Braucht Jahresabrechnung:Text.

Parameter von jahresabrechnung_text_setzen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
abrechnungId PflichtstringID aus jahresabrechnung_lesen.
html PflichtstringDer vollständige Brieftext mit den drei Bausteinmarken.
betreffbeliebigEigener Betreff; leer oder null = Standardbetreff.
basiertAuf Pflichtbeliebigbearbeitet.am aus jahresabrechnung_text_lesen, null beim Standardtext.
jahresabrechnung_text_zuruecksetzenLöschenVerwirft den bearbeiteten Text einer Hausgeld-Einzelabrechnung; sie wird wieder vollständig erzeugt.Jahresabrechnung:TextBearbeiten

DELETE /api/v1/partner/jahresabrechnungen/:objektNr/:jahr/abrechnungen/:abrechnungId/text

Verwirft den bearbeiteten Text einer Hausgeld-Einzelabrechnung; sie wird wieder vollständig erzeugt. Nur bis zum Vorlegen. Braucht Jahresabrechnung:Text.

Parameter von jahresabrechnung_text_zuruecksetzen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
abrechnungId PflichtstringID aus jahresabrechnung_lesen.
jahresabrechnung_text_uebertragenSchreibenÜberträgt den bearbeiteten Text einer Hausgeld-Einzelabrechnung auf die übrigen Abrechnungen derselben Akte (Objekt und Jahr).Jahresabrechnung:TextBearbeiten

POST /api/v1/partner/jahresabrechnungen/:objektNr/:jahr/abrechnungen/:abrechnungId/text/uebertragen

Überträgt den bearbeiteten Text einer Hausgeld-Einzelabrechnung auf die übrigen Abrechnungen derselben Akte (Objekt und Jahr). Die Anrede wird je Eigentümer ersetzt. Abrechnungen mit eigenem Text bleiben, außer ersetzen=true. Nennt der Text Beträge oder den Namen des Eigentümers, wird nichts übertragen (409). Antwort: uebertragen, uebersprungen. Braucht Jahresabrechnung:Text.

Parameter von jahresabrechnung_text_uebertragen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
abrechnungId PflichtstringID der Abrechnung mit dem bearbeiteten Text.
ersetzenbooleanAuch Abrechnungen mit eigenem Text überschreiben. Vorgabe false.
zieleListe (string)Nur diese Abrechnungen (IDs aus uebersprungen); sonst alle der Akte.
betriebskostenabrechnung_freigabe_zurueckziehenSchreibenHolt die Anfrage an den Eigentümer zur Freigabe einer Betriebskostenabrechnung zurück — etwa um den Text zu ändern.Betriebskosten:EntscheidenBearbeiten · nur persönlich

POST /api/v1/partner/betriebskostenabrechnungen/:objektNr/:jahr/abrechnungen/:abrechnungId/freigabe-zurueckziehen

Holt die Anfrage an den Eigentümer zur Freigabe einer Betriebskostenabrechnung zurück — etwa um den Text zu ändern. Nur solange kein Eigentümer abgestimmt hat (sonst 409 mit Grund); die Einladungen verlieren ihre Gültigkeit, die Freigabe wird danach in der Akte neu angefordert. Nur über den persönlichen KI-Zugang. Braucht Betriebskosten:Entscheiden.

Parameter von betriebskostenabrechnung_freigabe_zurueckziehen
ParameterTypBeschreibung
objektNr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerAbrechnungsjahr.
abrechnungId PflichtintegerID aus betriebskostenabrechnung_lesen.
heizkostenabrechnungen_auflistenLesenListet die Heizkostenabrechnungen eines Jahres je Haus (Jahr = Jahr, in dem die Heizperiode endet).Heizkosten:ReadLesen mit Kontaktdaten

GET /api/v1/partner/heizkosten

Listet die Heizkostenabrechnungen eines Jahres je Haus (Jahr = Jahr, in dem die Heizperiode endet). zeilen: je Haus die Periode (von, bis, periode_id), weg (selbst: immoGenio rechnet aus Kosten und Verbrauch; messdienst: die Beträge je Einheit stammen aus der Abrechnung des Messdiensts), status (entwurf, berechnet, versandt), die fünf Schritte (Kosten, Verbrauch bzw. Beträge des Messdiensts, Berechnung, CO₂-Aufteilung, Versand) mit Stand, der nächste Schritt als Text, die Summe der Kosten in Euro und frist (spätester Zugang der Betriebskostenabrechnung bei gleichem Zeitraum). nicht_angelegt: Häuser mit einer früheren Periode oder Heizkostenverteilern, für die es im Jahr noch keine Akte gibt, samt Vorlage wie im Vorjahr. Braucht Heizkosten:Read.

Parameter von heizkostenabrechnungen_auflisten
ParameterTypBeschreibung
jahr PflichtintegerJahr, in dem die Heizperiode endet.
heizkostenabrechnung_lesenLesenLiest die Heizkostenabrechnung eines Hauses für ein Jahr als Akte: Periode (mit periode_id, weg, status, Grundanteil), Kosten-positionen mit Warmwasseranteil, je Einheit Fläche, Mieter, Tage ohne Mieter, Verbrauch für Heizung und Warmwasser mit Herkunft (zaehler, altbestand, hand, geschaetzt; wert null = fehlt) und — wenn berechnet — die Einzelabrechnung (Grund- und Verbrauchs-anteile, CO₂-Abzug des Vermieters, gesamt) sowie den Vorjahresbetrag.Heizkosten:ReadLesen mit Kontaktdaten

GET /api/v1/partner/heizkosten/:objekt_nr/:jahr

Liest die Heizkostenabrechnung eines Hauses für ein Jahr als Akte: Periode (mit periode_id, weg, status, Grundanteil), Kosten-positionen mit Warmwasseranteil, je Einheit Fläche, Mieter, Tage ohne Mieter, Verbrauch für Heizung und Warmwasser mit Herkunft (zaehler, altbestand, hand, geschaetzt; wert null = fehlt) und — wenn berechnet — die Einzelabrechnung (Grund- und Verbrauchs-anteile, CO₂-Abzug des Vermieters, gesamt) sowie den Vorjahresbetrag. schritte nennen je Schritt, was fehlt (fehlt) und worauf zu achten ist (hinweise). Ohne Periode im Jahr: periode null und vorlage mit dem Zeitraum wie im Vorjahr. Beträge in Euro. Beim weg selbst zusätzlich abrechnung (Konzept 204): anlage (Energieträger, Warmwasser-Ermittlung, Grundanteile, Gradtagstabelle, wasser_abrechnen; id null = noch Vorgabe), je Einheit die Geräte (zaehler_id, Raum, Faktor, Stand, Einheiten, Herkunft, Schätzmethode) und die Nutzer mit Zeitanteilen (§ 9b) und ihrem Ergebnis, die Töpfe, Preise je Einheit, Rundungsrest und befunde (ton fehlt hält das Berechnen auf). Diese Zahlen sind eine Vorschau, bis die Abrechnung berechnet ist. Braucht Heizkosten:Read.

Parameter von heizkostenabrechnung_lesen
ParameterTypBeschreibung
objekt_nr PflichtintegerObjekt-Nr. (Ganzzahl).
jahr PflichtintegerJahr, in dem die Heizperiode endet.
verbrauchsinformation_zustellung_lesenLesenZeigt für einen Monat, ob jede Einheit ihre monatliche Verbrauchsinformation (§ 6a HeizkostenV) bekommen hat.Heizkosten:ReadLesen mit Kontaktdaten

GET /api/v1/partner/verbrauchsinformation

Zeigt für einen Monat, ob jede Einheit ihre monatliche Verbrauchsinformation (§ 6a HeizkostenV) bekommen hat. Je Einheit: stand (zugestellt, offen, keine_pflicht), grund bei offen (post_ohne_postweg: nur per Brief erreichbar, aber der Postweg des Mandanten ist aus; keine_adresse: weder Konto noch Mail noch Anschrift; briefdienst_fehlt: Briefversand nicht eingerichtet; brief_fehlgeschlagen: der Briefdienst hat den Brief nicht angenommen; zur_druckliste: Brief wartet auf Druck und Markierung im Cockpit; vor_briefweg: Brief für einen Monat vor dem Start des Briefwegs, geht nur auf Klick (verbrauchsinformation_zustellen) hinaus; mail_fehlgeschlagen: Mailserver hat die Adresse abgelehnt; mailversand_aus; kein_empfaenger: Einheit einer Gemeinschaft ohne Eigentümer; noch_nicht_zugestellt; keine_verknuepfung: kein Funkgerät an der Einheit; keine_zaehlerstaende), zustellweg (mieterportal, email, papier) und versendet_am, uvi_id und der empfaenger (art mieter oder eigentuemer, id, name, kommunikation, konto, hat_email — ohne die Adresse selbst). Empfänger ist der Mieter am Monatsletzten, in einer Gemeinschaft der Eigentümer. Ohne monat der zuletzt abgeschlossene Monat. Korrigieren: Mail-Adresse oder kommunikation mit mieter_aktualisieren bzw. eigentuemer_aktualisieren, danach verbrauchsinformation_zustellen. Braucht Heizkosten:Read.

Parameter von verbrauchsinformation_zustellung_lesen
ParameterTypBeschreibung
monatstringMonat als YYYY-MM, z. B. 2026-10.
objekt_nrintegerNur dieses Objekt (optional).
verbrauchsinformation_zustellenSchreibenStellt eine offene Verbrauchsinformation jetzt zu, nach einer Korrektur (Mail-Adresse ergänzt, Weg umgestellt) — statt im nächsten Nachtlauf, und auch für ältere Monate, die der Nachtlauf nicht mehr nachholt.Heizkosten:UpdateBearbeiten

POST /api/v1/partner/verbrauchsinformation/:uvi_id/zustellen

Stellt eine offene Verbrauchsinformation jetzt zu, nach einer Korrektur (Mail-Adresse ergänzt, Weg umgestellt) — statt im nächsten Nachtlauf, und auch für ältere Monate, die der Nachtlauf nicht mehr nachholt. Weg: Mieter mit Konto im Mieterportal, sonst Mail mit den Werten. Antwort: zugestellt true mit weg, oder false mit grund (wie bei verbrauchsinformation_zustellung_lesen). Schon zugestellt oder eigener Versand des Mandanten ausgeschaltet: 409. uvi_id aus verbrauchsinformation_zustellung_lesen. Braucht Heizkosten:Update.

Parameter von verbrauchsinformation_zustellen
ParameterTypBeschreibung
uvi_id Pflichtstringuvi_id aus verbrauchsinformation_zustellung_lesen.
heizkosten_verbrauch_eintragenSchreibenTrägt den Verbrauch einer Einheit in einer Heizkostenperiode ein, wenn er nicht aus Zählerständen kommt: art heizung (Einheiten am Heizkostenverteiler bzw. kWh am Wärmezähler, wie die übrigen Einheiten des Hauses) oder warmwasser (m³).Heizkosten:UpdateBearbeiten

POST /api/v1/partner/heizkosten/perioden/:periode_id/verbrauch/schaetzen

Trägt den Verbrauch einer Einheit in einer Heizkostenperiode ein, wenn er nicht aus Zählerständen kommt: art heizung (Einheiten am Heizkostenverteiler bzw. kWh am Wärmezähler, wie die übrigen Einheiten des Hauses) oder warmwasser (m³). schaetzen=true schätzt stattdessen nach dem Verbrauch des Vorjahres, klimabereinigt, und vermerkt die Schätzung (ohne Vorjahreswert: 409). wert null nimmt eine Eingabe zurück — dann gilt wieder der Zählerstand. Eine Ablesung mit Datum gehört dagegen an den Zähler (zaehlerstand_eintragen). Eine berechnete Abrechnung wird dadurch wieder zum Entwurf; eine versandte lässt sich nicht ändern (409). Nur bei weg selbst. periode_id und einheit_id aus heizkostenabrechnung_lesen. Braucht Heizkosten:Update.

Parameter von heizkosten_verbrauch_eintragen
ParameterTypBeschreibung
periode_id Pflichtintegerperiode.id aus heizkostenabrechnung_lesen.
einheit_id PflichtstringUUID der Einheit (z. B. aus der jeweiligen Liste).
artheizung | warmwasser
wertbeliebigVerbrauch im Zeitraum; null nimmt die Eingabe zurück. Nicht zusammen mit schaetzen (Fehler).
schaetzenbooleanNach Vorjahr schätzen statt einen Wert zu setzen.
notizbeliebigz. B. „laut Messdienst-Liste vom 14.01.“
heizkosten_messdienst_uebernehmenSchreibenÜbernimmt die Beträge je Einheit aus der Abrechnung des Messdiensts (Heizkosten und Warmwasserkosten in Euro je Einheit) in eine Heizkostenperiode mit weg messdienst.Heizkosten:UpdateBearbeiten

PUT /api/v1/partner/heizkosten/perioden/:periode_id/messdienst

Übernimmt die Beträge je Einheit aus der Abrechnung des Messdiensts (Heizkosten und Warmwasserkosten in Euro je Einheit) in eine Heizkostenperiode mit weg messdienst. Ersetzt einen früheren Stand vollständig — immer alle Einheiten schicken. Danach rechnet der CO₂-Abzug mit, und die Abrechnung steht auf berechnet; als versandt vermerkt ein Mensch im Portal. Weicht die Summe von den erfassten Kosten ab, nennt die Akte das als Hinweis. Bei weg selbst oder versandter Abrechnung: 409. Braucht Heizkosten:Update.

Parameter von heizkosten_messdienst_uebernehmen
ParameterTypBeschreibung
periode_id Pflichtintegerperiode.id aus heizkostenabrechnung_lesen.
betraege PflichtListe (object)
heizkosten_anlage_setzenSchreibenSetzt Heizungsanlage und Abrechnungsregeln einer selbst gerechneten Heizkostenabrechnung (Konzept 204).Heizkosten:UpdateBearbeiten

PUT /api/v1/partner/heizkosten/perioden/:periode_id/anlage

Setzt Heizungsanlage und Abrechnungsregeln einer selbst gerechneten Heizkostenabrechnung (Konzept 204). Gespeichert wird eine Fassung ab Beginn dieser Periode — die Maßstäbe ändern sich nur zum Beginn eines Abrechnungszeitraums (§ 6 Abs. 4 HeizkostenV); spätere Perioden behalten ihren bisherigen Stand. Immer alle Felder schicken (vorher heizkostenabrechnung_lesen, abrechnung.anlage). ww_ermittlung waermezaehler braucht ww_zaehler_id (abrechnung.waermezaehler); die Formeln brauchen ww_begruendung, warum der Wärmezähler nicht nutzbar ist. gradtage_promille: zwölf Monatswerte mit Summe 1000. Eine berechnete Abrechnung wird wieder zum Entwurf; eine versandte lässt sich nicht ändern (409). Braucht Heizkosten:Update.

Parameter von heizkosten_anlage_setzen
ParameterTypBeschreibung
periode_id Pflichtintegerperiode.id aus heizkostenabrechnung_lesen.
energietraeger Pflichterdgas | fluessiggas | heizoel | fernwaerme | pellets | waermepumpe | strom | sonstige
brennwertbezug PflichtbooleanErdgas brennwertbezogen abgerechnet: Wärmemenge aus den Formeln × 1,11; beim Wärmezähler ohne Wirkung (§ 9 Abs. 2 HeizkostenV).
verbunden PflichtbooleanHeizung und Warmwasser aus einer Anlage.
messart_heizung Pflichtheizkostenverteiler | waermezaehler
ww_ermittlung Pflichtwaermezaehler | formel_volumen | formel_flaeche
ww_zaehler_id Pflichtbeliebig
ww_temperatur PflichtnumberNur formel_volumen: mittlere Warmwassertemperatur in °C.
ww_begruendung Pflichtbeliebig
grund_heizung PflichtintegerGrundkosten Heizung in Prozent, Rest nach Verbrauch.
grund_warmwasser Pflichtinteger
flaechenbezug Pflichtwohnflaeche | beheizt
gradtage_promille PflichtListe (number)
wasser_abrechnen PflichtbooleanKalt- und Abwasser nach Zähler mit abrechnen (Schlüssel wasserabrechnung).
verteiler_skalaeinheit | produkteinheit: Heizkostenverteiler zeigen Rohwerte, gerechnet wird Ablesewert × Bewertungsfaktor. produkt: sie zeigen schon bewertete Einheiten, kein Faktor. Ein Funkgerät mit eigener Skala geht vor. Fehlt die Angabe, bleibt die gespeicherte.
heizkosten_geraet_eintragenSchreibenTrägt für ein Messgerät einer selbst gerechneten Heizkostenabrechnung den Stand zum Ende der Periode ein, wenn er nicht aus dem Zählerregister kommt (Konzept 204).Heizkosten:UpdateBearbeiten

PUT /api/v1/partner/heizkosten/perioden/:periode_id/geraete/:zaehler_id

Trägt für ein Messgerät einer selbst gerechneten Heizkostenabrechnung den Stand zum Ende der Periode ein, wenn er nicht aus dem Zählerregister kommt (Konzept 204). Heizkostenverteiler: Ablesewert (Striche bzw. Skalenteile, ohne Faktor); Warm- und Kaltwasserzähler: Verbrauch im Zeitraum in m³. herkunft geschaetzt verlangt methode nach § 9a HeizkostenV (vorjahr, vergleichbare_raeume, gebaeudedurchschnitt) — Vorschläge liefert heizkosten_schaetzung_vorschlagen; die Methode steht im Dokument. wert null nimmt die Eingabe zurück. Eine Ablesung mit Datum gehört dagegen an den Zähler (zaehlerstand_eintragen). zaehler_id aus heizkostenabrechnung_lesen (abrechnung.einheiten[].geraete). Braucht Heizkosten:Update.

Parameter von heizkosten_geraet_eintragen
ParameterTypBeschreibung
periode_id Pflichtinteger
zaehler_id PflichtstringUUID des Geräts (z. B. aus der jeweiligen Liste).
wert Pflichtbeliebig
herkunfthand | geschaetzt
methodevorjahr | vergleichbare_raeume | gebaeudedurchschnitt | null
notizbeliebig
heizkosten_schaetzung_vorschlagenLesenSchlägt für ein Gerät ohne Wert Schätzungen nach § 9a HeizkostenV vor: Verbrauch desselben Geräts im Vorjahr, Mittel vergleichbarer Räume im Haus, Durchschnitt des Gebäudes je m².Heizkosten:ReadLesen mit Kontaktdaten

GET /api/v1/partner/heizkosten/perioden/:periode_id/geraete/:zaehler_id/schaetzung

Schlägt für ein Gerät ohne Wert Schätzungen nach § 9a HeizkostenV vor: Verbrauch desselben Geräts im Vorjahr, Mittel vergleichbarer Räume im Haus, Durchschnitt des Gebäudes je m². Jeder Vorschlag nennt wert (Ablesewert bzw. m³), einheiten und die Begründung; ein Vorschlag ohne Grundlage fehlt. Schreibt nichts — übernommen wird mit heizkosten_geraet_eintragen. Braucht Heizkosten:Read.

Parameter von heizkosten_schaetzung_vorschlagen
ParameterTypBeschreibung
periode_id Pflichtinteger
zaehler_id PflichtstringUUID des Geräts (z. B. aus der jeweiligen Liste).
heizkosten_faktor_setzenSchreibenSetzt den Bewertungsfaktor eines Heizkostenverteilers (Ablesewert × Faktor = Einheiten).Heizkosten:UpdateBearbeiten

PUT /api/v1/partner/heizkosten/geraete/:zaehler_id/faktor

Setzt den Bewertungsfaktor eines Heizkostenverteilers (Ablesewert × Faktor = Einheiten). ziel heizkoerper: am Heizkörper, an dem der Verteiler hängt — die Regel, der Faktor bleibt beim Gerätetausch erhalten; ziel zaehler: nur an diesem Verteiler, als Abweichung (faktor null nimmt sie zurück). Jede berechnete, nicht versandte Heizkostenabrechnung des Hauses wird wieder zum Entwurf. Braucht Heizkosten:Update.

Parameter von heizkosten_faktor_setzen
ParameterTypBeschreibung
zaehler_id PflichtstringUUID des Heizkostenverteilers (z. B. aus der jeweiligen Liste).
faktor Pflichtbeliebig
zielheizkoerper | zaehler
heizkosten_dienstkunde_anlegenSchreibenLegt im Unternehmen des angefragten Mandanten einen Heizkosten-Mandanten an: ein Haus, das eine andere Verwaltung betreut und für das das Unternehmen nur die Heizkosten abrechnet (leistungsumfang heizkosten — kein Kontenrahmen, keine Buchhaltung, keine Versammlungen).Heizkostendienst:AnlegenBearbeiten · nur persönlich

POST /api/v1/partner/heizkosten/dienstkunden

Legt im Unternehmen des angefragten Mandanten einen Heizkosten-Mandanten an: ein Haus, das eine andere Verwaltung betreut und für das das Unternehmen nur die Heizkosten abrechnet (leistungsumfang heizkosten — kein Kontenrahmen, keine Buchhaltung, keine Versammlungen). Mit dem Haus (objekt), optional seinen Wohnungen (einheiten) und dem Auftrag (Auftraggeber, Beginn, Kauf oder Miete der Geräte); ohne Angaben beginnt der Auftrag heute, Geräte gekauft. Die Antwort nennt die id des neuen Mandanten — danach Parameter mandant der anderen Tools. Nur, wenn das Unternehmen einen Auftritt für Heizkosten führt (sonst 409 mit Weg), nur persönlich mit Freigabe für alle Mandanten, nur wer zum Team gehört. Ein Haus aus einer Datei der Verwaltung legt man im Portal an (Datenaustausch › Lieferung › „Als Heizkosten-Mandant anlegen“). Braucht Heizkostendienst:Anlegen.

Parameter von heizkosten_dienstkunde_anlegen
ParameterTypBeschreibung
art Pflichtweg | eigentuemerEine Eigentümergemeinschaft oder ein Vermieter.
name PflichtstringName des Mandanten, z. B. "WEG Lindenweg 12".
objekt PflichtobjectDas Haus.
einheitenListe (object)Die Wohnungen des Hauses; fehlen sie, legt man sie später mit einheit_anlegen an.
auftragobjectDer Auftrag. Fehlt er, gelten die Vorgaben.
heizkosten_auftrag_lesenLesenLiest den Auftrag eines Heizkosten-Mandanten: Auftraggeber (Verwaltung, Gemeinschaft oder Vermieter, Firma, Ansprechpartner), Beginn, Erstlaufzeit, Kündigungsfrist, Vorgabe Kauf oder Miete der Geräte samt Zahl je Eigentum, Kündigung (Eingang, von wem, endet_zum).Heizkosten:ReadLesen mit Kontaktdaten

GET /api/v1/partner/heizkosten/auftrag

Liest den Auftrag eines Heizkosten-Mandanten: Auftraggeber (Verwaltung, Gemeinschaft oder Vermieter, Firma, Ansprechpartner), Beginn, Erstlaufzeit, Kündigungsfrist, Vorgabe Kauf oder Miete der Geräte samt Zahl je Eigentum, Kündigung (Eingang, von wem, endet_zum). 404 in einem Mandanten ohne Auftrag (kein Heizkosten-Mandant). Braucht Heizkosten:Read.

heizkosten_auftrag_setzenSchreibenÄndert den Auftrag eines Heizkosten-Mandanten — nur die gesendeten Felder.Heizkosten:UpdateBearbeiten

PATCH /api/v1/partner/heizkosten/auftrag

Ändert den Auftrag eines Heizkosten-Mandanten — nur die gesendeten Felder. Ist schon gekündigt, rechnet der Server endet_zum neu (das spätere von Erstlaufzeit und Eingang plus Frist). Die Kündigung selbst ist ein Schritt im Lebenszyklus des Mandanten und geht nur im Portal. Rollen, die auf einzelne Objekte begrenzt sind, ändern den Auftrag nicht (403). Braucht Heizkosten:Update.

Parameter von heizkosten_auftrag_setzen
ParameterTypBeschreibung
auftraggeber_artverwaltung | gemeinschaft | vermieter
firma_idbeliebigDie Verwaltung als Firma (firmen_auflisten); null entfernt sie.
ansprechpartner_namebeliebig
ansprechpartner_emailbeliebig
ansprechpartner_telefonbeliebig
beginnstring
erstlaufzeit_bisbeliebigEnde der Erstlaufzeit (höchstens zwei Jahre nach Beginn).
kuendigungsfrist_monateinteger
geraete_vorgabekauf | miete
notizbeliebig
heizkosten_nutzer_lesenLesenLiest die Nutzer einer Heizkostenperiode je Einheit (periode_id aus heizkostenabrechnung_lesen): art (nutzer, leerstand), Name, Mail-Adresse, Anschrift, Zeitraum, Vorauszahlungen und ob die Zeile aus einer Datei der Verwaltung stammt.Heizkosten:ReadLesen mit Kontaktdaten

GET /api/v1/partner/heizkosten/perioden/:periode_id/nutzer

Liest die Nutzer einer Heizkostenperiode je Einheit (periode_id aus heizkostenabrechnung_lesen): art (nutzer, leerstand), Name, Mail-Adresse, Anschrift, Zeitraum, Vorauszahlungen und ob die Zeile aus einer Datei der Verwaltung stammt. bearbeitbar false mit grund, wenn die Liste nicht von Hand gepflegt werden kann (kein Heizkosten-Mandant, Periode versandt). Braucht Heizkosten:Read.

Parameter von heizkosten_nutzer_lesen
ParameterTypBeschreibung
periode_id PflichtintegerHeizkostenperiode (heizkostenabrechnung_lesen).
heizkosten_nutzer_setzenSchreibenSetzt die Nutzer EINER Einheit in einer Heizkostenperiode — immer die ganze Liste: Zeilen, die fehlen, werden gelöscht; vorhandene Zeilen mit id mitschicken (heizkosten_nutzer_lesen).Heizkosten:UpdateBearbeiten

PUT /api/v1/partner/heizkosten/perioden/:periode_id/einheiten/:einheit_id/nutzer

Setzt die Nutzer EINER Einheit in einer Heizkostenperiode — immer die ganze Liste: Zeilen, die fehlen, werden gelöscht; vorhandene Zeilen mit id mitschicken (heizkosten_nutzer_lesen). Nur in Heizkosten-Mandanten (sonst 409). Die Zeiträume müssen die Periode lückenlos und ohne Überschneidung abdecken — sonst 422 mit den Lücken und dem Vorschlag, einen Leerstand zu ergänzen. Eine versandte Periode wird mit 409 abgewiesen. Mit funk_uebernehmen true trägt der Server am Wechseltag den Funk-Tageswert als Zwischenablesung ein. Die Abrechnung der Periode wird danach wieder zum Entwurf. Braucht Heizkosten:Update.

Parameter von heizkosten_nutzer_setzen
ParameterTypBeschreibung
periode_id PflichtintegerHeizkostenperiode (heizkostenabrechnung_lesen).
einheit_id PflichtstringUUID der Einheit (z. B. aus der jeweiligen Liste).
nutzer PflichtListe (object)Alle Nutzer der Einheit in der Periode, zeitlich geordnet.
funk_uebernehmenbooleanAm Wechseltag den Funk-Tageswert als Zwischenablesung eintragen.
heizkosten_montageauftraege_auflistenLesenListet die Montageaufträge für Funk-Heizkostenverteiler eines Hauses: Installateur (Adresse, ob schon angemeldet), Termin, Stand (offen, in_arbeit, erledigt, storniert) und je Einheit, wie viele Heizkörper schon ein Gerät haben.Heizkostenmontage:ReadLesen mit Kontaktdaten

GET /api/v1/partner/objekte/:objekt_nr/heizkosten-montageauftraege

Listet die Montageaufträge für Funk-Heizkostenverteiler eines Hauses: Installateur (Adresse, ob schon angemeldet), Termin, Stand (offen, in_arbeit, erledigt, storniert) und je Einheit, wie viele Heizkörper schon ein Gerät haben. offen true zeigt nur laufende Aufträge. Montiert wird in der Heizkosten-App, nicht hier. Braucht Heizkostenmontage:Read.

Parameter von heizkosten_montageauftraege_auflisten
ParameterTypBeschreibung
objekt_nr PflichtintegerNummer des Hauses (aus objekte_auflisten).
offenboolean
funk_empfang_lesenLesenZeigt, wie gut die Funkgeräte (Heizkostenverteiler, Wasser- und Wärmezähler) eines Hauses empfangen werden.Funkempfang:ReadLesen

GET /api/v1/partner/objekte/:objekt_nr/funk-empfang

Zeigt, wie gut die Funkgeräte (Heizkostenverteiler, Wasser- und Wärmezähler) eines Hauses empfangen werden. haus: montiert, gut (Geräte mit Wert an mindestens 90 % der Tage seit Montage, höchstens 30 — also 27 von 30), quote in Prozent, heute_empfangen, verstummt (seit 3 Tagen still), nie_empfangen (24 Stunden nach Montage ohne Wert). geraete: je Gerät id (wie in der Liste der Funkgeräte), streifen der letzten 30 Tage (wert, fehlt, vor = vor der Montage), empfangen/moeglich, laengste_luecke in Tagen (90 Tage zurück) und rssi_median in dBm. gateways: je Gateway streifen der Erreichbarkeit, neustarts_heute, neustarts_7_tage, batterie_schwach (niedrigste Spannung an zwei Tagen hintereinander unter 3,3 V) und die Tagesbilanz (Kontakte, Telegramme, Neustarts, niedrigste Spannung in Millivolt, Mobilfunksignal wie vom Gerät gemeldet), dazu bezeichnung, meldetakt und einstellungen (soll = im Cockpit eingestellt, ist = vom Gerät gemeldet, stand wartet/uebernommen/abgelehnt). Keine Rohtelegramme. Braucht Funkempfang:Read.

Parameter von funk_empfang_lesen
ParameterTypBeschreibung
objekt_nr PflichtintegerNummer des Hauses (aus objekte_auflisten).
funk_gateway_einstellungen_setzenSchreibenStellt an einem Funk-Gateway (Lobaro über MQTT) ein, wann und wie lange es täglich zuhört und welche Hersteller es hört.Funkgateway:UpdateBearbeiten

PUT /api/v1/partner/objekte/:objekt_nr/funk-gateways/:gateway_id/einstellungen

Stellt an einem Funk-Gateway (Lobaro über MQTT) ein, wann und wie lange es täglich zuhört und welche Hersteller es hört. Das Gerät holt die Einstellungen beim nächsten Tagesstatus und startet danach neu; bis dahin steht einstellungen.stand auf wartet (funk_empfang_lesen). Übernimmt das Gerät sie dreimal nicht, gilt abgelehnt, und die Verwaltung bekommt einen Hinweis. empfangszeit HH:MM, empfangsdauer_min 10–60 (die Heizkostenverteiler senden alle 7,5 Minuten), herstellerfilter leer = alle Hersteller; mit Filter erscheinen fremde Geräte anderer Hersteller nicht mehr. Verbindung, Server und APN lassen sich hier nicht ändern. gateway_id aus funk_empfang_lesen. Braucht Funkgateway:Update.

Parameter von funk_gateway_einstellungen_setzen
ParameterTypBeschreibung
objekt_nr PflichtintegerNummer des Hauses (aus objekte_auflisten).
gateway_id PflichtstringID des Gateways (aus funk_empfang_lesen, gateways[].id).
empfangszeit PflichtstringUhrzeit des täglichen Empfangs, HH:MM.
empfangsdauer_min PflichtintegerDauer des Empfangs in Minuten.
herstellerfilterListe (string)Herstellerkennungen aus drei Buchstaben (z. B. QDS für Qundis); leer = alle.
heizkosten_montageauftrag_anlegenSchreibenVergibt einen Montageauftrag für Funk-Heizkostenverteiler an einen Betrieb aus dem Dienstleister-Verzeichnis: ein Haus, eine oder mehrere Einheiten, ein gemeinsamer Termin mit Zeitfenster (termin, zeit_von, zeit_bis) für alle Einheiten; nur eine Einheit, die an einem anderen Tag oder zu einer anderen Zeit dran ist, bekommt ihren eigenen.Heizkostenmontage:CreateBearbeiten · nur persönlich

POST /api/v1/partner/objekte/:objekt_nr/heizkosten-montageauftraege

Vergibt einen Montageauftrag für Funk-Heizkostenverteiler an einen Betrieb aus dem Dienstleister-Verzeichnis: ein Haus, eine oder mehrere Einheiten, ein gemeinsamer Termin mit Zeitfenster (termin, zeit_von, zeit_bis) für alle Einheiten; nur eine Einheit, die an einem anderen Tag oder zu einer anderen Zeit dran ist, bekommt ihren eigenen. VORHER den Betrieb mit dienstleister_auflisten suchen und, falls er fehlt, mit dienstleister_anlegen anlegen (mit E-Mail-Adresse) — an diese Adresse geht die Einladung in die Heizkosten-App (heizkosten.immogenio.de), wenn sie im Mandanten noch kein Konto hat. Dort erfasst der Installateur Heizkörper, scannt die Geräte und tauscht Geräte anderer Messdienste mit Endstand. Nur über den persönlichen KI-Zugang. Braucht Heizkostenmontage:Create.

Parameter von heizkosten_montageauftrag_anlegen
ParameterTypBeschreibung
objekt_nr Pflichtinteger
einheiten PflichtListe (object)
dienstleister_id PflichtstringUUID des Dienstleisters, der den Auftrag ausführt (z. B. aus der jeweiligen Liste).
terminbeliebigJJJJ-MM-TT, gemeinsamer Termin aller Einheiten.
zeit_vonbeliebigHH:MM, Beginn des Zeitfensters am gemeinsamen Termin — damit kein Bewohner den ganzen Tag wartet.
zeit_bisbeliebigHH:MM, Ende des Zeitfensters; nur mit zeit_von.
hinweisbeliebig
heizkosten_montageauftrag_wieder_oeffnenSchreibenÖffnet einen abgeschlossenen Montageauftrag (Stand erledigt) wieder, zum Beispiel wenn bei der Montage Heizkörper vergessen wurden: Der Stand geht zurück auf in_arbeit, der Betrieb sieht den Auftrag wieder offen in seiner App, trägt das Fehlende nach und schließt erneut ab.Heizkostenmontage:UpdateBearbeiten

POST /api/v1/partner/objekte/:objekt_nr/heizkosten-montageauftraege/:auftrag_id/wieder-oeffnen

Öffnet einen abgeschlossenen Montageauftrag (Stand erledigt) wieder, zum Beispiel wenn bei der Montage Heizkörper vergessen wurden: Der Stand geht zurück auf in_arbeit, der Betrieb sieht den Auftrag wieder offen in seiner App, trägt das Fehlende nach und schließt erneut ab. Montierte Geräte bleiben unverändert. Ein zurückgezogener Auftrag lässt sich nicht öffnen; steht eine seiner Einheiten inzwischen in einem anderen offenen Auftrag, kommt 409 — dann dort nachtragen. Den Auftrag liefert heizkosten_montageauftraege_auflisten. Braucht Heizkostenmontage:Update.

Parameter von heizkosten_montageauftrag_wieder_oeffnen
ParameterTypBeschreibung
objekt_nr Pflichtinteger
auftrag_id Pflichtintegerid des Auftrags aus heizkosten_montageauftraege_auflisten.
heizkosten_austausch_lieferungen_auflistenLesenListet die Lieferungen des Datenaustauschs der Heizkostenabrechnung nach bved/ARGE 3.10 (dritte Erweiterung vom 10.09.2025): eingelesene Dateien einer Verwaltung (richtung ein, wir sind Messdienst: DTM310/DTK310) oder eines Messdiensts (Ergebnis DTD310, Nummern DTA310) und selbst erzeugte (richtung aus).Heizkostenaustausch:ReadLesen mit Kontaktdaten

GET /api/v1/partner/heizkosten/austausch/lieferungen

Listet die Lieferungen des Datenaustauschs der Heizkostenabrechnung nach bved/ARGE 3.10 (dritte Erweiterung vom 10.09.2025): eingelesene Dateien einer Verwaltung (richtung ein, wir sind Messdienst: DTM310/DTK310) oder eines Messdiensts (Ergebnis DTD310, Nummern DTA310) und selbst erzeugte (richtung aus). Je Lieferung Stand (vorschau, teilweise, uebernommen, verworfen, erzeugt), Partner, Kundennummer, Dateien und je Liegenschaftsnummer, ob das Haus übernommen ist. Lieferungen gehören dem ganzen Unternehmen — nur ohne Objektgrenze. Braucht Heizkostenaustausch:Read.

heizkosten_austausch_einlesenSchreibenLiest Dateien nach bved/ARGE 3.10 ein (höchstens 10, je bis 20 MB, Inhalt als Base64 der rohen Bytes — nicht als Text dekodieren, die Dateien sind ISO 8859-15).Heizkostenaustausch:UpdateBearbeiten

POST /api/v1/partner/heizkosten/austausch/lieferungen

Liest Dateien nach bved/ARGE 3.10 ein (höchstens 10, je bis 20 MB, Inhalt als Base64 der rohen Bytes — nicht als Text dekodieren, die Dateien sind ISO 8859-15). Eine ZIP des Messdiensts darf unverändert hinein: Sie wird ausgepackt, die PDF je Nutzer (E898) werden bei der Übernahme an der Abrechnung abgelegt. Legt eine Lieferung an und antwortet mit der Vorschau je Haus: abweichungen in den Gruppen muss (vor dem Übernehmen klären), aenderung (Vorgabe behalten), neu und nicht (wird nicht übernommen), dazu stand (Fingerabdruck, nötig für heizkosten_austausch_haus_uebernehmen). Nichts wird übernommen. Häuser anderer Mandanten zählt verborgen. Gibt es zur Kundennummer noch keinen Partner, legt ihn ein Mensch im Cockpit an. Braucht Heizkostenaustausch:Update.

Parameter von heizkosten_austausch_einlesen
ParameterTypBeschreibung
dateien PflichtListe (object)
heizkosten_austausch_vorschauLesenVorschau einer Lieferung je Haus (Liegenschaftsnummer): sichtbarkeit (hier, anderer_mandant, ohne_zuordnung), Objekt, vorschlaege für die Zuordnung, abweichungen mit id, gruppe, titel, text, alt/neu, wahlen und wahl, satz (Satzart, Zeile, Feld, Stellen, roh = der ganze Satz), bei einem Nutzerwechsel die Funkwerte der Zwischenablesung, und stand.Heizkostenaustausch:ReadLesen mit Kontaktdaten

GET /api/v1/partner/heizkosten/austausch/lieferungen/:lieferung_id/vorschau

Vorschau einer Lieferung je Haus (Liegenschaftsnummer): sichtbarkeit (hier, anderer_mandant, ohne_zuordnung), Objekt, vorschlaege für die Zuordnung, abweichungen mit id, gruppe, titel, text, alt/neu, wahlen und wahl, satz (Satzart, Zeile, Feld, Stellen, roh = der ganze Satz), bei einem Nutzerwechsel die Funkwerte der Zwischenablesung, und stand. befunde nennt Formfehler der Dateien mit Zeile und Feld. Braucht Heizkostenaustausch:Read.

Parameter von heizkosten_austausch_vorschau
ParameterTypBeschreibung
lieferung_id PflichtintegerID des Datensatzes.
heizkosten_austausch_entscheidenSchreibenEntscheidet eine Abweichung der Vorschau: wahl uebernehmen oder behalten (Änderungen; Vorgabe behalten — nie still überschreiben), leerstand (Lücke zwischen zwei Nutzern als Leerstand), zuordnen mit einheit_id (Wohnungsnummer der Verwaltung → Einheit; die Nummer wird unsere, Konzept 211 E15).Heizkostenaustausch:UpdateBearbeiten

PUT /api/v1/partner/heizkosten/austausch/lieferungen/:lieferung_id/entscheidungen

Entscheidet eine Abweichung der Vorschau: wahl uebernehmen oder behalten (Änderungen; Vorgabe behalten — nie still überschreiben), leerstand (Lücke zwischen zwei Nutzern als Leerstand), zuordnen mit einheit_id (Wohnungsnummer der Verwaltung → Einheit; die Nummer wird unsere, Konzept 211 E15). Antwortet mit der neuen Vorschau. Braucht Heizkostenaustausch:Update.

Parameter von heizkosten_austausch_entscheiden
ParameterTypBeschreibung
lieferung_id PflichtintegerID des Datensatzes.
liegenschaft_nr PflichtstringLiegenschaftsnummer des Hauses aus der Vorschau.
abweichung_id Pflichtstringid der Abweichung aus der Vorschau.
wahl Pflichtuebernehmen | behalten | leerstand | zuordnen
einheit_idstringUUID der Einheit (nur bei wahl zuordnen) (z. B. aus der jeweiligen Liste).
heizkosten_austausch_haus_zuordnenSchreibenOrdnet ein Haus der Lieferung einem Objekt dieses Mandanten zu.Heizkostenaustausch:UpdateBearbeiten

POST /api/v1/partner/heizkosten/austausch/lieferungen/:lieferung_id/haeuser/:liegenschaft_nr/zuordnen

Ordnet ein Haus der Lieferung einem Objekt dieses Mandanten zu. Als Messdienst vergeben wir die Liegenschaftsnummer, wenn die Datei 000000000 trägt; beim fremden Messdienst gilt seine Nummer. Gilt danach für jede Datei dieses Partners. Antwortet mit der neuen Vorschau. Braucht Heizkostenaustausch:Update.

Parameter von heizkosten_austausch_haus_zuordnen
ParameterTypBeschreibung
lieferung_id PflichtintegerID des Datensatzes.
liegenschaft_nr Pflichtstring
objekt_nr PflichtintegerObjekt-Nr. (Ganzzahl).
heizkosten_austausch_haus_uebernehmenSchreibenÜbernimmt ein Haus der Lieferung in einer Transaktion: Richtung A (Datei einer Verwaltung) Periode, Nutzer mit Zeiträumen, Kosten, Brennstoff und CO₂-Angaben, Wärmezähler, Zwischenablesungen aus Funk; Richtung B (Ergebnis eines Messdiensts) die Beträge je Nutzer, CO₂ aus dem D-Satz, Wohnungsnummern.Heizkostenaustausch:UpdateBearbeiten

POST /api/v1/partner/heizkosten/austausch/lieferungen/:lieferung_id/haeuser/:liegenschaft_nr/uebernehmen

Übernimmt ein Haus der Lieferung in einer Transaktion: Richtung A (Datei einer Verwaltung) Periode, Nutzer mit Zeiträumen, Kosten, Brennstoff und CO₂-Angaben, Wärmezähler, Zwischenablesungen aus Funk; Richtung B (Ergebnis eines Messdiensts) die Beträge je Nutzer, CO₂ aus dem D-Satz, Wohnungsnummern. Nur mit dem stand der zuletzt gelesenen Vorschau — hat sich seither etwas geändert, 409 und erneut heizkosten_austausch_vorschau lesen. 409 auch, solange Abweichungen der Gruppe muss offen sind. Braucht Heizkostenaustausch:Update.

Parameter von heizkosten_austausch_haus_uebernehmen
ParameterTypBeschreibung
lieferung_id PflichtintegerID des Datensatzes.
liegenschaft_nr Pflichtstring
stand Pflichtstringstand des Hauses aus der Vorschau.
heizkosten_austausch_ergebnis_erzeugenSchreibenErzeugt das Ergebnis einer berechneten Heizkostenabrechnung für die Verwaltung (wir sind Messdienst): DTD310 je Nutzer und Kostenart (Vorgabe des Partners, sonst 234 Heizung, 235 Warmwasser, 236 Wasser, 230 Gesamt mit Vorauszahlung, Saldo und CO₂), DTA310 mit unseren Nummern zu den Kennungen der Verwaltung, DTE835 nur, wenn die Verwaltung den Lohnanteil verlangt hat, DTE898 mit PDF je Nutzer.Heizkostenaustausch:UpdateBearbeiten

POST /api/v1/partner/heizkosten/austausch/perioden/:periode_id/ergebnis

Erzeugt das Ergebnis einer berechneten Heizkostenabrechnung für die Verwaltung (wir sind Messdienst): DTD310 je Nutzer und Kostenart (Vorgabe des Partners, sonst 234 Heizung, 235 Warmwasser, 236 Wasser, 230 Gesamt mit Vorauszahlung, Saldo und CO₂), DTA310 mit unseren Nummern zu den Kennungen der Verwaltung, DTE835 nur, wenn die Verwaltung den Lohnanteil verlangt hat, DTE898 mit PDF je Nutzer. Antwortet mit den Dateien als Base64 (ohne PDF). Hinaus schickt sie ein Mensch. Braucht Heizkostenaustausch:Update.

Parameter von heizkosten_austausch_ergebnis_erzeugen
ParameterTypBeschreibung
periode_id Pflichtintegerperiode.id aus heizkostenabrechnung_lesen.
kostenartenListe (230 | 234 | 235 | 236)
e835boolean
pdfboolean
heizkosten_austausch_stammdaten_erzeugenSchreibenErzeugt für eine Heizkostenabrechnung mit weg messdienst die Dateien für den Messdienst (wir sind Verwaltung): DTM310 mit Liegenschaft und Nutzern samt Zeiträumen, DTK310 mit Brennstoff, Wärmezähler und Kosten samt CO₂.Heizkostenaustausch:UpdateBearbeiten

POST /api/v1/partner/heizkosten/austausch/perioden/:periode_id/stammdaten

Erzeugt für eine Heizkostenabrechnung mit weg messdienst die Dateien für den Messdienst (wir sind Verwaltung): DTM310 mit Liegenschaft und Nutzern samt Zeiträumen, DTK310 mit Brennstoff, Wärmezähler und Kosten samt CO₂. Vergibt beim ersten Mal Wohnungsnummern und Kennungen der Nutzer (IG + 8 Ziffern) und behält sie. Braucht die Liegenschaftsnummer des Messdiensts am Haus (sonst 409). Antwortet mit den Dateien als Base64. Braucht Heizkostenaustausch:Update.

Parameter von heizkosten_austausch_stammdaten_erzeugen
ParameterTypBeschreibung
periode_id Pflichtinteger

[10]14 Tools

Dienstleister, Anliegen und Versicherungsfälle

gewerke_auflistenLesenListet die Gewerke (Leistungsbereiche) des Mandanten — Sanitär, Heizung, Dach usw. IMMER ZUERST aufrufen, bevor ein Dienstleister angelegt oder ein Pool abgefragt wird: Die gewerkId ist eine UUID und lässt sich sonst nicht ermitteln.Dienstleister:ReadLesen

GET /api/v1/partner/gewerke

Listet die Gewerke (Leistungsbereiche) des Mandanten — Sanitär, Heizung, Dach usw. IMMER ZUERST aufrufen, bevor ein Dienstleister angelegt oder ein Pool abgefragt wird: Die gewerkId ist eine UUID und lässt sich sonst nicht ermitteln.

dienstleister_auflistenLesenListet die Handwerks- und Dienstleistungsbetriebe des Mandanten, filterbar nach Gewerk, Objekt-Nr., aktiv/inaktiv und Suchtext (Name, Ansprechpartner, Ort).Dienstleister:ReadLesen

GET /api/v1/partner/dienstleister

Listet die Handwerks- und Dienstleistungsbetriebe des Mandanten, filterbar nach Gewerk, Objekt-Nr., aktiv/inaktiv und Suchtext (Name, Ansprechpartner, Ort). VOR JEDEM ANLEGEN mit suche=<Firmenname> prüfen: Zwei Datensätze für denselben Betrieb machen den Pool schlechter, nicht größer. Ansprechpartner und Kontaktdaten erscheinen nur mit dem Scope Dienstleister:ReadPII; die interne Bewertung und Notiz des Verwalters liefert diese Strecke nie.

Parameter von dienstleister_auflisten
ParameterTypBeschreibung
gewerkIdstringUUID des Gewerks (aus gewerke_auflisten) (z. B. aus der jeweiligen Liste).
objektNrintegerObjekt-Nr. (Ganzzahl).
aktivtrue | falseNur aktive bzw. nur inaktive Betriebe.
suchestringFreitext in Name, Ansprechpartner und Ort.
dienstleister_lesenLesenLiefert einen Betrieb samt seiner Gewerk-Zuordnung.Dienstleister:ReadLesen

GET /api/v1/partner/dienstleister/:dienstleisterId

Liefert einen Betrieb samt seiner Gewerk-Zuordnung.

Parameter von dienstleister_lesen
ParameterTypBeschreibung
dienstleisterId PflichtstringUUID des Dienstleisters (z. B. aus der jeweiligen Liste).
dienstleister_poolLesenDie Betriebe eines Gewerks, die sich anschreiben lassen — geordnet nach Passung.Dienstleister:ReadLesen

GET /api/v1/partner/dienstleister/pool/:gewerkId

Die Betriebe eines Gewerks, die sich anschreiben lassen — geordnet nach Passung. Jede Zeile trägt stundensatz_cent, gebiet_treffer und passung_gruende (die Begründung der Reihenfolge im Klartext). `plz` (die Postleitzahl des Objekts) SORTIERT nur: Ein Betrieb ohne hinterlegtes Einsatzgebiet fällt dadurch nicht heraus. `nurNotdienst` und `maxStundensatzCent` FILTERN dagegen. Wer weder E-Mail noch Postanschrift hat, ist nie dabei — er wäre nicht erreichbar.

Parameter von dienstleister_pool
ParameterTypBeschreibung
gewerkId PflichtstringUUID des Gewerks (aus gewerke_auflisten) (z. B. aus der jeweiligen Liste).
objektNrintegerObjekt-Nr. (Ganzzahl).
plzstringPostleitzahl des Objekts, z. B. "63073". Sortiert nur.
nurNotdiensttrue | falseNur Betriebe mit Notdienst.
maxStundensatzCentintegerObergrenze des Stundensatzes in Cent (5800 = 58,00 EUR). Betriebe ohne hinterlegten Satz bleiben drin.
dienstleister_anlegenSchreibenLegt einen Handwerks- oder Dienstleistungsbetrieb an, samt Gewerk-Zuordnung.Dienstleister:CreateBearbeiten

POST /api/v1/partner/dienstleister

Legt einen Handwerks- oder Dienstleistungsbetrieb an, samt Gewerk-Zuordnung. VORHER dienstleister_auflisten mit suche=<Firmenname> aufrufen — eine Dublette macht den Pool schlechter, nicht größer. Bei kommunikation="email" (Vorgabe) ist email PFLICHT, sonst weist die Datenbank den Satz ab. Bewertung und interne Notiz lassen sich hier nicht setzen; Bank- und Kreditorendaten ebenfalls nicht.

Parameter von dienstleister_anlegen
ParameterTypBeschreibung
name PflichtstringFirmenname (Pflicht).
ansprechpartnerstringAnsprechpartner im Betrieb (Name). Er wird als Person des Unternehmens angelegt; der Dienstleister nennt nur den Verweis.
kommunikationemail | postZustellweg für Anschreiben. Vorgabe: email — dann ist eine E-Mail-Adresse Pflicht.
emailstringE-Mail-Adresse.
telefonstringFestnetz.
mobilstringMobilnummer.
strassestringStrasse und Hausnummer.
plzstringPostleitzahl.
ortstringOrt.
landstringLändercode, zwei Buchstaben (Vorgabe DE).
ustIdnrstringUmsatzsteuer-Identifikationsnummer.
steuernummerstringSteuernummer.
rechtsformbeliebigGesellschaftsform als Kürzel aus rechtsformen_auflisten (Feld code, z. B. "GmbH"). Ein anderer Wert wird mit 422 abgewiesen; null nimmt die Angabe weg.
aktivbooleanfalse legt den Betrieb still — er fällt aus jedem Pool, bleibt aber als Nachweis lesbar.
gewerkeListe (object)Die Leistungsbereiche. Ersetzt die Zuordnung vollständig.
dienstleister_aktualisierenSchreibenÄndert einen Betrieb — nur die übergebenen Felder.Dienstleister:UpdateBearbeiten

PATCH /api/v1/partner/dienstleister/:dienstleisterId

Ändert einen Betrieb — nur die übergebenen Felder. `gewerke` ersetzt die Zuordnung VOLLSTAENDIG: Wer sie schickt, schickt sie komplett.

Parameter von dienstleister_aktualisieren
ParameterTypBeschreibung
dienstleisterId PflichtstringUUID des Dienstleisters (z. B. aus der jeweiligen Liste).
namestringFirmenname.
ansprechpartnerstringAnsprechpartner im Betrieb (Name). Er wird als Person des Unternehmens angelegt; der Dienstleister nennt nur den Verweis.
kommunikationemail | postZustellweg für Anschreiben. Vorgabe: email — dann ist eine E-Mail-Adresse Pflicht.
emailstringE-Mail-Adresse.
telefonstringFestnetz.
mobilstringMobilnummer.
strassestringStrasse und Hausnummer.
plzstringPostleitzahl.
ortstringOrt.
landstringLändercode, zwei Buchstaben (Vorgabe DE).
ustIdnrstringUmsatzsteuer-Identifikationsnummer.
steuernummerstringSteuernummer.
rechtsformbeliebigGesellschaftsform als Kürzel aus rechtsformen_auflisten (Feld code, z. B. "GmbH"). Ein anderer Wert wird mit 422 abgewiesen; null nimmt die Angabe weg.
aktivbooleanfalse legt den Betrieb still — er fällt aus jedem Pool, bleibt aber als Nachweis lesbar.
gewerkeListe (object)Die Leistungsbereiche. Ersetzt die Zuordnung vollständig.
dienstleister_leistungen_setzenSchreibenSetzt die Preisliste eines Betriebs — Stundensätze, Pauschalen, Positionen nach Aufwand.Dienstleister:UpdateBearbeiten

PUT /api/v1/partner/dienstleister/:dienstleisterId/leistungen

Setzt die Preisliste eines Betriebs — Stundensätze, Pauschalen, Positionen nach Aufwand. ERSETZT VOLLSTAENDIG, was der Verwalter gepflegt hat; Zeilen, die der Betrieb selbst über seine Selbstauskunft gemeldet hat, bleiben unberührt. Beträge in CENT und NETTO (5800 = 58,00 EUR). Ausser bei abrechnungsart="nach_aufwand" ist betragCent Pflicht.

Parameter von dienstleister_leistungen_setzen
ParameterTypBeschreibung
dienstleisterId PflichtstringUUID des Dienstleisters (z. B. aus der jeweiligen Liste).
leistungen PflichtListe (object)Die vollständige Preisliste.
dienstleister_einladenSchreibenErzeugt einen Onboarding-Link, über den der Betrieb seine Leistungen, Stundensätze, sein Einsatzgebiet und seine Nachweise SELBST einträgt — ohne Konto.Dienstleister:InviteBearbeiten

POST /api/v1/partner/dienstleister/:dienstleisterId/einladung

Erzeugt einen Onboarding-Link, über den der Betrieb seine Leistungen, Stundensätze, sein Einsatzgebiet und seine Nachweise SELBST einträgt — ohne Konto. Der Link gilt 60 Tage und ist mehrfach nutzbar. ES GEHT KEINE MAIL RAUS: Das Tool liefert den Link, verschickt ihn aber nicht — jeder Versand bleibt ein menschlicher Schritt. Geben Sie den Link an den Betrieb weiter oder nutzen Sie den Einladungs-Dialog in der Konsole. Die eingereichten Angaben werden erst wirksam, wenn ein Mensch sie in der Konsole uebernimmt.

Parameter von dienstleister_einladen
ParameterTypBeschreibung
dienstleisterId PflichtstringUUID des Dienstleisters (z. B. aus der jeweiligen Liste).
empfaengerName PflichtstringAnsprechpartner oder Firmenname — steht später am Zugang.
empfaengerEmailstringAdresse für die Ablage am Zugang; ohne Angabe wird die des Betriebs vermerkt.
gueltigTageintegerAbweichende Gültigkeit in Tagen (Vorgabe 60).
versicherungsfaelle_auflistenLesenListet die Versicherungsfälle des Mandanten: Sach- und Haftpflichtschäden gegenüber dem Versicherer.Versicherungsfall:ReadLesen

GET /api/v1/partner/versicherungsfaelle

Listet die Versicherungsfälle des Mandanten: Sach- und Haftpflichtschäden gegenüber dem Versicherer. Je Fall Nummer (VF-JJJJ-NNNNNN), Art, Gefahr, Schadentag, Objekt, Versicherer, Schadennummer, Stand des Weges (erfasst, gemeldet, in_regulierung, rueckfrage_offen, abgerechnet, abgeschlossen …), nächste Frist und Meldetag. q sucht in Nummer, Beschreibung, Schadennummer, Objekt und Versicherer — der Weg, eine Mail des Versicherers ihrem Fall zuzuordnen. Braucht Versicherungsfall:Read.

Parameter von versicherungsfaelle_auflisten
ParameterTypBeschreibung
objekt_nrintegerObjekt-Nr. (Ganzzahl).
artsachschaden | haftpflichtSachschaden oder Haftpflichtfall.
zustandstringoffen, beendet oder ein einzelner Stand (z. B. gemeldet).
vertrag_nrintegerNur Fälle an diesem Versicherungsvertrag.
qstringFreitext: Fallnummer, Schadennummer, Beschreibung, Objekt, Versicherer.
limitintegerEinträge je Seite.
offsetintegerVersatz zum Blättern.
versicherungsfall_detailsLesenDie Akte eines Versicherungsfalls: Schaden, Vertrag und Versicherer, betroffene Einheiten mit Regulierungsweg, Meldungen samt Beleg, Verlauf mit Fristen, Dokumente und Geld (Forderung auf 1302, Zahlungen, offene Weiterleitungen).Versicherungsfall:ReadLesen

GET /api/v1/partner/versicherungsfaelle/:id

Die Akte eines Versicherungsfalls: Schaden, Vertrag und Versicherer, betroffene Einheiten mit Regulierungsweg, Meldungen samt Beleg, Verlauf mit Fristen, Dokumente und Geld (Forderung auf 1302, Zahlungen, offene Weiterleitungen). Ohne Versicherungsfall:ReadPII fehlen Namen, Kontakte, Hergang und Verlaufstexte. Braucht Versicherungsfall:Read.

Parameter von versicherungsfall_details
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
dienstleister_vorschlagLesenDer Auftragsvorschlag zu einer Schadensmeldung: das Gewerk (aus der Entscheidung der Verwaltung oder der Kategorie), die Betriebe des Mandanten in begründeter Reihenfolge (rang, gruende, hinweise — Objektzuordnung, Einsatzgebiet, bisherige Aufträge dieses Mandanten, Nachweise), den schon beauftragten Betrieb und, was an der Meldung fehlt (rueckfrage.fehlend mit vorformuliertem Text).Auftragsvorschlag:ReadLesen

GET /api/v1/partner/anfragen/:anfrageId/auftragsvorschlag

Der Auftragsvorschlag zu einer Schadensmeldung: das Gewerk (aus der Entscheidung der Verwaltung oder der Kategorie), die Betriebe des Mandanten in begründeter Reihenfolge (rang, gruende, hinweise — Objektzuordnung, Einsatzgebiet, bisherige Aufträge dieses Mandanten, Nachweise), den schon beauftragten Betrieb und, was an der Meldung fehlt (rueckfrage.fehlend mit vorformuliertem Text). Ohne Kontaktdaten — die liefert dienstleister_lesen. Beauftragt wird nicht über ein Tool. Braucht Auftragsvorschlag:Read und Dienstleister:Read.

Parameter von dienstleister_vorschlag
ParameterTypBeschreibung
anfrageId PflichtintegerID des Datensatzes.
anfrage_termine_auflistenLesenDie Terminabstimmung zu einer Anfrage: Zeitfenster, in denen der Mieter zu Hause ist (art=verfuegbarkeit), Terminvorschläge des Handwerkers (art=vorschlag) und der bestätigte Termin.Anfragetermin:ReadLesen

GET /api/v1/partner/anfragen/:anfrageId/termine

Die Terminabstimmung zu einer Anfrage: Zeitfenster, in denen der Mieter zu Hause ist (art=verfuegbarkeit), Terminvorschläge des Handwerkers (art=vorschlag) und der bestätigte Termin. Je Eintrag Beginn und Ende (UTC), Stand (offen, bestaetigt, abgelehnt, abgesagt, ueberholt, vergangen) und wer ihn angelegt hat (mieter, dienstleister, verwaltung). Ohne Namen. darf_aendern=false heißt: Zu diesem Anliegen kommt kein Handwerker mehr. Braucht Anfragetermin:Read.

Parameter von anfrage_termine_auflisten
ParameterTypBeschreibung
anfrageId PflichtintegerID des Datensatzes.
anfrage_kontext_lesenLesenDas Umfeld einer Anfrage, wie die Kontextleiste im Portal es zeigt: frühere Vorgänge derselben Einheit, Anlage oder Kategorie der letzten 24 Monate (mit Hinweis „wiederkehrend“ ab drei Meldungen binnen 12 Monaten und laufender Gewährleistung), weitere offene Anfragen derselben Person, die Anlage mit Wartungsstand (vorschlag=true: noch nicht zugeordnet), Versicherungsfälle und Beschlüsse zu Maßnahmen am Haus.Anfrage:ReadPIILesen mit Kontaktdaten

GET /api/v1/partner/anfragen/:anfrageId/kontext

Das Umfeld einer Anfrage, wie die Kontextleiste im Portal es zeigt: frühere Vorgänge derselben Einheit, Anlage oder Kategorie der letzten 24 Monate (mit Hinweis „wiederkehrend“ ab drei Meldungen binnen 12 Monaten und laufender Gewährleistung), weitere offene Anfragen derselben Person, die Anlage mit Wartungsstand (vorschlag=true: noch nicht zugeordnet), Versicherungsfälle und Beschlüsse zu Maßnahmen am Haus. Je Block nur mit dem passenden Scope (Anlage:Read, Versicherungsfall:Read, Beschluss:Read); ein Block ohne belegte Angaben fehlt, `fehlgeschlagen` nennt Blöcke, die sich nicht laden ließen. Policen, Instandhaltungsplan und Rückstand liefert dieses Tool nicht. Braucht Anfrage:ReadPII (Titel enthalten Namen).

Parameter von anfrage_kontext_lesen
ParameterTypBeschreibung
anfrageId PflichtintegerID des Datensatzes.
anfrage_zeitfenster_eintragenSchreibenTrägt für den Mieter bis zu fünf Zeitfenster ein, in denen er zu Hause ist — etwa nach einem Anruf.Anfragetermin:CreateBearbeiten

POST /api/v1/partner/anfragen/:anfrageId/termine/verfuegbarkeit

Trägt für den Mieter bis zu fünf Zeitfenster ein, in denen er zu Hause ist — etwa nach einem Anruf. Ersetzt seine offenen Fenster; offene Vorschläge des Handwerkers gelten damit als abgelehnt. Jedes Fenster liegt in der Zukunft und höchstens 60 Tage voraus. Steht schon ein bestätigter Termin, kommt 409. Der Eintrag ist als Verwaltung gekennzeichnet; der beauftragte Handwerker bekommt eine Mitteilung. Braucht Anfragetermin:Create.

Parameter von anfrage_zeitfenster_eintragen
ParameterTypBeschreibung
anfrageId PflichtintegerID des Datensatzes.
fenster PflichtListe (object)Die Zeitfenster.

[11]12 Tools

E-Mails und Aufgaben

mail_vorlagen_auflistenLesenListet die Mailvorlagen, die der Mensch hinter dem Zugang im Schreibfenster sieht: seine persönlichen, die des Unternehmens und die des Systems — zuletzt benutzte zuerst.Mailvorlage:ReadLesen mit Kontaktdaten

GET /api/v1/partner/mail-vorlagen

Listet die Mailvorlagen, die der Mensch hinter dem Zugang im Schreibfenster sieht: seine persönlichen, die des Unternehmens und die des Systems — zuletzt benutzte zuerst. Je Vorlage id, name, kuerzel, kategorie, betreff, bodyMd (Markdown mit Feldern wie {{empfaenger.anrede_zeile}}), geltung (persoenlich, unternehmen, system) und zuletztBenutztAt. Eine Vorlage mit demselben Kürzel auf einer näheren Ebene überdeckt die ferne und fehlt in der Liste. `q` sucht in Name, Kürzel, Kategorie, Betreff und Text. Nur lesend: anlegen, ändern und versenden geht hier nicht. Persönliche Vorlagen und Absenderfelder gehören dem Menschen hinter dem Zugang — beim persönlichen Zugang dem Angemeldeten, beim Token seinem Ersteller; ist der nicht mehr bekannt, antwortet der Server mit 403 ersteller_fehlt. Braucht den Scope Mailvorlage:Read (Stufe mit Kontaktdaten).

Parameter von mail_vorlagen_auflisten
ParameterTypBeschreibung
qstringSuchbegriff (optional).
mail_vorlage_fuellenLesenSetzt in eine Mailvorlage (id aus mail_vorlagen_auflisten) die bekannten Werte ein und liefert betreff, text (Markdown) und offen — die Felder, für die es keinen Wert gab.Mailvorlage:ReadLesen mit Kontaktdaten

POST /api/v1/partner/mail-vorlagen/:id/fuellen

Setzt in eine Mailvorlage (id aus mail_vorlagen_auflisten) die bekannten Werte ein und liefert betreff, text (Markdown) und offen — die Felder, für die es keinen Wert gab. Sie stehen im Text weiter als {{feld}}. Der Assistent muss offen prüfen: Er füllt die Felder selbst aus dem Gespräch oder fragt nach, bevor er den Text weitergibt; ein stehengebliebenes {{feld}} darf nie bei einem Empfänger ankommen. Optional `empfaenger` ({ art: mieter | eigentuemer | person | adresse, id }) für empfaenger.*, objekt.* und einheit.* sowie `vorgang` ({ art: mail | aufgabe | anfrage, id }) für vorgang.nummer und vorgang.datum. Der Absender (benutzer.*, Signatur) ist der Mensch hinter dem Zugang: beim persönlichen Zugang der Angemeldete, beim Token sein Ersteller — fehlt dessen Angabe im Profil, bleibt das Feld offen. Die Objektgrenze der Rolle gilt für den Empfänger: Wer nur außerhalb liegt, gibt es nicht (404). Nur eine Vorschau: Die Vorlage gilt dadurch nicht als „zuletzt benutzt“, und es wird nichts gespeichert oder versendet. Braucht den Scope Mailvorlage:Read.

Parameter von mail_vorlage_fuellen
ParameterTypBeschreibung
id PflichtintegerID der Vorlage (aus mail_vorlagen_auflisten).
empfaengerobjectDer Empfänger, dessen Werte eingesetzt werden (optional).
vorgangobjectDer Vorgang, auf den sich die Mail bezieht (optional).
aufgaben_auflistenLesenListet Aufgaben/Tasks des Mandanten (Titel, Status, Priorität, Fälligkeit, zugehöriges Objekt).Task:ReadLesen

GET /api/v1/partner/tasks

Listet Aufgaben/Tasks des Mandanten (Titel, Status, Priorität, Fälligkeit, zugehöriges Objekt). Filter: Status, Objekt-Nr., faellig bis Datum, zustaendig (me = der Mensch hinter dem persönlichen Zugang — mit einem API-Token abgewiesen —, eine Konto-ID oder ohne), beteiligt (Person des Unternehmens als Zahl, person:<id> für eine Person des Mandanten, firma:<id>) und kommunikation (antwort_da, antwort_ueberfaellig, wartet, versand_fehler). Beispiel: offene Aufgaben zu einem Objekt; Aufgaben, auf die eine Antwort überfällig ist.

Parameter von aufgaben_auflisten
ParameterTypBeschreibung
pageintegerSeitennummer (ab 1).
pageSizeintegerEinträge pro Seite (max. 200).
statustodo | in_progress | done | canceled | blockedNach Aufgabenstatus filtern.
objektNrintegerNur Aufgaben zu diesem Objekt (Objekt-Nr.).
faelligBisstringNur Aufgaben mit Fälligkeit bis einschliesslich diesem Tag (YYYY-MM-DD).
zustaendigstringme (nur persönlicher Zugang), ohne (niemand zuständig) oder die Konto-ID des Zuständigen.
beteiligtstringBeteiligte Person oder Firma: <id> der Person des Unternehmens, person:<id> (personen_auflisten) oder firma:<id>.
kommunikationantwort_da | antwort_ueberfaellig | wartet | versand_fehlerKommunikationsstand: Antwort eingegangen, Antwort überfällig, wartet auf Antwort, Versand gescheitert.
aufgabe_detailsLesenZeigt eine Aufgabe vollständig: Titel, Beschreibung, Status, Priorität, Fälligkeit, Objekt/Einheit/Mieter, die Checkliste (Unteraufgaben mit id, text, erledigt), alle Kommentare und den Verlauf (wer wann was geändert hat) sowie den Link ins Portal.Task:ReadLesen

GET /api/v1/partner/tasks/:id

Zeigt eine Aufgabe vollständig: Titel, Beschreibung, Status, Priorität, Fälligkeit, Objekt/Einheit/Mieter, die Checkliste (Unteraufgaben mit id, text, erledigt), alle Kommentare und den Verlauf (wer wann was geändert hat) sowie den Link ins Portal. Dazu die Beteiligten (Name, Funktion, Rollen im Mandanten, erreichbare Kanäle mit Grund), den Kommunikationsstand (antwort_da, antwort_ueberfaellig, wartet, versand_fehler, keine) und die zugeordneten Vorgänge des Postfachs — Quelle und Zeitpunkte, nie der Inhalt einer Nachricht. Die Aufgaben-id steht in aufgaben_auflisten. Als privat markierte Aufgaben sind nicht abrufbar. Braucht Task:Read.

Parameter von aufgabe_details
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
aufgabe_anlegenSchreibenLegt eine Aufgabe an, die im Portal unter „Anfragen & Aufgaben“ genauso erscheint wie eine von Hand angelegte.Task:CreateBearbeiten

POST /api/v1/partner/tasks

Legt eine Aufgabe an, die im Portal unter „Anfragen & Aufgaben“ genauso erscheint wie eine von Hand angelegte. Pflicht ist nur titel. Optional: beschreibung (Klartext, mehrzeilig mit \n), status (Vorgabe todo), prioritaet (none, low, medium, high, urgent; Vorgabe none), faelligkeit (YYYY-MM-DD), objektNr, einheitId, mieterId (aus objekte_auflisten, einheiten_auflisten, mieter_auflisten — jeder Bezug muss im Mandanten liegen, eine Einheit zum angegebenen Objekt gehören) und checkliste: eine Liste von {text, erledigt}, die als Unteraufgaben mit demselben Objekt/Einheit/Mieter angelegt werden. Für status blocked und canceled ist grund Pflicht. zustaendig: Konto-ID des Hauptzuständigen — geprüft nach den Zuweisungsregeln des Mandanten (sonst 403 mit Grund; ein API-Token weist nur zu, solange der Mandant keine Regeln führt), der Zuständige wird benachrichtigt. beteiligte: Personen und Firmen mit Funktion (melder, ansprechpartner, ausfuehrend, informieren), je Eintrag genau ein Verweis (personId, betriebPersonId, firmaId, mieterId, eigentuemerId, dienstleisterId). projektId und sektionId ordnen die Aufgabe ein (die Sektion bringt ihr Projekt mit). Antwort: id, titel, status, faelligkeit, link ins Portal und die Checkliste mit ihren ids. Beispiel: {"mandant":"immogenio-gmbh","titel":"Kaution Gräf WE 11","beschreibung":"Telefonat führen …","faelligkeit":"2026-10-30","objektNr":8,"checkliste":[{"text":"Telefonat mit Herrn Gräf"},{"text":"Mietkonto prüfen"}]}. Braucht Task:Create.

Parameter von aufgabe_anlegen
ParameterTypBeschreibung
titel PflichtstringKurzer Titel der Aufgabe.
beschreibungstringBeschreibung als Klartext oder Markdown, mehrzeilig erlaubt.
statustodo | in_progress | done | canceled | blockedAnfangsstand (Vorgabe todo). blocked und canceled brauchen grund.
grundstringPflicht bei status blocked oder canceled; steht im Verlauf.
prioritaetnone | low | medium | high | urgentPriorität (Vorgabe none).
faelligkeitstringFällig am (YYYY-MM-DD).
objektNrintegerObjekt-Nr. (Ganzzahl).
einheitIdstringUUID der Einheit (z. B. aus der jeweiligen Liste).
mieterIdstringUUID des Mieters (z. B. aus der jeweiligen Liste).
zustaendigintegerKonto-ID des Hauptzuständigen.
beteiligteListe (object)Beteiligte ohne Zuständigkeit (Melder, Ansprechpartner, ausführende Firma, wird informiert). Je Eintrag genau ein Verweis.
projektIdintegerProjekt der Aufgabe.
sektionIdintegerSektion im Projekt.
checklisteListe (object)Checklisten-Einträge (werden Unteraufgaben).
aufgabe_aktualisierenSchreibenÄndert eine Aufgabe; nur die gesendeten Felder werden geändert, null leert beschreibung, faelligkeit, objektNr, einheitId oder mieterId.Task:UpdateBearbeiten

PATCH /api/v1/partner/tasks/:id

Ändert eine Aufgabe; nur die gesendeten Felder werden geändert, null leert beschreibung, faelligkeit, objektNr, einheitId oder mieterId. status setzt den Stand über den Workflow (todo, in_progress, done, blocked, canceled); der Weg wird selbst gefunden. blocked und canceled brauchen grund. canceled ist endgültig — eine stornierte Aufgabe lässt sich nicht wieder öffnen (409). Löschen gibt es nicht: Wer eine Aufgabe nicht mehr braucht, storniert sie mit Grund. checkliste: Einträge mit id (aus aufgabe_details) werden geändert (text und/oder erledigt), Einträge ohne id werden angehängt, nicht genannte Einträge bleiben unverändert. zustaendig setzt den Hauptzuständigen (geprüft wie beim Anlegen), null nimmt alle Zuständigen weg; beteiligte kommen dazu (vorhandene bleiben); projektId/sektionId ordnen neu ein, ein neues Projekt ohne sektionId leert die Sektion. Antwort wie aufgabe_anlegen. Beispiel: {"mandant":"immogenio-gmbh","id":42,"status":"done","checkliste":[{"id":43,"erledigt":true}]}. Braucht Task:Update.

Parameter von aufgabe_aktualisieren
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
titelstringNeuer Titel.
beschreibungbeliebigNeue Beschreibung (ersetzt die alte vollständig); null leert sie.
statustodo | in_progress | done | canceled | blockedNeuer Stand.
grundstringPflicht bei status blocked oder canceled.
prioritaetnone | low | medium | high | urgentNeue Priorität.
faelligkeitbeliebigNeue Fälligkeit (YYYY-MM-DD); null entfernt sie.
objektNrbeliebigNeues Objekt (Objekt-Nr.); null löst die Verknüpfung.
einheitIdbeliebigNeue Einheit (UUID); null löst die Verknüpfung.
mieterIdbeliebigNeuer Mieter (UUID); null löst die Verknüpfung.
zustaendigbeliebigNeuer Hauptzuständiger (Konto-ID); null nimmt alle Zuständigen weg.
beteiligteListe (object)Beteiligte ohne Zuständigkeit (Melder, Ansprechpartner, ausführende Firma, wird informiert). Je Eintrag genau ein Verweis.
projektIdbeliebigNeues Projekt; null löst die Einordnung.
sektionIdbeliebigNeue Sektion; null löst sie.
checklisteListe (object)Einträge ändern (mit id) oder anhängen (ohne id, dann text Pflicht). Nicht genannte bleiben.
aufgabe_kommentar_anlegenSchreibenSchreibt eine interne Notiz an eine Aufgabe — etwa den Fortschritt oder das Ergebnis eines Telefonats.Task:CommentBearbeiten

POST /api/v1/partner/tasks/:id/kommentare

Schreibt eine interne Notiz an eine Aufgabe — etwa den Fortschritt oder das Ergebnis eines Telefonats. Sie erscheint im Portal bei den Kommentaren der Aufgabe (nur intern, nie für Mieter oder Dienstleister sichtbar) und ist mit dem Zugang als Autor gekennzeichnet. art: note (Vorgabe) oder comment. Kommentare lassen sich über das Tool nicht ändern oder löschen. Braucht Task:Comment.

Parameter von aufgabe_kommentar_anlegen
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
text PflichtstringText der Notiz.
artnote | commentArt des Kommentars (Vorgabe note).
emails_auflistenLesenListet die E-Mails im Eingang des Mandanten (Seite „E-Mail-Triage" und Postfach im Portal), neueste zuerst.Email:ReadLesen mit Kontaktdaten

GET /api/v1/partner/emails

Listet die E-Mails im Eingang des Mandanten (Seite „E-Mail-Triage" und Postfach im Portal), neueste zuerst. Für die Arbeitsliste ohneZuordnung="true" setzen: Das sind die Mails, die noch an keiner Anfrage, Schadensmeldung oder keinem Dienstleister hängen. `vorschau` sind die ersten 300 Zeichen — für eine Entscheidung IMMER email_lesen aufrufen. `kategorie` stammt bei neuen Mails aus einer Stichwortregel und ist nur ein erster Vorschlag. Stehen hier keine aktuellen Mails, liefert email_einliefern sie nach.

Parameter von emails_auflisten
ParameterTypBeschreibung
pageintegerSeitennummer (ab 1).
pageSizeintegerEinträge pro Seite (max. 200).
ohneZuordnungtrue | falsetrue = nur noch nicht zugeordnete Mails.
statusneu | gelesen | erledigt | ignoriertBearbeitungsstand.
kategoriemieter | versorger | hausverwaltung | versicherung | steuerberater | bank | rechnung | mahnung | behoerde | sonstiges | anfrage | schadensmeldung | dienstleister | werbungKategorie.
seitstringNur Mails ab diesem Tag (YYYY-MM-DD).
suchestringFreitext in Absender, Betreff und Mailtext.
email_lesenLesenLiefert eine E-Mail mit vollem Text und belegbaren Vorschlägen — PFLICHT vor jedem email_zuordnen.Email:ReadLesen mit Kontaktdaten

GET /api/v1/partner/emails/:id

Liefert eine E-Mail mit vollem Text und belegbaren Vorschlägen — PFLICHT vor jedem email_zuordnen. `vorschlaege` enthält: Dienstleister mit derselben Adresse (treffer="adresse") oder derselben Firmen-Domain (treffer="domain", Freemail-Domains ausgenommen), Mieter und Eigentümer mit derselben Adresse, offene Anfragen/Schadensmeldungen dieses Absenders und frühere Mails desselben Strangs samt ihrer Zuordnung. Hängt eine frühere Mail des Strangs schon an einer Anfrage, gehört die Folgemail meist dorthin (email_zuordnen mit anfrageId). `volltext=false` heisst: Es liegt nur ein Ausschnitt von rund 200 Zeichen vor — im Zweifel nicht zuordnen, sondern mit email_einordnen eine Notiz hinterlassen.

Parameter von email_lesen
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
email_einliefernSchreibenLegt eine E-Mail aus einem beliebigen Postfach (z. B. Gmail, IMAP) im Eingang des Mandanten ab, damit sie eingeordnet werden kann.Email:CreateBearbeiten

POST /api/v1/partner/emails

Legt eine E-Mail aus einem beliebigen Postfach (z. B. Gmail, IMAP) im Eingang des Mandanten ab, damit sie eingeordnet werden kann. nachrichtId ist die ID im Herkunftspostfach und schützt vor Dubletten: Dieselbe Mail ein zweites Mal liefert den vorhandenen Satz mit neu=false. text ist der Klartext der Mail ohne HTML. Die Antwort trägt die id für email_lesen und eine erste Stichwort-Kategorie. Es geht nichts raus und nichts wird angelegt.

Parameter von email_einliefern
ParameterTypBeschreibung
nachrichtId PflichtstringID der Nachricht im Herkunftspostfach (Gmail-ID oder Message-ID).
threadIdstringID des Gesprächsstrangs im Herkunftspostfach — verbindet Folgemails.
von PflichtstringAbsender wie im Kopf, z. B. "Max Muster <max@firma.de>".
anstringEmpfaenger.
betreffstringBetreff.
datum PflichtstringEingangszeitpunkt, ISO 8601 mit Zeitzone (z. B. 2026-09-17T08:15:00+02:00).
textstringMailtext als Klartext.
hatAnhangbooleanOb die Mail Anhänge hat.
email_einordnenSchreibenBeurteilt eine E-Mail, ohne etwas anzulegen: Kategorie, Priorität, Status, Aktion, Objekt, Notiz — nur die übergebenen Felder.Email:UpdateBearbeiten

PATCH /api/v1/partner/emails/:id

Beurteilt eine E-Mail, ohne etwas anzulegen: Kategorie, Priorität, Status, Aktion, Objekt, Notiz — nur die übergebenen Felder. Der Weg für alles, was keine Bearbeitung braucht (Werbung, Newsletter, reine Information → status="ignoriert" oder "erledigt") und für unklare Fälle (Notiz hinterlassen statt raten). objektNr=null hebt die Objekt-Zuordnung auf.

Parameter von email_einordnen
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
kategoriemieter | versorger | hausverwaltung | versicherung | steuerberater | bank | rechnung | mahnung | behoerde | sonstiges | anfrage | schadensmeldung | dienstleister | werbungKategorie.
prioritaethoch | mittel | niedrigPrioritaet.
statusneu | gelesen | erledigt | ignoriertBearbeitungsstand.
aktionzahlung_pruefen | weiterleiten | antworten | ablegen | keineNaechster Schritt.
objektNrbeliebigObjekt-Nr. (aus objekte_auflisten) oder null.
notizenbeliebigInterne Notiz; ersetzt die vorhandene.
email_zuordnenSchreibenHängt eine E-Mail an die Arbeit, zu der sie gehört.Email:AssignBearbeiten

POST /api/v1/partner/emails/:id/zuordnung

Hängt eine E-Mail an die Arbeit, zu der sie gehört. VORHER email_lesen. ziel="dienstleister": Angebot, Rechnung, Terminbestätigung oder Rückfrage eines Betriebs — dienstleisterId ist Pflicht; einen noch unbekannten Betrieb erst mit dienstleister_auflisten (suche) prüfen und sonst dienstleister_anlegen. Es entsteht nichts Neues. ziel="schadensmeldung": etwas ist kaputt, undicht, ausgefallen — legt eine Schadensmeldung an (Portal: Anfragen → Schadensmeldungen), der Absender wird als Melder eingetragen. ziel="anfrage": jedes andere Anliegen, das Bearbeitung braucht — legt eine Anfrage an. Bei beiden startet der Workflow wie bei einer im Portal angelegten Anfrage. Mit anfrageId wird statt dessen an eine VORHANDENE Anfrage gehängt — der richtige Weg für Folgemails. objektNr bzw. einheitId nur setzen, wenn sie aus der Mail oder den Vorschlägen belegt sind. ziel="versicherungsfall": Post des Versicherers, Maklers oder Anspruchstellers zu einem VORHANDENEN Versicherungsfall — versicherungsfallId ist Pflicht (aus versicherungsfaelle_auflisten, Suche nach Fall- oder Schadennummer). Anhänge aus dem Postfach werden Dokumente des Falls. Einen Fall legt kein Tool an, und gemeldet wird nur im Portal. ziel="aufgabe": die Mail gehört zu einer Aufgabe — mit aufgabeId an eine VORHANDENE Aufgabe (aufgaben_auflisten), ohne aufgabeId entsteht eine neue (titel, sonst der Betreff). Die Mail steht danach im Reiter „Kommunikation“ der Aufgabe. Dafür braucht der Zugang zusätzlich Task:Create (neue Aufgabe) bzw. Task:Update (vorhandene). Die Antwort trägt `pfad`, den Link ins Portal. Es geht keine Mail raus.

Parameter von email_zuordnen
ParameterTypBeschreibung
id PflichtintegerID des Datensatzes.
ziel Pflichtanfrage | schadensmeldung | dienstleister | versicherungsfall | aufgabeWohin die Mail gehoert.
aufgabeIdintegerNur bei ziel=aufgabe: vorhandene Aufgabe; ohne Angabe entsteht eine neue.
dienstleisterIdstringUUID des Dienstleisters (Pflicht bei ziel=dienstleister) (z. B. aus der jeweiligen Liste).
versicherungsfallIdintegerVorhandener Versicherungsfall (Pflicht bei ziel=versicherungsfall).
anfrageIdintegerVorhandene Anfrage/Schadensmeldung, an die die Mail gehängt wird (statt neu anzulegen).
titelstringTitel der neuen Anfrage; ohne Angabe der Betreff.
beschreibungstringBeschreibung der neuen Anfrage; ohne Angabe der Mailtext.
kategoriegeneral | hausmeister | complaint | question | otherNur bei ziel=anfrage: allgemein, Hausmeister-Thema, Beschwerde, Frage, Sonstiges. Vorgabe general.
prioritaetlow | medium | high | urgentPriorität der neuen Anfrage. Vorgabe medium.
objektNrintegerObjekt-Nr. (Ganzzahl).
einheitIdstringUUID der Einheit (aus einheiten_auflisten) (z. B. aus der jeweiligen Liste).
schadenKategoriesanitaer | heizung | elektrik | dach | fenster_tueren | schluessel | schimmel | garten | sonstigesNur bei ziel=schadensmeldung: Art des Schadens.
dringlichkeitakut | normal | geringNur bei ziel=schadensmeldung. akut = Wasser läuft, Heizung aus im Winter, Gefahr.

[12]7 Tools

Hausmeister: Termine, Aufträge, Nachrichten

hausmeister_termine_auflistenLesenListet die Termine der Hausmeister-App wie der Einsatzplan im Portal: je Termin id, Aufgabe, Haus (objekt_nr, objekt_name), Person, Fälligkeit, Stand (offen, in_arbeit, erledigt, nicht_moeglich), Zahl der Fotos, Herkunft eines Auftrags (anlass_art), dringend, abnahme_stand (geprueft oder nacharbeit) und braucht_verwaltung (nicht möglich ohne Ersatztermin oder wartende Nachricht).Hausmeister:ReadLesen mit Kontaktdaten

GET /api/v1/partner/hausmeister/termine

Listet die Termine der Hausmeister-App wie der Einsatzplan im Portal: je Termin id, Aufgabe, Haus (objekt_nr, objekt_name), Person, Fälligkeit, Stand (offen, in_arbeit, erledigt, nicht_moeglich), Zahl der Fotos, Herkunft eines Auftrags (anlass_art), dringend, abnahme_stand (geprueft oder nacharbeit) und braucht_verwaltung (nicht möglich ohne Ersatztermin oder wartende Nachricht). Ohne von/bis: heute und die nächsten 7 Tage plus alles Offene davor. Keine Quote je Person. Nur das Büro sieht sie — die Feldrolle liest ihre Termine in der Hausmeister-App. Die id ist der Parameter von hausmeister_termin_lesen. Braucht Hausmeister:Read.

Parameter von hausmeister_termine_auflisten
ParameterTypBeschreibung
vonstringJJJJ-MM-TT, Beginn des Fensters (Vorgabe heute).
bisstringJJJJ-MM-TT, Ende des Fensters (Vorgabe von + 7 Tage).
objekt_nrintegerNur Termine dieses Hauses.
hausmeister_idintegerNur Termine dieser Person.
artvorlage | einsatzvorlage = wiederkehrende Aufgaben, einsatz = Aufträge und Einsätze bei Bedarf.
hausmeister_termin_lesenLesenLiest einen Termin der Hausmeister-App mit Beschreibung, Notiz, Arbeitszeit, den Fotos (signierte Adressen, 5 Minuten gültig), Befunden und dem Verlauf (angelegt, in Arbeit, erledigt, geprüft, Nacharbeit, Korrektur durch den Betrieb).Hausmeister:ReadLesen mit Kontaktdaten

GET /api/v1/partner/hausmeister/termine/:id

Liest einen Termin der Hausmeister-App mit Beschreibung, Notiz, Arbeitszeit, den Fotos (signierte Adressen, 5 Minuten gültig), Befunden und dem Verlauf (angelegt, in Arbeit, erledigt, geprüft, Nacharbeit, Korrektur durch den Betrieb). letztes_mal nennt den vorigen erledigten Termin derselben Aufgabe (Tag, Notiz, Zahl der Fotos, ohne Namen; null bei Aufträgen). Nur das Büro. Braucht Hausmeister:Read.

Parameter von hausmeister_termin_lesen
ParameterTypBeschreibung
id PflichtintegerTermin-ID aus hausmeister_termine_auflisten.
hausmeister_auftrag_anlegenSchreibenErteilt einen Auftrag an den Hausmeister eines Hauses: ein einmaliger Termin mit Titel, Beschreibung und Herkunft, der in der Hausmeister-App erscheint und per Push gemeldet wird.Hausmeister:CreateBearbeiten

POST /api/v1/partner/hausmeister/auftraege

Erteilt einen Auftrag an den Hausmeister eines Hauses: ein einmaliger Termin mit Titel, Beschreibung und Herkunft, der in der Hausmeister-App erscheint und per Push gemeldet wird. Ohne hausmeister_id geht er an die erste Person mit aktivem Vertrag am Haus; gibt es keinen, antwortet die API 409 mit dem Weg (Hausmeister zuordnen). faellig_am nie vor heute. Die Erledigung kommt allein vor Ort aus der App, nie von hier. Braucht Hausmeister:Create.

Parameter von hausmeister_auftrag_anlegen
ParameterTypBeschreibung
objekt_nr PflichtintegerDas Haus (Objekt-Nr.).
titel PflichtstringWas zu tun ist, ohne Zeilenumbruch.
beschreibungstring
hausmeister_idintegerWer hingeht (aus hausmeister_termine_auflisten); ohne Angabe die Person am Haus.
faellig_amstringJJJJ-MM-TT, ohne Angabe heute.
dringendboolean
foto_pflichtbooleanFoto als Nachweis (Vorgabe an).
hausmeister_haus_uebernehmenSchreibenÜbergibt ein Haus mit allen Aufgaben an eine Person der Hausmeister-App: Danach führt sie das Haus, alle wiederkehrenden Aufgaben und Aufträge des Hauses hängen an ihr, und alle offenen Termine ohne Foto (auch überfällige) gehen mit.Hausmeister:UpdateBearbeiten

PUT /api/v1/partner/hausmeister/haeuser/:objekt_nr/fuehrung

Übergibt ein Haus mit allen Aufgaben an eine Person der Hausmeister-App: Danach führt sie das Haus, alle wiederkehrenden Aufgaben und Aufträge des Hauses hängen an ihr, und alle offenen Termine ohne Foto (auch überfällige) gehen mit. Begonnenes, Erledigtes und Fotos bleiben bei der bisherigen Person. Neue Aufgaben und Aufträge ohne ausdrückliche Person gehen danach an sie. Die Person muss das Haus schon betreuen (sonst 400); die hausmeister_id steht in hausmeister_termine_auflisten. Ändert keinen Stand und löscht nichts. Nur das Büro. Antwort: Zahl der umgehängten Aufgaben und Termine. Braucht Hausmeister:Update.

Parameter von hausmeister_haus_uebernehmen
ParameterTypBeschreibung
objekt_nr PflichtintegerDas Haus (Objekt-Nr.).
hausmeister_id PflichtintegerDie Person, die das Haus übernimmt.
vorort_nachrichten_auflistenLesenListet die Termine, zu denen vor Ort eine Nachricht auf Antwort der Verwaltung wartet (Fenster: 30 Tage zurück, 30 Tage voraus): je Termin id, Aufgabe, Haus, Person und Fälligkeit.VorOrt:ReadLesen mit Kontaktdaten · nur persönlich

GET /api/v1/partner/vorort/offen

Listet die Termine, zu denen vor Ort eine Nachricht auf Antwort der Verwaltung wartet (Fenster: 30 Tage zurück, 30 Tage voraus): je Termin id, Aufgabe, Haus, Person und Fälligkeit. Ändert keinen Lesestand. Die id ist der Parameter von vorort_strang_lesen (art=termin). Nur über den persönlichen KI-Zugang. Braucht VorOrt:Read.

vorort_strang_lesenLesenLiest den Nachrichtenstrang zwischen Verwaltung und vor Ort zu einem Termin (art=termin, id=Termin-ID), einem Haus (art=haus, id="<objekt_nr>:<hausmeister_id>") oder einer Übergabe (art=uebergabe, id=Übergabe-ID).VorOrt:ReadLesen mit Kontaktdaten · nur persönlich

GET /api/v1/partner/vorort/:art/:id

Liest den Nachrichtenstrang zwischen Verwaltung und vor Ort zu einem Termin (art=termin, id=Termin-ID), einem Haus (art=haus, id="<objekt_nr>:<hausmeister_id>") oder einer Übergabe (art=uebergabe, id=Übergabe-ID). Das Öffnen gilt als gelesen — deshalb nur über den persönlichen KI-Zugang. Antwort: Nachrichten mit Seite (verwaltung oder vor_ort), Text, Foto, Zeit und Lesestand. Braucht VorOrt:Read.

Parameter von vorort_strang_lesen
ParameterTypBeschreibung
art Pflichttermin | haus | uebergabe
id PflichtstringTermin-ID, "<objekt_nr>:<hausmeister_id>" oder Übergabe-ID.
vorort_nachricht_schreibenSchreibenSchreibt als Verwaltung an die Seite vor Ort (Hausmeister-App bzw. Übergabe-App).VorOrt:CreateBearbeiten · nur persönlich

POST /api/v1/partner/vorort/:art/:encodeURIComponent

Schreibt als Verwaltung an die Seite vor Ort (Hausmeister-App bzw. Übergabe-App). Der Text steht im Strang, bis er zurückgenommen wird; die Gegenseite erhält einen Hinweis. client_id ist eine selbst vergebene UUID — dieselbe ID legt keine zweite Nachricht an. Nur über den persönlichen KI-Zugang (403 nur_persoenlich bei einem Token), weil die Nachricht für einen Menschen steht. Keine Zusagen zu Kosten oder Terminen, die nicht abgestimmt sind. Braucht VorOrt:Create.

Parameter von vorort_nachricht_schreiben
ParameterTypBeschreibung
art Pflichttermin | haus | uebergabe
id PflichtstringTermin-ID, "<objekt_nr>:<hausmeister_id>" oder Übergabe-ID.
text Pflichtstring
client_id PflichtstringUUID, vom Aufrufer vergeben.

[13]5 Tools

Dokumente

dokumente_durchsuchenLesenSucht im Inhalt der Objekt-Dokumente (Protokolle, Verträge, Bescheide als PDF) und nennt je Treffer Titel, Objekt-Nr., Seite und einen Ausschnitt, Treffer in «…».Dokument:ReadLesen mit Kontaktdaten

GET /api/v1/partner/dokumente/suche

Sucht im Inhalt der Objekt-Dokumente (Protokolle, Verträge, Bescheide als PDF) und nennt je Treffer Titel, Objekt-Nr., Seite und einen Ausschnitt, Treffer in «…». Wörter gelten als Wortanfang („heizung“ findet „Heizungsanlage“), Wortteile in der Mitte nicht („melder“ findet „Rauchwarnmelder“ nicht). Mit Anführungszeichen eine genaue Wortfolge, mit -wort ausschließen — dann gelten ganze Wörter in der Grundform, keine Wortanfänge. Durchsucht wird nur, was schon gelesen ist: frisch abgelegte Dokumente nach etwa einer Minute; gescannte Seiten und Fotos erst, wenn die Texterkennung eingeschaltet ist; Word und Excel nie. Ohne objekt_nr im ganzen Mandanten. Weiterlesen mit dokument_text_lesen. Braucht Dokument:Read.

Parameter von dokumente_durchsuchen
ParameterTypBeschreibung
q PflichtstringSuchbegriff(e), mindestens drei Zeichen.
objekt_nrintegerNur in den Dokumenten dieses Objekts.
limitintegerHöchstens so viele Dokumente (Vorgabe 20).
dokument_text_lesenLesenLiefert den gelesenen Text eines Objekt-Dokuments (dokument_id aus dokumente_durchsuchen) je Seite — eine Seite oder die ersten 30.Dokument:ReadLesen mit Kontaktdaten

GET /api/v1/partner/dokumente/:dokument_id/text

Liefert den gelesenen Text eines Objekt-Dokuments (dokument_id aus dokumente_durchsuchen) je Seite — eine Seite oder die ersten 30. stand sagt, ob das Dokument fertig gelesen ist (fertig) oder noch wartet (offen, wartet_ocr: Scan-Seiten fehlen noch). Braucht Dokument:Read.

Parameter von dokument_text_lesen
ParameterTypBeschreibung
dokument_id PflichtintegerID des Dokuments (aus dokumente_durchsuchen).
seiteintegerNur diese Seite (ab 1).
objekt_dokument_ordner_auflistenLesenZeigt die Dokumentablage eines Objekts: Ordner mit Pfad („03 Versammlungen & Beschlüsse › 2026“), Zahl der Dokumente und ob Eigentümer den Ordner sehen; die fehlenden Unterlagen laut Ordnervorlage (Pflicht oder Kann); die Zahl unsortierter Dokumente und alle Dokumente mit Titel, Kategorie, Datum und Ordner.Dokument:ReadLesen mit Kontaktdaten

GET /api/v1/partner/objekte/:objekt_nr/dokument-ordner

Zeigt die Dokumentablage eines Objekts: Ordner mit Pfad („03 Versammlungen & Beschlüsse › 2026“), Zahl der Dokumente und ob Eigentümer den Ordner sehen; die fehlenden Unterlagen laut Ordnervorlage (Pflicht oder Kann); die Zahl unsortierter Dokumente und alle Dokumente mit Titel, Kategorie, Datum und Ordner. Verweis-Ordner (Versicherungen, Mietverhältnisse) zeigen Unterlagen anderer Bereiche und haben hier keine Dokumente. Nur lesend — abgelegt und einsortiert wird im Portal. Inhalt eines Dokuments mit dokument_text_lesen. Braucht Dokument:Read.

Parameter von objekt_dokument_ordner_auflisten
ParameterTypBeschreibung
objekt_nr PflichtintegerNummer des Objekts.
dokument_hochladen_vorbereitenSchreibenSchritt 1 von 3 zum Ablegen einer Datei (PDF, Bild, Word, Excel, Text, ZIP — höchstens 15 MB) in der Akte eines Objekts oder Mieters: reserviert einen Upload-Platz und liefert id, uploadUrl, ablaufAm und hoechstensBytes.Dokument:CreateBearbeiten

POST /api/v1/partner/dokumente/uploads

Schritt 1 von 3 zum Ablegen einer Datei (PDF, Bild, Word, Excel, Text, ZIP — höchstens 15 MB) in der Akte eines Objekts oder Mieters: reserviert einen Upload-Platz und liefert id, uploadUrl, ablaufAm und hoechstensBytes. Schritt 2 macht der Aufrufer selbst: die Datei per PUT auf uploadUrl legen (curl -T <Datei> "<uploadUrl>") — der Link gilt für genau eine Datei und 15 Minuten, ist an den Mandanten und diesen Zugang gebunden und braucht keine weiteren Zugangsdaten. Schritt 3: dokument_hochladen_abschliessen mit der id. ziel „objekt“ (objekt_nr) oder „mieter“ (mieterId). Kategorien der Objektakte: teilungserklaerung, etv_einladung, eigentuemerbeschluss, wirtschaftsplan, hausgeldabrechnung, protokoll, energieausweis, sonstiges; der Mieterakte: ausweis, selbstauskunft, schufa, einkommensnachweis, vollmacht, korrespondenz, wohnungsgeberbescheinigung, zahlungsbestaetigung, mietbescheinigung, sonstiges. Welche Dokumente schon liegen: objekt_dokument_ordner_auflisten bzw. mieter_dokumente_auflisten. Der Dateityp folgt der Endung von name und muss zum Inhalt passen. Liegt am Ziel schon ein Dokument mit gleichem Titel und gleicher Größe, bricht Schritt 3 mit 409 ab. Es wird nie etwas gelöscht oder ersetzt. Braucht Dokument:Create; für ziel „mieter“ zusätzlich Mieter:ReadPII. Das Objekt bzw. der Mieter muss zum Mandanten gehören (sonst 404); beim persönlichen Zugang gilt die Objektgrenze der eigenen Rolle.

Parameter von dokument_hochladen_vorbereiten
ParameterTypBeschreibung
ziel Pflichtobjekt | mieterIn wessen Akte das Dokument kommt.
objekt_nrintegerNummer des Objekts — nur bei ziel „objekt“.
mieterIdstringUUID des Mieters (aus mieter_auflisten) — nur bei ziel „mieter“.
name PflichtstringDateiname mit Endung, z. B. „Verwaltervertrag.pdf“. Nur der Name zählt, nie ein Pfad.
titel PflichtstringTitel des Dokuments in der Akte.
kategoriestringKategorie der Akte (Liste in der Beschreibung); Vorgabe sonstiges.
mimeTypestringOptional; muss zur Endung von name passen (sonst 422). Ohne Angabe folgt der Typ der Endung.
beschreibungstringOptionale Beschreibung.
dokument_datumstringDatum, das das Dokument selbst trägt (JJJJ-MM-TT), optional.
dokument_hochladen_abschliessenSchreibenSchritt 3 von 3: legt die per PUT hochgeladene Datei (id aus dokument_hochladen_vorbereiten) in der Akte ab — über dieselbe Ablage wie das Portal — und liefert dokument_id, ziel, titel, kategorie und groesse_bytes.Dokument:CreateBearbeiten

POST /api/v1/partner/dokumente/uploads/:id/abschliessen

Schritt 3 von 3: legt die per PUT hochgeladene Datei (id aus dokument_hochladen_vorbereiten) in der Akte ab — über dieselbe Ablage wie das Portal — und liefert dokument_id, ziel, titel, kategorie und groesse_bytes. Vorher muss die Datei auf uploadUrl liegen, sonst 409; der Platz ist danach verbraucht. Nur der Zugang, der den Platz reserviert hat, kann abschließen (sonst 404). Liegt am Ziel schon ein Dokument mit gleichem Titel und gleicher Größe, antwortet 409 mit dessen ID und es wird nichts abgelegt. Löscht und ersetzt nichts. Braucht Dokument:Create; für die Mieterakte zusätzlich Mieter:ReadPII.

Parameter von dokument_hochladen_abschliessen
ParameterTypBeschreibung
id Pflichtstringid aus dokument_hochladen_vorbereiten.

[14]1 Tools

Datensicherung und Protokoll

aenderungen_lesenLesenDas Änderungsprotokoll des Mandanten (Konzept 194): wer hat wann über welchen Weg (Portal, direkt am Feld, KI-Zugang, App, Datenübernahme, System) etwas angelegt, geändert, korrigiert, gelöscht oder wiederhergestellt — je Feld `vorher` und `nachher` in Klartext (Beträge in Euro, Daten deutsch, Bezüge mit Namen).Aenderung:ReadLesen mit Kontaktdaten

GET /api/v1/partner/aenderungen

Das Änderungsprotokoll des Mandanten (Konzept 194): wer hat wann über welchen Weg (Portal, direkt am Feld, KI-Zugang, App, Datenübernahme, System) etwas angelegt, geändert, korrigiert, gelöscht oder wiederhergestellt — je Feld `vorher` und `nachher` in Klartext (Beträge in Euro, Daten deutsch, Bezüge mit Namen). Mit `art` und `id` der Verlauf eines Datensatzes samt Unterdatensätzen (Mietvertrag mit Bestandteilen, Mietpreisen, Anpassungen und Kaution; Einheit mit Zählern, Ständen, Räumen und Schlüsseln; Objekt mit Einheiten …), sonst die Liste des Mandanten, neueste zuerst. `beachtenswert` markiert Löschungen, Korrekturen und Wiederherstellungen; `papierkorb_id` nennt den Papierkorb-Eintrag einer Löschung, solange sie sich zurückholen lässt. Reine Auskunft; geschrieben wird das Protokoll von der Datenbank. Blättern: `naechster` der Antwort als `cursor`. Beim persönlichen Zugang gilt die Objektgrenze der Rolle. Scope: Aenderung:Read (Stufe Lesen mit Kontaktdaten).

Parameter von aenderungen_lesen
ParameterTypBeschreibung
artstringArt des Datensatzes für den Verlauf eines einzelnen Datensatzes, z. B. mietvertrag, einheit, objekt, mieter, eigentuemer, zaehler, darlehen, beschluss. Nur zusammen mit id.
idstringID des Datensatzes (bei Objekt die Objekt-Nr.). Nur zusammen mit art.
personstringNur Änderungen dieser Person (Name oder Konto-ID). Nur in der Liste.
vonstringFrühestes Datum (JJJJ-MM-TT). Nur in der Liste.
bisstringSpätestes Datum (JJJJ-MM-TT). Nur in der Liste.
nurBeachtenswertbooleanNur Löschungen, Korrekturen und Wiederherstellungen.
cursorstringZeiger `naechster` aus der vorigen Antwort.
limitintegerEinträge je Seite.

[15]Nur REST

Was die REST-API darüber hinaus kann

Diese Endpunkte der Partner-API haben kein eigenes MCP-Tool. Mit einem Token lassen sie sich direkt aufrufen — beschrieben unter Partner-API mit Token und Scopes.

EndpunktBerechtigung
GET /api/v1/partner/belegeBeleg:Read
GET /api/v1/partner/audit-eventsAudit:Read
DELETE /api/v1/partner/objekte/:nrObjekt:Delete
DELETE /api/v1/partner/einheiten/:idEinheit:Delete
DELETE /api/v1/partner/dienstleister/:idDienstleister:Delete
POST /api/v1/partner/gemeinsame-bankkonten/:id/eingang/:umsatzId/zuruecknehmenGemeinsamesKonto:Verteilen
PUT /api/v1/partner/heizkosten/perioden/:id/verbrauchHeizkosten:Update
GET /api/v1/partner/monatsabschlussBuchungsperiode:Read
GET /api/v1/partner/monatsberichte/:monat/:objektNrMonatsbericht:Read
DELETE /api/v1/partner/mieter/:idMieter:Delete
DELETE /api/v1/partner/eigentuemer/:idEigentuemer:Delete
GET /api/v1/partner/sev-hausgeldSevHausgeld:Read
POST /api/v1/partner/unternehmenssicherungenUnternehmenssicherung:Create
GET /api/v1/partner/unternehmenssicherungenUnternehmenssicherung:Read
GET /api/v1/partner/unternehmenssicherungen/:idUnternehmenssicherung:Read
GET /api/v1/partner/unternehmenssicherungen/:id/dateiUnternehmenssicherung:Read
DELETE /api/v1/partner/versammlungen/:idVersammlung:Delete
DELETE /api/v1/partner/beschluesse/:idBeschluss:Delete
GET /api/v1/partner/zugangjeder Zugang

↑ ↓ wählen · Enter öffnen · Esc schließenAlle Treffer mit Filtern