Immokeks

Immokeks: MCP-Doku

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

Was ist Immokeks?

Immokeks ist eine kostenlose Plattform für private Vermieter in Deutschland: Immobilien und Einheiten, Mietverträge, Mieten und offene Posten, Bankabgleich, Rechnungen, Dokumente, Nebenkosten-, Heizkosten- und WEG-Abrechnung, Zähler, Steuer (Anlage V und AfA), Schreiben an Mieter, Aufgaben und Fahrten.

Immokeks hat keine eigene KI. Du arbeitest mit deinem eigenen Agenten (zum Beispiel Claude, Codex, Gemini CLI oder Langdock) über MCP oder die REST-API. Diese Doku sagt deinem Agenten, was er tun kann. Sie wird aus dem Code erzeugt und passt immer zur laufenden Version.

Verbinden

Claude Code

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

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

[mcp_servers.immokeks]
url = "https://immokeks.de/api/mcp"
bearer_token_env_var = "IMMOKEKS_TOKEN"

Gemini CLI (~/.gemini/settings.json)

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

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

Ein neues Konto einrichten

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

1. Immobilie anlegen mit `create_property`

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

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

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

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

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

3. Mieter und Mitmieter anlegen mit `create_person`

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

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

4. Mietvertrag anlegen mit `create_lease`

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

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

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

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

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

6. Mietforderungen (Sollstellung) des laufenden Monats erzeugen mit `generate_monthly_charges` (optional)

{
  "month": "2026-01",
  "bookingDate": "2026-01-01"
}

Erst nach dem OK des Vermieters; wiederholbar, legt nichts doppelt an.

So arbeitet dein Agent

Rechte und Freigaben

Datensparmodus

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

Regeln für Daten

Steuer (Anlage V)

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

Bewerber (Mieterselbstauskunft)

Interessenten füllen die Mieterselbstauskunft auf dem eigenen Handy aus (Fragen nach dem Muster der Datenschutzbehörden). Dein Agent hilft beim Vorbereiten und Absagen, entscheidet aber nichts.

Unterschrift per Link (Mietvertrag, Übergabe)

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

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

Heizkosten vom Messdienst

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

Community

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

Grenzen

Workflows

Funktionen

Einstieg und Anleitung

  • get_started Loslegen · lesen · liest · Werkzeug

    Call this first after connecting and whenever the account looks empty.

  • get_guide Anleitung · lesen · liest · Werkzeug

    The Immokeks guide for agents, one section per call (the whole guide is too large for one result).

  • get_profile Verbundenes Konto · lesen · liest · Werkzeug

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

Bestand

  • get_overview Überblick · lesen · liest · Werkzeug

    Account overview: properties with unit counts, this month's rent (target, paid, received), inbox counts, number of leases in arrears and open tasks.

  • list_properties Immobilien · lesen · liest · Werkzeug

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

  • get_property Immobilie · lesen · liest · Werkzeug

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

  • list_units Einheiten · lesen · liest · Werkzeug

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

  • get_unit_area_history Flächenhistorie · lesen · liest

    Versioned living/usable/heated areas of a unit.

  • create_property Immobilie anlegen · schreiben · legt an · Werkzeug

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

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

    Updates name, address and details of a property.

  • create_unit Einheit anlegen · schreiben · legt an · Werkzeug

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

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

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

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

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

  • restore_unit Einheit wiederherstellen · schreiben · ändert oder entfernt

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

  • archive_property Immobilie archivieren · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

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

  • archive_unit Einheit archivieren · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

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

Personen

  • search_persons Personen suchen · lesen · liest · Werkzeug

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

  • get_person Person · lesen · liest

    One person with contact data and leases.

  • reveal_personal_data Kontaktdaten einer Person · lesen · liest · Werkzeug

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

  • create_person Person anlegen · schreiben · legt an · Werkzeug

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

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

    Updates a person's name and contact data.

  • erase_person Person löschen oder anonymisieren · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

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

