> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trassets.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# KPI

> Feldreferenz für die vorberechneten Objekt-Kennzahlen unter /v1/kpi/.

> [!WARNING]
>
> Die KPI-Tabellen sind eine **Preview**: Felder und Berechnungsregeln können sich noch ohne
> Ankündigung ändern. Prüfe diese Seite nach jedem Release.

Die zwei Tabellen unten enthalten vorberechnete Kennzahlen je Objekt: Flächen, Leerstand,
Mieter und Nettosoll. Damit entfällt das eigene Aggregieren der Rohlisten
(`property_structure`, `tenants`, `contract_debits`). Weil sie eine eigene Kategorie sind, lässt
sich ein Key auf `kpi` beschränken, ohne Zugriff auf diese Listen.

Beide Tabellen werden aus den `/v1/`-Tabellen der Domänen Property, Stakeholder und Contracts
abgeleitet und folgen deshalb derselben Objektauswahl. Mit der Property-Domäne verknüpfen sie
sich über `property_id`.

## Stichtage

Jede Zeile gehört zu einem `reference_date`, dem Ersten eines Monats. Jede Tabelle deckt die
letzten 12 Monate einschließlich des laufenden ab, gerechnet ab dem letzten Sync. Eine Fläche
zählt an einem Stichtag, wenn ihr Gültigkeitszeitraum den Stichtag umfasst; ein Mietverhältnis
zählt, wenn sein Vertrag am Stichtag läuft.

## property\_kpis

`GET /v1/kpi/property_kpis`: eine Zeile je Objekt und Stichtag. Filterbar nach `property_id`
und `reference_date`.

**property\_id** `string` *required*

Eindeutige Objekt-ID.

**reference\_date** `date` *required*

Stichtag, immer der Erste eines Monats.

**floor\_area\_count** `integer`

Anzahl der am Stichtag aktiven Flächen (Mieteinheiten).

**floor\_area\_sqm** `number`

Gesamtfläche in m². Nicht historisiert: Auch frühere Stichtage zeigen die aktuelle Fläche.

**vacant\_floor\_area\_count** `integer`

Anzahl der Flächen ohne laufendes Mietverhältnis am Stichtag. Zählt alle Flächen, auch die
von der Vermarktung ausgeschlossenen.

**vacant\_floor\_area\_sqm** `number`

m² der leerstehenden Flächen.

**vacancy\_rate\_count\_pct** `number`

Leerstandsquote nach Anzahl Flächen in Prozent, auf zwei Nachkommastellen gerundet.

**vacancy\_rate\_sqm\_pct** `number`

Leerstandsquote nach m² in Prozent, auf zwei Nachkommastellen gerundet. `null`, wenn für keine
Fläche des Objekts m² gepflegt sind.

**tenant\_count** `integer`

Anzahl verschiedener Mieter (Personen) mit laufendem Mietverhältnis auf einer aktiven Fläche.
Ein Mieter mit mehreren Einheiten zählt einmal.

**tenancy\_count** `integer`

Anzahl laufender Mietverhältnisse (Fläche × Mieter) auf aktiven Flächen. Ein Mieter mit drei
Einheiten zählt dreimal.

**floor\_count** `integer`

Anzahl Geschosse: verschiedene Geschossnamen des Objekts, nicht über Gebäude summiert. Zwei
Gebäude mit jeweils EG bis 2. OG ergeben 3, nicht 6.

**net\_rent\_monthly** `number`

Erfordert den [`personal_financial`-Grant](https://docs.trassets.ai/de/v1/authentication#grants-für-personenbezogene-daten).
Monatliches Nettosoll: die Nettomiet-Sollstellungen aller am Stichtag laufenden
Mietverhältnisse.

**net\_rent\_annual** `number`

Erfordert den [`personal_financial`-Grant](https://docs.trassets.ai/de/v1/authentication#grants-für-personenbezogene-daten).
`net_rent_monthly` × 12.

## property\_kpis\_by\_floor\_area\_type

`GET /v1/kpi/property_kpis_by_floor_area_type`: die Flächen-, Leerstands- und Nettosoll-Werte
aus `property_kpis`, aufgeschlüsselt nach Nutzungsart. Eine Zeile je Objekt, Stichtag und
Nutzungsart. Filterbar nach `property_id`, `reference_date` und `floor_area_type`.

**property\_id** `string` *required*

Eindeutige Objekt-ID.

**reference\_date** `date` *required*

Stichtag, immer der Erste eines Monats.

**floor\_area\_type** `string` *required*

Nutzungsart der Flächen, wie in `property_structure.floor_area_type`. Die Werte stammen aus dem
Katalog der Immobilienverwaltungs-Software des Kunden und sind nicht kundenübergreifend vereinheitlicht.
Flächen ohne Nutzungsart sind unter `ohne Angabe` zusammengefasst.

**floor\_area\_count** `integer`

Wie in `property_kpis`, je Nutzungsart.

**floor\_area\_sqm** `number`

Wie in `property_kpis`, je Nutzungsart.

**vacant\_floor\_area\_count** `integer`

Wie in `property_kpis`, je Nutzungsart.

**vacant\_floor\_area\_sqm** `number`

Wie in `property_kpis`, je Nutzungsart.

**vacancy\_rate\_count\_pct** `number`

Wie in `property_kpis`, je Nutzungsart.

**vacancy\_rate\_sqm\_pct** `number`

Wie in `property_kpis`, je Nutzungsart.

**net\_rent\_monthly** `number`

Erfordert den [`personal_financial`-Grant](https://docs.trassets.ai/de/v1/authentication#grants-für-personenbezogene-daten).
Wie in `property_kpis`, je Nutzungsart.

**net\_rent\_annual** `number`

Erfordert den [`personal_financial`-Grant](https://docs.trassets.ai/de/v1/authentication#grants-für-personenbezogene-daten).
Wie in `property_kpis`, je Nutzungsart.

> [!NOTE]
>
> Mieter-, Mietverhältnis- und Geschosszahlen gibt es nur in `property_kpis`: Ein Mieter kann
> Einheiten verschiedener Nutzungsarten mieten, deshalb lassen sich diese Zahlen nicht je
> Nutzungsart aufsummieren. Alle anderen Werte schon: Die Summe von
> `property_kpis_by_floor_area_type` über `floor_area_type` ergibt die Werte von `property_kpis`.

> [!NOTE]
>
> Das Nettosoll erfordert den `personal_financial`-Grant, weil es bei einer Gruppe mit nur einer
> vermieteten Einheit die Miete eines einzelnen Mieters ist.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.