notifications
GET /v1/operations/notifications — Wartungsmeldungen und Schadensmeldungen.
string
erforderlich
Eindeutige Objekt-ID.
integer
erforderlich
Eindeutige Meldungs-ID.
integer
Technisches Objekt, auf das sich die Meldung bezieht. Verknüpft mit
Property.technical_objects.technical_object_id, aber nicht jeder Wert hat ein passendes
technisches Objekt.integer
Schlüssel für den Melder: Objekt, Einheit und Meldernummer zu einer Zahl zusammengesetzt,
ohne Trennzeichen. Keine Personen-ID — verknüpft sich nicht mit
Stakeholder.tenants.person_id.object
Kostenstelle, gegen die die Meldung gebucht wird, als strukturiertes Objekt — gleicher
Aufbau wie
projects.cost_center.object
Erledigungsfenster für die Meldung.
string
Betreff / Bezeichnung der Meldung.
string
Art der Meldung.
string
Wer die Meldung erstellt hat: Mieter, Kreditor, Eigentümer, Benutzer oder Partner.
string
Nur mit dem Grant
personal sichtbar.
Wer die Meldung erstellt hat, als Freitext – meist Referenznummer und Name, zum Beispiel
1111+200011 | Name.string
Meldungsnummer.
string
Nur mit dem Grant
personal sichtbar.
Ersteller der Meldung.date
Datum der Meldungserstellung.
string
Für die Bearbeitung zuständiges Team als numerische Team-ID (zum Beispiel
1). Anders als
bei projects.responsible_team gibt es keinen Teamnamen.string
Nur mit dem Grant
personal sichtbar.
Für die Bearbeitung zuständige Person.string
Priorität der Meldung als numerische ID aus dem ERP (zum Beispiel
83). Eine
Klartext-Bezeichnung gibt es nicht, und die IDs unterscheiden sich je Kunde.string
Aktueller Status der Meldung.
date
Datum der letzten Statusänderung.
integer
Anzahl Tage, die die Meldung schon in Bearbeitung ist.
boolean
Ob es sich um einen Versicherungsfall handelt.
string
Nur mit dem Grant
personal sichtbar.
Freitextkommentar.offers
GET /v1/operations/offers — Angebote, die Dienstleister auf eine Angebotsanfrage abgegeben
haben, eine Zeile je Angebot. Eine Anfrage kann mehrere Angebote haben; Anfragen ohne Angebot
stehen nur in requests.
string
erforderlich
Eindeutige Objekt-ID.
integer
erforderlich
Eindeutige Angebots-ID. Nicht derselbe Wert wie
offer_nr unten.string
Kostenstelle der Anfrage: Objektnummer plus Fläche, Geschoss oder Gebäude (zum Beispiel
1106/10023) oder nur die Objektnummer.integer
Einheit, die die Anfrage betrifft, falls sie eine einzelne Einheit betrifft. Verknüpft sich mit
Property.property_structure.floor_area_id.integer
erforderlich
Angebotsanfrage, auf die das Angebot antwortet. Verknüpft mit
requests.request_id.integer
Vertragsbezug am Angebot. Kein Join-Schlüssel: Er passt nicht zu
Contracts.service_contracts.contract_id.integer
Auftrag, der auf Basis dieses Angebots vergeben wurde, falls vorhanden. Verknüpft mit
orders.order_id.integer
Projektkonto, zu dem die Anfrage gehört, falls vorhanden. Verknüpft mit
projects.project_account_id; einzelne Werte haben kein passendes Projekt.string
Dienstleister, der das Angebot abgegeben hat. Verknüpft mit
Stakeholder.creditors.creditor_id.object
Gültigkeitszeitraum der Anfrage, aus der Anfrage übernommen (wie
requests.request_period).
Nicht der Ausführungszeitraum – dafür siehe orders.runtime_period.string
cost_center_id und Kostenstellenbezeichnung als ein Anzeigetext. Nur zur Anzeige, nicht zum
Verknüpfen.string
Anzeigenummer der Anfrage, wie
requests.request_number.string
Angebotsnummer wie im ERP erfasst, falls vorhanden. Nicht dieselbe Kennung wie
offer_id.string
Betreff der Anfrage, auf die das Angebot antwortet.
string
Art der Anfrage, z. B.
Anfrage Instandhaltung.number
Angebotspreis.
0, wenn kein Preis erfasst wurde.string
Status der Anfrage als numerischer Statuscode aus dem ERP, z. B.
21 oder 23. Eine
Klartext-Bezeichnung gibt es nicht. Gleicher Wert wie requests.status_text.string
Priorität der Anfrage als Nummer und Bezeichnung, z. B.
3 | Mittel.string
Nur mit dem Grant
personal sichtbar.
Freitext-Bemerkung zum Angebot.boolean
Ob das Angebot angenommen wurde.
null, wenn nicht gesetzt.boolean
Ob das Angebot als Vergabeempfehlung markiert ist. Trotz des Namens keine Bestätigung,
dass ein Auftrag vergeben wurde; dafür
order_id nutzen. null, wenn nicht gesetzt.orders
GET /v1/operations/orders — Instandhaltungs- und Reparaturaufträge an Dienstleister, eine Zeile
pro Auftrag.
Alle Felder auf Positionsebene (
position_amount, position_description, quantity, unit,
price, vat_rate_position, position_*_amount, position_obligo_net, invoice_status)
stammen nur aus der ersten Position des Auftrags. Für Aufträge mit mehreren Positionen
liefern die Felder auf Auftragsebene (total_amount, order_*_amount, order_obligo_net)
die Summen.integer
erforderlich
Eindeutige ID des Auftrags. Nicht derselbe Wert wie
order_number unten.string
Zusammengesetzter Schlüssel aus Objekt, Fläche und Personennummer, ohne Trennzeichen. Er
bezeichnet den Nutzer der Fläche, die der Auftrag betrifft, verknüpft sich aber nicht mit
Stakeholder.tenants.person_id.string
erforderlich
Eindeutige Objekt-ID. Verknüpft mit
Property.properties.property_id.integer
Angebotsnummer, auf die sich der Auftrag bezieht, als Zahl. Kein Join-Schlüssel: Sie passt
nicht zu
offers.offer_id.integer
Projektkonto, auf das der Auftrag gebucht wird, falls vorhanden. Verknüpft mit
projects.project_account_id, nicht mit projects.project_id.string
Kostenstelle des Auftrags: Objektnummer plus Fläche, Geschoss oder Gebäude (zum Beispiel
1101/20022) oder nur die Objektnummer.integer
Technisches Objekt, das der Auftrag betrifft. Verknüpft mit
Property.technical_objects.technical_object_id, aber nicht jeder Wert hat ein passendes
technisches Objekt.integer
Meldung, aus der der Auftrag entstanden ist, falls vorhanden. Verknüpft mit
notifications.report_id.string
Dienstleister, an den der Auftrag vergeben wurde. Verknüpft mit
Stakeholder.creditors.creditor_id.object
Beauftragter Wert des Auftrags aus seinen bepreisten Positionen.
0, wenn der Auftrag ohne
Preise vergeben wurde; die tatsächlichen Kosten stehen dann nur in order_recorded_amount,
order_booked_amount und order_paid_amount.object
Beauftragter Wert der ersten Position.
0, wenn die Position keinen Preis hat.object
Sachkonto, auf das die Auftragskosten gebucht werden.
object
Zeitraum, in dem die Arbeiten ausgeführt werden sollen.
string
Fachliche Auftragsnummer zur Anzeige, z. B.
2018/00001. Nicht dieselbe Kennung wie order_id.string
Betreff des Auftrags.
string
Angebotsnummer wie am Auftrag erfasst, wenn der Auftrag auf einem Angebot beruht.
string
Auftragsart, z. B. „Laufende Instandhaltung“.
string
Nur mit dem Grant
personal sichtbar.
Bezeichnung des Objekts, zu dem der Auftrag gehört.string
Nur mit dem Grant
personal sichtbar.
Name des Dienstleisters.string
Projektkonto, auf das der Auftrag gebucht wird, als Buchungskreis und Kontonummer verbunden mit
+. Leer bei Aufträgen außerhalb eines Projekts.string
cost_center_id und Kostenstellenbezeichnung als ein Anzeigetext. Nur zur Anzeige, nicht zum
Verknüpfen.integer
Umsatzsteuer-Code der ersten Position.
number
Umsatzsteuersatz in Prozent, der am Stichtag des Auftrags für
vat_code galt.string
Zweistellige Art des Umsatzsteuer-Codes aus dem ERP, z. B.
VN.string
Nur mit dem Grant
personal sichtbar.
Freitextbeschreibung der ersten Position.string
Nur mit dem Grant
personal sichtbar.
Nicht befüllt, immer ein leerer String.string
Nur mit dem Grant
personal sichtbar.
Nicht befüllt, immer ein leerer String.string
Nur mit dem Grant
personal sichtbar.
Nicht befüllt, immer ein leerer String.string
Nur mit dem Grant
personal sichtbar.
Nicht befüllt, immer ein leerer String.string
Nur mit dem Grant
personal sichtbar.
Nicht befüllt, immer ein leerer String.string
Nur mit dem Grant
personal sichtbar.
Nicht befüllt, immer ein leerer String.string
Anzeigenummer der Meldung aus
report_id.string
Anzeigenummer des technischen Objekts aus
technical_object_id.string
Interne Nummer des technischen Objekts.
string
Bezeichnung des technischen Objekts.
string
Nur mit dem Grant
personal sichtbar.
Freitext-Hinweis zum Auftrag.date
Datum des Schadens, bei Reparaturaufträgen.
boolean
Ob Aufträge dieser Art an das Handwerkerportal übergeben werden.
string
Bearbeitungsstand:
Neu, In Genehmigung, Genehmigt, In Bearbeitung, Erledigt oder
Storniert.string
Priorität.
string
Wer den Fall gemeldet hat:
Personen (eine Person, etwa ein Mieter), Kreditor (ein
Dienstleister) oder Benutzer (ein Benutzer der Verwaltungssoftware).string
Nur mit dem Grant
personal sichtbar.
Freitext-Angaben zum Melder, oft Name und Telefonnummer.string
Nur mit dem Grant
personal sichtbar.
Vollständiger Name des Melders, wenn er eine bekannte Person ist, sonst derselbe Text wie
reporter_info.number
Menge der ersten Position.
number
Einheitenfeld der ersten Position, als Zahl geliefert.
number
Einzelpreis der ersten Position.
number
Umsatzsteuersatz in Prozent, wie an der ersten Position erfasst.
string
Zahlungsstand der ersten Position, abgeleitet aus ihren Beträgen:
Bezahlt (vollständig
bezahlt), Gebucht, Erfasst (Rechnung erfasst), Obligo (beauftragt, noch nicht
abgerechnet) oder Offen.number
Netto-Obligo der ersten Position.
number
Erfasster Rechnungsbetrag der ersten Position.
number
Gebuchter Betrag der ersten Position.
number
Bezahlter Betrag der ersten Position.
number
Netto-Obligo des gesamten Auftrags.
number
Erfasster Rechnungsbetrag des gesamten Auftrags.
number
Gebuchter Betrag des gesamten Auftrags.
number
Bezahlter Betrag des gesamten Auftrags.
string
Link auf die Dokumente im Dokumentenmanagementsystem des Kunden. Ohne angebundenes DMS steht
hier ein Platzhaltertext statt einer URL; vor dem Verlinken auf eine URL prüfen.
projects
GET /v1/operations/projects — Investitionsprojekte und größere Wartungsvorhaben, eine Zeile
je Projekt.
Die Tabelle liefert alle Projekte der Verwaltung, unabhängig vom Status — auch Projekte,
die erst geplant oder beantragt, schon abgerechnet oder vom Eigentümer selbst ausgeführt
sind. Wer nur einen Teil braucht, filtert auf
status. Felder, die auf ein einzelnes
Angebot, einen Auftrag oder eine Meldung zeigten (offer_id, creditor_id, report_id
und die zugehörigen Nummern), gehören nicht mehr zu projects: Ein Projekt kann von
allem mehrere haben. Anfragen, Angebote und Aufträge eines Projekts findet man über
project_account_id.string
erforderlich
Eindeutige Objekt-ID.
integer
erforderlich
Eindeutige Projekt-ID. Nicht derselbe Wert wie
project_number weiter unten.integer
Projektkonto, auf dem das Projekt gebucht wird.
requests.project_account_id,
offers.project_account_id und orders.project_reference_id verweisen hierauf — darüber
findet man Anfragen, Angebote und Aufträge eines Projekts.string[]
Wo das Projekt im Kontenbaum der Buchhaltung “aufgehängt” ist, als geordnete Liste von
grob nach fein (z. B.
["1000/10/20/01", "1000/10/20/01.1", "1000/10/20/01.1.5"]). Die
Segmente sind auf den oberen Ebenen durch / getrennt, auf den feineren durch . —
nicht rein numerisch mit Punkt-Trennung. Leere, tiefere Ebenen werden weggelassen.object
Kostenstelle, gegen die das Projekt gebucht wird, als strukturiertes Objekt.
object
Geplante Projektlaufzeit.
object
Zeitraum, den das Projektbudget abdeckt.
string
Bezeichnung des Projektkontos.
string
Kommagetrennte Liste von Sachkontonummern für das Projekt — meist mehrere, nicht nur
eine.
string
Trotz des Namens keine sachkontobezogene ID — identischer Wert wie
cost_center.code, nur
unter anderem Feldnamen (beide stammen aus derselben Rohspalte). Für die
tatsächliche(n) Sachkontonummer(n) ledger_account verwenden.string
Projektart.
string
Aktueller Projektstatus als Textbezeichnung der Verwaltung (zum Beispiel
beantragt,
in Planung, genehmigt). Die Bezeichnungen unterscheiden sich je Kunde.object[]
Nur mit dem Grant
personal sichtbar.
Kommentare und Hinweise als Liste von Objekten. Fasst vier vormals getrennte Felder
zusammen — comment (ein Statuskommentar) und comment_1/comment_2/comment_3
(Hinweise). Einträge ohne Text sind mit leerem text enthalten. Jeder Eintrag behält seine
Herkunft über type.number
Fertigstellungsgrad in Prozent.
number
Gesamtbudget des Projekts.
number
Obligo-Limit (zugesagt, aber noch nicht in Rechnung gestellt).
number
Ist-Wert (gebucht) bis heute.
number
Erfasster Wert.
number
Aktivierter Wert.
number
Modernisierungswert.
number
Instandhaltungswert.
string
Klassifizierungs-Flag zur Projektleitung (
"0"/"1").number
Budget der Projektleitung.
integer
Berechnungsmodus für den Overhead.
number
Overhead-Zuschlag in Prozent.
number
Overhead-Betrag.
string
Gewerk / Branche des Projekts.
string
Für das Projekt zuständiges Team.
string
Nur mit dem Grant
personal sichtbar.
Für das Projekt zuständige Person.string
Budgetbeschreibung.
string
Nur mit dem Grant
personal sichtbar.
Kommentar zum Budget.string
Link auf die Dokumente im Dokumentenmanagementsystem des Kunden. Ohne angebundenes DMS steht
hier ein Platzhaltertext statt einer URL; vor dem Verlinken auf eine URL prüfen.
string
Geschäfts-/Anzeige-Projektnummer. Nicht dieselbe ID wie
project_id oben.requests
GET /v1/operations/requests — Angebotsanfragen aus dem Instandhaltungsprozess, eine Zeile je
Anfrage, auch wenn noch kein Angebot eingegangen ist.
string
erforderlich
Eindeutige Objekt-ID.
integer
erforderlich
Eindeutige Anfrage-ID. Nicht derselbe Wert wie
request_number unten.integer
Projektkonto, zu dem die Anfrage gehört, falls vorhanden. Verknüpft mit
projects.project_account_id. Leer bei Anfragen ohne Projekt; einzelne Werte haben
kein passendes Projekt.object
Kostenstelle, gegen die die Anfrage gebucht wird, gleicher Aufbau wie
projects.cost_center.integer
Einheit, die die Anfrage betrifft, falls sie eine einzelne Einheit betrifft. Verknüpft sich mit
Property.property_structure.floor_area_id.object
Gültigkeitszeitraum der Anfrage. Nicht der Ausführungszeitraum – dafür siehe
orders.runtime_period.string
Betreff / Titel der Anfrage.
string
Art der Anfrage.
string
Status der Anfrage als numerischer Statuscode aus dem ERP, z. B.
21 oder 23. Eine
Klartext-Bezeichnung gibt es nicht.string
Priorität der Anfrage als Nummer und Bezeichnung, z. B.
3 | Mittel.string
Fachliche Anfragenummer. Nicht dieselbe Kennung wie
request_id oben.