Mietverträge

  • list_leases Mietverträge · lesen · liest · Werkzeug

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

  • get_lease Mietvertrag · lesen · liest · Werkzeug

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

  • create_lease Mietvertrag anlegen · schreiben · legt an · Werkzeug

    Creates a lease for a unit (unitId from create_unit or list_units): startDate (endDate only for a limited or ended lease), exactly one party with role main_t…

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

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

  • add_lease_party Vertragspartei nachtragen · schreiben · legt an

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

  • end_lease_party Vertragspartei austragen · schreiben · ändert oder entfernt

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

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

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

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

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

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

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

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

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

  • end_lease Mietvertrag beenden · schreiben · ändert oder entfernt

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

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

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

  • cancel_lease Mietvertrag stornieren · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

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

Bewerber (Mieterselbstauskunft)

  • prepare_applicant_invitation Selbstauskunft: Einladung vorbereiten · schreiben · legt an

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

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

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

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

    Asks every applicant of a household for the documents (stage C: proof of income, optionally an own credit report) and mails each a new link through Immokeks.

  • list_applicants Selbstauskunft: Bewerber einer Einheit · lesen · liest

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

  • get_applicant_rejection Selbstauskunft: Absagetext · lesen · liest

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

Unterschrift per Link (Mietvertrag, Übergabe)

  • prepare_signature_request Unterschrift per Link vorbereiten · schreiben · legt an

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

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

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

  • get_signature_status Unterschriften per Link: Stand · lesen · liest

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

Miete, Kaution und offene Posten

  • get_lease_ledger Mieterkonto · lesen · liest

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

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

    Leases with overdue open charges as of today (cents).

  • generate_monthly_charges Sollstellung · schreiben · legt an

    Creates the rent charges of all active leases for a month (idempotent).

  • book_payment Zahlung buchen · schreiben · legt an

    Books a tenant payment (cents) and allocates it to open charges.

  • record_deposit_transaction Kaution buchen · schreiben · legt an

    Deposit payment, interest, withholding or refund for a lease (amount positive, cents).

  • reverse_ledger_entry Buchung stornieren · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

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

  • write_off_charge Forderung abschreiben · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

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

Bank

  • list_bank Bank · lesen · liest

    Bank accounts and bank transactions, optionally by status (open, booked, ignored).

  • create_bank_account Bankkonto anlegen · schreiben · legt an · Werkzeug

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

  • import_bank_file Kontoauszug importieren · schreiben · legt an

    Imports a camt.053 (XML) or CSV bank statement (base64, max 3 MB).

  • match_bank_transaction Zahlung zuordnen · schreiben · ändert oder entfernt

    Books an incoming bank transaction as a payment of a lease.

  • set_bank_transaction_ignored Umsatz ignorieren · schreiben · ändert oder entfernt

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

Rechnungen und Ausgaben

  • list_invoices Rechnungen · lesen · liest

    Invoices, optionally by status: detected (new, not yet read), checked, assigned, booked; with documentId for get_document_content (null when the invoice has …

  • get_invoice Rechnung · lesen · liest

    Invoice with supplier, amounts (cents), allocations to properties, payment link and suggestion.

  • list_expense_catalogs Kostenarten und Steuerkategorien · lesen · liest

    Operating-cost types (BetrKV) and tax categories with their ids.

  • upload_invoice Rechnung hochladen · schreiben · legt an · Werkzeug

    Uploads an invoice (PDF, photo or e-invoice XML, base64).

  • submit_invoice_reading Rechnung auslesen · schreiben · legt an · Werkzeug

    Prefills the empty header fields of a detected (not yet checked) invoice with what you read from its file (read it with get_document_content; documentId from…

  • update_invoice Rechnungsdaten · schreiben · ändert oder entfernt

    Sets or confirms the invoice header (supplier, number, date, amounts in cents or German text, service period).

  • set_invoice_allocations Rechnung zuordnen · schreiben · ändert oder entfernt

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

  • book_invoice Rechnung buchen · schreiben · ändert oder entfernt

    Books an assigned invoice.

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

    Links the bank payment of an invoice (null unlinks).

  • unbook_invoice Rechnungsbuchung aufheben · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

    Returns a booked invoice to 'assigned'.

  • delete_invoice Rechnung löschen · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

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

Dokumente

  • search_documents Dokumente suchen · lesen · liest · Werkzeug

    German full-text search in uploaded documents.

  • list_documents Dokumente · lesen · liest

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

  • get_document_download_url Dokument herunterladen · lesen · liest · Werkzeug

    Short-lived (60 s) download URL of a document.

  • get_document_content Dokumentinhalt lesen · lesen · liest · Werkzeug

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

  • upload_document Dokument hochladen · schreiben · legt an

    Stores a document (base64, max 3 MB) and optionally links it to an entity.

  • link_document Dokument verknüpfen · schreiben · legt an

    Links an existing document to a property, unit, person, lease, invoice, …

  • withdraw_document Dokument zurückziehen · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

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

Nebenkostenabrechnung

  • get_allocation_setup Umlageschlüssel · lesen · liest

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

  • create_allocation_key Umlageschlüssel anlegen · schreiben · legt an

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

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

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

  • set_allocation_base Basiswert setzen · schreiben · ändert oder entfernt

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

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

    Default allocation key of a property for a cost type.

  • set_lease_agreement Umlagevereinbarung · schreiben · ändert oder entfernt

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

  • archive_allocation_key Umlageschlüssel archivieren · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

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

  • list_settlement_runs Nebenkostenabrechnungen · lesen · liest

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

  • get_settlement_run Nebenkostenabrechnung · lesen · liest

    A settlement run: positions, findings (linter), results per lease, the distribution matrix (positions × participants, cents), the comparison with the previou…

  • explain_settlement_amount Betrag erklären · lesen · liest

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

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

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

  • create_settlement_draft Abrechnung anlegen · schreiben · legt an

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

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

    Adds positions for newly booked invoices of the period.

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

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

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

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

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

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

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

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

  • delete_settlement_position Position entfernen · schreiben · ändert oder entfernt

    Removes a position from an open run.

  • calculate_settlement Abrechnung berechnen · schreiben · ändert oder entfernt

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

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

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

  • finalize_settlement Abrechnung abschließen · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

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

  • generate_settlement_statements Abrechnungs-PDFs erzeugen · rechtlich wirksam (Freigabe in Immokeks nötig) · legt an

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

  • send_settlement_statements_by_email Abrechnungen per E-Mail versenden · rechtlich wirksam (Freigabe in Immokeks nötig) · versendet an Dritte

    Mails each tenant their statement (if e-mail is configured) and posts the results to the rent ledger.

  • mark_settlement_sent Als versendet markieren · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

    Records that the statements were sent (e.g. by post) on a date and posts the results to the rent ledger.

  • reverse_settlement Abrechnung stornieren · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

    Reverses a finalized or sent run (ledger postings reversed); a correction is a new run.

  • delete_settlement_draft Abrechnungsentwurf löschen · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

    Deletes an open settlement run.

  • apply_prepayment_adjustment Vorauszahlung anpassen · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

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

WEG-Abrechnung (Eigentumswohnung)

  • list_weg_statements WEG-Abrechnungen · lesen · liest

    WEG Hausgeldabrechnungen of an owned flat (Path B).

  • get_weg_statement WEG-Abrechnung · lesen · liest

    A WEG statement with its lines, mapping and the settlement runs using it.

  • create_weg_statement WEG-Abrechnung anlegen · schreiben · legt an

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

  • submit_weg_reading WEG-Abrechnung auslesen · schreiben · legt an

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

  • add_weg_line WEG-Position · schreiben · legt an

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

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

    Maps a line (cost type, allocable, heating, reserve).

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

    Removes a line of a draft WEG statement.

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

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

  • create_weg_settlement Abrechnung aus WEG · schreiben · legt an

    Creates the tenant settlement run from a reviewed WEG statement.

  • reopen_weg_statement WEG-Abrechnung wieder öffnen · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

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

  • delete_weg_statement WEG-Abrechnung löschen · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

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

Messdienst-Abrechnung (Heizkosten)

  • list_provider_statements Messdienst-Abrechnungen · lesen · liest

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

  • get_provider_statement Messdienst-Abrechnung · lesen · liest

    A metering service's heating statement: header (period, shares, CO₂ data and mode), the distributed cost lines, one line per user (Nutzer-Nr., our unit and l…

  • create_provider_statement Messdienst-Abrechnung anlegen · schreiben · legt an

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

  • submit_provider_reading Messdienst-Abrechnung auslesen · schreiben · legt an

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

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

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

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

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

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

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

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

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

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

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

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

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

  • reopen_provider_statement Messdienst-Abrechnung wieder öffnen · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

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

  • delete_provider_statement Messdienst-Abrechnung löschen · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

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

Zähler und Heizung

  • list_meters Zähler · lesen · liest

    Meters of a property with their readings.

  • get_reading_sheet Ablesebogen · lesen · liest

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

  • create_meter Zähler anlegen · schreiben · legt an

    Adds a meter (water, heat, heat cost allocator, …) to a property or unit.

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

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

  • add_meter_reading Zählerstand · schreiben · legt an

    Records a meter reading as printed on the meter (up to 3 decimals) on readOn, with readingType (default regular) and source (who read it).

  • get_heating_setup Heizungsanlage · lesen · liest

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

  • set_heating_system Heizungsanlage festlegen · schreiben · ändert oder entfernt

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

  • add_fuel_delivery Tanklieferung erfassen · schreiben · legt an

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

  • delete_fuel_delivery Tanklieferung löschen · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

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

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

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

  • delete_meter_reading Zählerstand löschen · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

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

  • remove_meter Zähler ausbauen · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

    Marks a meter as removed on a date.

Steuer, AfA und Anlage V

  • get_tax_overview Steuerübersicht · lesen · liest

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

  • get_anlage_v Anlage V (Zeilen) · lesen · liest

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

  • list_unit_usage Nutzung und Aufteilung · lesen · liest

    Tax setup of a property for Anlage V: per unit the usage periods (self-used, used for own business, free of charge, vacant with or without the intention to l…

  • list_depreciation AfA · lesen · liest

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

  • add_tax_adjustment Steuer-Korrektur · schreiben · legt an

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

  • add_depreciation_record AfA eintragen · schreiben · legt an

    Records an AfA value (entered, not computed) with source.

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

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

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

    Confirms a suggestion or the yearly 'values unchanged'.

  • end_depreciation_record AfA beenden · rechtlich wirksam (Freigabe in Immokeks nötig) · ändert oder entfernt

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

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

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

  • end_unit_usage Nutzung beenden · schreiben · ändert oder entfernt

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

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

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

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

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

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

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

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

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

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

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

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

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

Schreiben an Mieter

  • get_dunning_proposals Mahnvorschläge · lesen · liest

    Leases in arrears with the overdue amount (cents), the oldest due date, the last dunning letter since then and the next step (payment_reminder → dunning_1 → …

  • list_letters Schreiben eines Mietvertrags · lesen · liest

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

  • create_letter Schreiben erstellen · schreiben · ändert oder entfernt

    Creates a letter to the tenants as a PDF in the lease documents.

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

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

  • send_letter_by_email Schreiben per E-Mail senden · rechtlich wirksam (Freigabe in Immokeks nötig) · versendet an Dritte

    Mails a created letter (list_letters) once as the archived PDF to the tenants' e-mail addresses and records it as sent.

Aufgaben und Verlauf

  • list_open_tasks Offene Aufgaben · lesen · liest · Werkzeug

    Open tasks and deadlines, earliest first.

  • get_timeline Verlauf · lesen · liest

    Timeline (events, notes, sent statements) of a property, unit, person, lease or document.

  • create_task Aufgabe anlegen · schreiben · legt an

    Creates a task, optionally linked to an entity.

  • set_task_status Aufgabe erledigen · schreiben · ändert oder entfernt

    Sets a task to open, done or dismissed.

  • add_note Notiz · schreiben · legt an

    Adds a note or call to the timeline of an entity.

Fahrten

  • list_trips Fahrten · lesen · liest

    Trips for the rental business, newest first: one round tour per day with date, stops, purpose, km driven and the deductible amount in cents (30 cents per km).

  • create_trip Fahrt erfassen · schreiben · legt an

    Records one trip for a property: one round tour on one day, from leaving home until coming back (a trip on the next day is a new trip). stops in order includ…

  • delete_trip Fahrt löschen · schreiben · ändert oder entfernt

    Permanently deletes a wrongly recorded trip (cannot be undone).

Konto und Kontingente

  • get_usage Verbrauch und Kontingente · lesen · liest

    Usage and quotas of the account: storage in bytes (every stored file, generated PDFs and withdrawn documents included; only uploads are refused when full), t…

Community (Forum)

  • list_forum_categories Forum: Kategorien · lesen · liest

    Categories of the Immokeks community forum with description, topic count and whether only the Immokeks team may open topics there.

  • list_forum_topics Forum: Themen · lesen · liest Beiträge anderer Mitglieder

    Published topics, pinned first; optionally of one category (categorySlug from list_forum_categories). sort: latest (default, by latest activity), popular (to…

  • get_forum_topic Forum: Thema lesen · lesen · liest Beiträge anderer Mitglieder

    A topic with its posts (paged).

  • search_community Community durchsuchen · lesen · liest Beiträge anderer Mitglieder

    Full-text search (German) over published forum topics and posts.

  • get_community_rules Community-Regeln · lesen · liest

    The current community rules (Markdown) with their version.

  • get_my_community_profile Eigenes Community-Profil · lesen · liest

    The user's community profile (nickname, rules accepted, status), their Kekse (community points: status only, no money value, not transferable or redeemable),…

  • get_my_kekse_history Eigene Kekse: Verlauf · lesen · liest

    The user's own Kekse history, newest first and paged: date, delta, reason code (post_liked, suggestion_planned, suggestion_done, admin_adjustment, reversal, …

  • create_forum_topic Forum: Thema eröffnen · schreiben · schreibt Beiträge für andere Mitglieder

    Opens a topic with its first post (Markdown) in a category, as the user and labelled „über Agent“.

  • reply_to_forum_topic Forum: Antworten · schreiben · schreibt Beiträge für andere Mitglieder

    Replies to an open topic (Markdown), as the user and labelled „über Agent“.

  • report_community_content Community: Inhalt melden · schreiben · meldet an die Moderation

    Reports a post, topic or member profile to the moderation (reason: illegal, rules, spam, personal_data, other).

  • update_my_community_profile Community-Profil ändern · schreiben · ändert, was andere sehen

    Changes the short bio (≤ 280 characters), the federal state (BW, BY, BE, … as code) and „Vermieter seit“ (year) of the user's profile.

  • list_improvement_suggestions Verbesserungsvorschläge · lesen · liest Beiträge anderer Mitglieder

    Improvement suggestions for Immokeks with status (open, planned, in_progress, done, declined with the team's reason) and votes; sorted by votes or new, optio…

  • submit_improvement_suggestion Verbesserung vorschlagen · schreiben · schreibt Beiträge für andere Mitglieder

    Suggests an improvement to Immokeks (title and Markdown text), as the user and labelled „über Agent“.

  • vote_improvement_suggestion Für einen Vorschlag stimmen · schreiben · ändert, was andere sehen

    Votes for an improvement suggestion (vote true) or takes the vote back (vote false); one vote per member, only while the suggestion is open, planned or in pr…