# OPENWOWI API ## **Willkommen bei der OPENWOWI API-Dokumentation** OPENWOWI ist die offene REST-API der Dr. Klein Wowi Digital AG für das ERP-System WOWIPORT – die moderne, cloudbasierte Lösung für die Wohnungswirtschaft. Mit dieser Schnittstelle können Softwarepartner, Entwickler und Kunden Anwendungen nahtlos an WOWIPORT anbinden und Daten sicher sowie effizient austauschen. ## **Was bietet diese Dokumentation?** * **Schnelleinstieg & Grundlagen**: Erste Schritte zur Einrichtung und Nutzung der API. * **Technische Referenz**: Detaillierte Beschreibung aller verfügbaren Endpunkte, Parameter und Datenstrukturen. * **Praxisbeispiele & Tools**: Postman Collections, Webhook-Anleitungen und Integrationsbeispiele. * **Release Notes & Roadmap**: Aktuelle Informationen zu neuen Funktionen, geplanten Erweiterungen und bekannten Bugs. ## **Für wen ist OPENWOWI gedacht?** Diese API richtet sich an: * **Softwarepartner**: die Anwendungen für die Wohnungswirtschaft entwickeln. * **IT-Abteilungen**: die bestehende Systeme integrieren oder erweitern möchten. * **PropTechs & Start-ups**: die innovative Lösungen auf Basis von WOWIPORT entwickeln wollen. ## **Warum OPENWOWI?** * **Offen, transparent und kostenfrei**: Klare Dokumentation, faire Zugangsbedingunge und keine Gebühren für die Nutzung. * **Sicher & stabil**: Zuverlässige Schnittstellen mit klaren Authentifizierungsmechanismen. * **Zukunftsorientiert**: Laufende Weiterentwicklung in enger Zusammenarbeit mit Partnern und Kunden. # Nutzungsbedingungen, Impressum und Kontakt ## Kontakt Wenn Sie nähere Informationen zur OPENWOWI wünschen, Anregungen oder Verbesserungswünsche haben, können Sie uns gerne unter der Adresse [openwowi@drklein-wowi.de ](mailto:openwowi@drklein-wowi.de) kontaktieren. ## Nutzungsbedingungen Für die Verwendung der OPENWOWI gelten unsere Nutzungsbedingungen. Diese können Sie hier einsehen: {% file src="/files/TDwWO1dkuQIMaQFt78Kk" %} ## Impressum Das Impressum der Dr. Klein Wowi Digital AG finden Sie auf unserer Webseite.\ # Einrichtung OPENWOWI Auf dieser Seite beschreiben wir die Einrichtung von OPENWOWI im WOWIPORT. ## WOWIPORT-Konfiguration {% hint style="warning" %} Um auf die OPENWOWI-Konfiguration zugreifen zu können, wird das Benutzerrecht "OPEN WOWI Konfiguration" benötigt. {% endhint %} In dem Menüpunkt "Schnittstellen" unter *Systemverwaltung* >> *Schnittstellen* >> *OPENWOWI Konfiguration* (siehe Screenshot) in WOWIPORT erhalten Sie eine Übersicht über bereits eingerichtete Schnittstellen und können neue Schnittstellen hinzufügen. \ ![](/files/bvhnyilVsCTpPCmmcjTT) ## Details der Konfiguration Durch das Anlegen der Konfiguration wird ein individueller API-Key zur Nutzung der Schnittstelle für eine Anwendung erzeugt. Über die Endpunktberechtigungen können Sie steuern, über welche der verschiedenen API-Endpunkte eine Datenausgabe möglich sein soll. Alle Datenabrufe funktionieren nur in den konfigurierten Buchwerken. Datenabrufe werden auf die Buchwerksauswahl gefiltert.

API Key Konfiguration

Um unsere Beispiele zur Nutzung der API nachvollziehen zu können, können Sie einen Zugang zu unserer Sandbox beantragen. Bitte kontaktieren Sie hierfür [Partnermanagement@drklein-wowi.de](mailto:partnermanagement@drklein-wowi.de).\ Sie erhalten dann einen technischen User und einen API Key. Für die Beantragung **benötigen wir eine E-Mailadresse** (diese wird für die Passwortvergabe an den Benutzer gebunden) für die Versendung der Einladung zu unserer Sandbox und Zustellung des API Keys. Die URL der Sandbox lautet: Weiterführende Informationen zur Berechtigungssteuerung finden Sie in den Abschnitten "[Authentifizierung und Berechtigungen](/schnittstelle-v1.x/authentifizierung-und-berechtigungen)" in der Schnittstellendokumentation. Details zur Einrichtung von [Webhooks](/grundlagen/webhooks) und der Quelleneinstellungen für das [Kommunikationsmodul](/schnittstelle-v1.x/kommunikationsmodul) finden Sie in den jeweiligen Abschnitten. Details zur Freischaltung von Dokumentenabrufen und der Einrichtung des Tabs für externe DMS Systeme finden Sie im Abschnitt "[Dokumente und Medien](/schnittstelle-v1.x/dokumente-und-medien)". ## Nutzung der Endpunkte Für die Nutzung der Endpunkte müssen Sie eine Route ansprechen, welche sich aus der Basis-URL und der Endpunkt-URL zusammensetzt. Die Basis-URL ist hierbei die URL der Kundeninstanz (). \ Die Endpunkt-URL finden Sie in den einzelnen Abschnitten der Dokumentation. Beispiel:\ ![](/files/AYFk3w0YmVlqQ9gvlaDp) # Checkliste für die Einrichtung in WOWIPORT Zur Einrichtung des API-Keys und des Nutzers in WOWIPORT benötigen unsere Kunden einige Informationen. Diese Checkliste soll es unseren Partnern vereinfachen, die notwendigen Informationen abzufragen oder bereitzustellen. | Frage | Benötigt für | | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Wer soll die Passworthoheit für den technischen Nutzer innehaben? | Um einen neuen Nutzer anzulegen, wird eine E-Mail-Adresse benötigt. Der Empfänger dieser E-Mail hat später die Möglichkeit, das Passwort für die Authentifizierung zu setzen. | | Für welchen Knotenpunkt soll der API-Key gelten? | Wenn ein Wohnungsunternehmen in mehrere Subunternehmen aufgeteilt ist, können sich diese auf tieferen Knotenpunkten in der Berechtigungsstruktur wiederfinden. | | Für welche Buchwerke soll der API-Key gelten? | Über die Berechtigungsstruktur hinaus lassen sich auch einzelne Buchwerke auswählen, für welche der API-Key gültig sein soll. Diese Einschränkung hat allerdings nur bei buchwerksgebundenen Entitäten eine Auswirkung. Die Auswahl "aller Buchwerke" ist ebenfalls möglich. | | Welche API-Berechtigungen benötigt der API-Key? | In den einzelnen Controllern finden Sie, jeweils auf der höchsten Seite der Dokumentation, einen Hinweis auf die für die entsprechenden Endpunkte benötigten API-Berechtigungen. | | Muss ein Katalogeintrag für das Kommunikationsmodul angelegt werden? | Das Kommunikationsmodul ist quellengebunden und benötigt einen Eintrag für die Nachrichtenquelle, welche im API-Key an den dort hinterlegten Nutzer gebunden wird. | | Ist die Berechtigung für das Kommunikationsmodul bereits in WOWIPORT aktiviert? | Das Kommunikationsmodul ist ein kostenpflichtiges Modul, welches optional erworben werden kann. Die Endpunkte stehen nur Kunden mit diesem Modul zur Verfügung. | | Wird ein Webhook benötigt? | Soll ein Webhook angelegt werden, muss eine URL angegeben werden. Sollte die URL mit einer Authentifizierungsmethode abgesichert werden, müsste diese ebenfalls kommuniziert werden. Zudem muss natürlich die Entität für den Webhook angegeben werden. | | Soll ein Absprung in ein Drittsystem aus WOWIPORT möglich sein? | In diesem Fall benötigt man eine statische URL im Zielsystem mit der WOWIPORT Id oder IdNum als Variablen. Mehr hierzu finden Sie in [diesem Abschnitt](/grundlagen/hyperlinks-aus-wowiport-zu-externen-anwendungen-integrieren). | | Welche Dokumente sollen freigegeben werden? | Die Dokumente API umfasst viele Module. In der API Key Einrichtung haben wir deshalb die Möglichkeit geschafften, den Zugriff auf bestimmte Dokumentarten und -entitäten einzuschränken. Weitere Informationen finden Sie im Abschnitt "[Dokumente](/schnittstelle-v1.x/dokumente-und-medien)". | #### Checkliste zum Download: {% file src="/files/eFJJOxIifkP382mXn7Lq" %} # Postman Collection Hier finden Sie eine Postman Collection für die OPENWOWI-API. Um Ihnen den Start in die OPENWOWI-API zu erleichtern, haben wir für Sie bereits eine Postman Collection bereitgestellt. Bitte beachten Sie, dass Sie für diese Collection den Postman Client oder einen Workspace bei benötigen. #### Collection für OPENWOWI 1.0 und 1.1 {% file src="/files/RVr25GQwLeubwZsOb86a" %} Stand: 17.11.2022 {% endfile %} #### Collection für OPENWOWI 1.2 {% file src="/files/Ac2KC6e7dHKsxum3jrxj" %} #### OPENWOWI Environment In der Enviroment können Sie Ihren API Key und Ihren User eintragen. {% file src="/files/llOAXhkHaFs9tN6qcD8k" %} Da Postman ab dem 15.09.2023 die lokale Umgebung der Anwendung abkündigt und die Daten nur noch in einem eigenen Cloud-Workplace verfügbar gemacht werden, haben wir für die Authentifizierungsdaten eine eigene Umgebung angelegt, in welcher die Daten für die OPENWOWI-Demo hinterlegt wurden.\ \ Die Umgebung verfügt über einen "initialen Wert" und über einen "aktuellen Wert". Nach dem Import der Umgebung sind beide Werte belegt. Die initialen Werte werden ebenfalls in den Workplace bei Postman synchronisiert. Die aktuellen Werte verbleiben in der lokalen Umgebung.\ In den neueren Postman Versionen erkennen Sie die Synchronisierung der Daten am "Cloud" Symbol.
Wir bitten darum, dies beim Umgang mit den Kunden-Authentifizierungsdaten zu beachten. # Eine kurze Vorstellung der OPENWOWI Wir möchten Ihnen gerne die Möglichkeit geben, unsere Vorstellung der OPENWOWI und das Zusammenspiel mit unseren Partnern näher kennenzulernen.\ Wir haben deshalb eine kurze Präsentation für Sie vorbereitet. {% embed url="" %} ## Anwendungsbeispiel mit Hilfe von Microsoft Power Automate Die Integration von APIs muss nicht kompliziert sein. Einfache Abläufe lassen sich auch mit Automatisierungslösungen realisieren. In unserem Whitepaper zur Anbindung der OPENWOWI über Microsoft Power Automate können Sie mehr darüber erfahren. {% file src="/files/L7HHTw6Mp8m8pFtJjZIU" %} # Hinweise zur Weiterentwicklung der OPENWOWI Über den Umgang mit Endpunkten in den laufenden Versionen Die OPENWOWI lebt und entwickelt sich gemeinsam mit den Wünschen unserer Kunden und unserer Partner. Dieser Grundsatz bedeutet, dass wir in den laufenden Versionen manchmal Änderungen vornehmen, um diesen Anforderungen gerecht zu werden. Die Wünsche nach Schnelligkeit, Verlässlichkeit und Flexibilität sind nur schwer miteinander in Einklang zu bringen. Wir hoffen, dass Transparenz in unserer Vorgehensweise es uns erlaubt, alle Anforderungen zu erfüllen. Bei der Weiterentwicklung unserer API möchten wir Sie deshalb bitten, Folgendes zu beachten: * Bei Veröffentlichung einer neuen Version wird die letzte Version zur "stabilen" Version und erfährt keinerlei Änderungen mehr. * Die neue Version wird zu einem "Work in Progress" und kann jederzeit Änderungen erfahren. * Wurde ein Endpunkt in dieser Dokumentation noch nicht veröffentlicht, können sich sowohl die Route, der Parameter als auch der Inhalt und die Struktur ändern. * Sobald ein Endpunkt in dieser Dokumentation veröffentlicht wurde, gehen wir davon aus, dass dieser in einem produktiven System eingesetzt wird, und wir werden keine Änderungen an der Route oder an der Gesamtstruktur vornehmen. Auch verpflichtende Parameter werden nicht mehr hinzugefügt. * Erweiterungen im Dateninhalt (einzelne Schlüssel) oder der optionalen Parameter eines API-Endpunktes der aktuellen Version können jederzeit erfolgen. * Die Bezeichnung der Schlüssel innerhalb der JSON-Daten ist dabei nicht einzigartig und sollte deshalb mit der konkreten Bezeichnung der Knotenpunkte verarbeitet werden. * Abkündigungen von API-Versionen werden unseren Kunden und Partnern mit einer Vorlaufzeit von drei Monaten angekündigt. Zum derzeitigen Stand (Juni 2023) sind die Endpunkte der Version 1.0 und 1.1 als stabil anzusehen. Aus der Version 1.2 wurden alle Endpunkte, mit Ausnahme der Endpunkte der Anlagenbuchhaltung, veröffentlicht. Die Endpunkte der Umlagenabrechnung können sich im Zuge von Anpassungen im WOWIPORT Modul ändern. Für die Stabilität dieser Endpunkte kann keine Garantie übernommen werden. Bitte beachten Sie, dass die Entwicklung OPENWOWI API im Einklang mit der Entwicklung und der strategischen Ausrichtung von WOWIPORT erfolgt. Aus diesem Grund werden nur spezifische Prozesse abgebildet. Wir behalten uns vor, bestimmte Entwicklungswünsche abzulehnen. # Hyperlinks zu WOWIPORT in Partneranwendungen integrieren WOWIPORT bietet die Möglichkeit, mittels Hyperlink in existierende Objekte zu springen. Das Schema für diese Hyperlinks erklären wir hier. Wenn Sie aus Ihrer Anwendung einen direkten Hyperlink zu einem Datenobjekt in WOWIPORT bereitstellen möchten, können Sie diesen nach dem folgenden Schema erstellen: {*BaseURL*}/open/{*EntityName*}/{*Id*} \ \ Beispiel: Die BaseURL ist die URL des Zielsystems.\ Die IDs sind jene, welche als Identifier in den API-Endpunkten zu finden sind.\ Eine Liste der relevanten Entitäten finden Sie weiter unten. Bitte beachten Sie, dass Sie nicht die Namen aus den API-Routen benutzen können, da diese für spezielle Methoden der API individualisiert wurden. Die Entität im Link ist *case sensitive.* Ein Nutzer, der den Hyperlink verwenden möchte, benötigt eine aktive Session in WOWIPORT, in dem Browser, in dem der Hyperlink geöffnet wird. **Entitätenliste:** * Person * Owner * CooperativeMembership * LicenseAgreement * EconomicUnit * Building * Land * UseUnit * Defect * Commission * Craftsman * Loan * Lender \ \ # Hyperlinks aus WOWIPORT zu externen Anwendungen integrieren WOWIPORT bietet Ihnen die Möglichkeit, Links zu Ihren Anwendungen direkt in WOWIPORT zu hinterlegen. Die externen Sprungpunkte können sowohl statisch, unter Verwendung von "Id" und "IdNum", als auch variabel unter Verwendung einer API angelegt werden. ## Anlage einer statischen URL ### Erforderliche Benutzerrechte Für die Anlage und Verwaltung von externen Sprungpunkten benötigt der Benutzer die Berechtigungen "Externe Sprungpunkte" und "Gruppe - Externe Anwendungen" aus dem Bereich "Administration". Zudem kann es notwendig sein, die Rechte für die Erstellung von Webhooks zu vergeben, da diese in derselben Maske bearbeitet werden. ### Anlage eines Sprungpunktes Statische Sprungpunkte können auf Gruppenebene angelegt werden. Die Einstellung erfolgt in der "Benutzerverwaltung" unter "Gruppen".\ \ ![](/files/UMaVBEeHVqXtaj6yzS7L) In der gewünschten Gruppe kann der Sprungpunkt im Tab "Externe Anwendungen" erfasst werden. Der Name des Sprungpunktes wird später in der Kopfzeile der gewählten Entität angezeigt. Als Platzhalter können "#Id#" und "#IdNum#" verwendet werden. Bitte beachten Sie, dass die Platzhalter *case sensitive* sind und dass die "IdNum" mit den vom Kunden definierten Sonderzeichen übermittelt wird. Dies kann in Einzelfällen zu Komplikationen führen.
Derzeit stellen wir die Funktion für folgende Entitäten bereit: * Auftrag * Darlehen * Fremdverwaltungsvertrag * Gebäude * Grundstück * Mitgliedschaft * Nutzungsvertrag * Nutzungseinheit * Person * Wirtschaftseinheit * Kreditoren Wurde der Sprungpunkt gespeichert, kann dieser von allen Nutzern unter der Gruppe im Infobereich jener Objekte aufgerufen werden, für deren Entität der Sprungpunkt angelegt wurde.
## Anlage von externen Sprungpunkten per API
Hinweise zur Funktion Durch die API können keine Konfigurationen für neue externe Links angelegt werden. Dieses Feature wurde, aus Sicherheitsgründen, in der Benutzeroberfläche von WOWIPORT belassen.\ \ Wurde eine Konfiguration angelegt, kann diese durch den im API-Key hinterlegten Benutzer abgefragt werden. Für eine Konfiguration können dann in der hinterlegten Entität Links für bestimmte Objekte der Entität angelegt werden.\ \ Bitte beachten Sie, dass diese Links nur über die API änderbar sind. Der Partneranwendung obliegt die Pflicht, diese Links aktuell zu halten und ggf. zu löschen.
### Einrichtung der Sprungpunktkonfiguration Im API-Key können im Tab "Externe Sprungpunkte" neue externe Sprungpunktkonfigurationen hinzugefügt werden.
Wird eine neue Konfiguration angelegt, muss ein Name vergeben werden, welcher dann in der Entität angezeigt wird. Hinter diesem Namen liegt der individuelle Link in die Partneranwendung.\ Zudem muss der Systemzweck und die Entität angegeben werden. Der Systemzweck wird üblicherweise "Echt" oder "Test" lauten. Die Entität bestimmt, in welchem Bereich von WOWIPORT der Sprungpunkt angezeigt werden kann.
Derzeit stellen wir die Funktion für folgende Entitäten bereit: * Auftrag * Darlehen * Fremdverwaltungsvertrag * Gebäude * Grundstück * Mitgliedschaft * Nutzungsvertrag * Nutzungseinheit * Person * Wirtschaftseinheit Bereits angelegte Sprungpunkte werden unterhalb der Einstellungen in einer Tabelle angezeigt, können jedoch nicht bearbeitet werden. ### Externe Sprungpunkte Konfiguration abfragen Dies sind die Konfigurationen, für welche externe Links von Ihrem User aus angelegt werden können. #### Version 1.2 {% openapi src="" path="/openwowi/v1.2/ExternalLink/ExternalLink" method="get" %} {% endopenapi %} ### Externe Sprungpunkte abfragen Dies sind die tatsächlich mit den Objekten der Entität verbundenen Links in die Partneranwendung. #### Version 1.2 {% openapi src="" path="/openwowi/v1.2/ExternalLink/EntityLink" method="get" %} {% endopenapi %} ### Externe Sprungpunkte anlegen, ändern und löschen Die EntityId stellt die Objekt-ID dar, mit welcher der Link verbunden werden soll. Die Entität selbst wird in der Konfiguration definiert. #### Version 1.2 {% openapi src="" path="/openwowi/v1.2/ExternalLink/EntityLink" method="post" %} {% endopenapi %} {% openapi src="" path="/openwowi/v1.2/ExternalLink/EntityLink/{entityLinkId}" method="put" %} {% endopenapi %} {% openapi src="" path="/openwowi/v1.2/ExternalLink/EntityLink/{entityLinkId}" method="delete" %} {% endopenapi %} ### Kataloge #### Verfügbare Entitäten #### Version 1.2 {% openapi src="" path="/openwowi/v1.2/ExternalLinkCatalog/ExternalLinkEntity" method="get" %} {% endopenapi %} # Webhooks
Hinweise zur Funktion Bitte beachten Sie, dass die Webhooks beim Speichern einer Entität ausgelöst werden. Die Speicherfunktionen können den Webhook auch mehrfach auslösen (z. B. wenn eine verbundene Unter-Entität gespeichert wird). Die Webhooks können deshalb auch über Änderungen an Daten informieren, welche über die API nicht ermittelt werden können. Bei Endpunkten, welche sich über mehrere Entitäten erstrecken (z.B. Dokumente), kann die abzurufende Entität dem Schlüssel "additionalInfo" entnommen werden.
## Welche Webhooks bietet WOWIPORT: Wir bieten derzeit Webhooks für folgende Entitäten an: * Personen (Person) * Verträge (LicenseAgreement) * Wirtschaftseinheiten (EconomicUnit) * Nutzungseinheiten (UseUnit) * Darlehen (Loan) * Aufträge (Commission) * Vorgänge (CraftsProcess) * Nachrichten (Ticket) * Buchungen (Booking) * Mitgliedschaft (CooperativeMembership) * Dokumenterzeugung (Document) ->Dokumente, welche in WOWIPORT erstellt wurden * individuelle Dateien (File) -> Dateien, welche in WOWIPORT hochgeladen wurden * Medien im Bestand (Media) * Eingangsrechnung (InvoiceReceipt) * Eingangsrechnung Zahlauftrag (InvoiceReceiptPaymentOrder) Die Trigger-Events sind: * created * deleted * updated Der Payload folgt dem folgenden Beispielschema: {% code title="Payload des Webhook" %} ```json "body": { "entityType": "file", "entityName": "individuelle Dateien", "id": 9999, "action": "updated", "nodeId": 7, "systemId": "openwowi-demo.wowiport.de", "instanceName": "wowiport-demo", "applicationBaseUrl": "https://openwowi-demo.wowiport.de", "userId": 412, "openWowiUrl": "/openWowi/v1.2/DocumentRead/UseUnit/FileData?...", "additionalInfo": UseUnit } ``` {% endcode %} Der Webhook wird als POST Request ausgeführt. ## Einrichtung eines Webhooks {% hint style="warning" %} Um auf die Webhook-Konfiguration zugreifen zu können, wird das Benutzerrecht "Web Hook" benötigt. Zudem benötigen Sie das Recht "Web Hook Warteschlangeneintrag" um ausgeführte Webhooks nachvollziehen zu können. {% endhint %} Der Webhook wird für einen API-Key eingerichtet. Hierzu findet sich ein separater Tab in der API-Key-Konfiguration.

Webhook Übersicht

Um den Webhook einzurichten, benötigen Sie eine URL, welche den POST Request empfangen kann. Der Systemzweck wird üblicherweise "Echt" oder "Test" lauten. Der Webhook kann aktiviert oder deaktiviert werden.

Webhook Konfiguration

Sie haben auch die Möglichkeit, den Webhook mit Authentifizierungsdaten abzusichern. Mögliche Authentifizierungsmethoden sind: * Keine * Bearer (Header: "Bearer Token") * Basic (Header: "Username" und "Password") * Custom (Definition von "Header Name" und "Header Wert" ist individuell möglich.) Bitte beachten Sie, dass es sich bei dieser Authentifizierung lediglich um Header-Daten handelt, welche verhindern sollen, dass Ihre Systeme mit unzulässigen Callback Anfragen gestört werden.\ Die Daten sind in der WOWIPORT Oberfläche nicht obfuskiert und nicht verschlüsselt gespeichert.\ Bitte verwenden Sie keine User- / Passwortkombinationen, welche dazu verwendet werden können, sich in anderen Systemen zu authentifizieren. ## Warum Webhooks und nicht WebSockets? Die derzeit angebotenen Entitäten erfahren nur selten Änderungen. Sollte unser Kommunikationsmodul einmal als vollumfängliche Chat-Applikation eingeführt werden oder eine Live-Kommunikation mit hochfrequentem Datenaustausch nötig sein, werden wir diese Technologie in Erwägung ziehen. # Parameter der OPENWOWI ## Welche generellen Parameter gibt es? Die OPENWOWI hat seit der Version 1.1 immer mehr auf die Individualisierung der API-Abrufe für die spezifischen Partnerbedürfnisse gesetzt. Die API-Endpunkte sind deshalb mit einer Reihe von Parametern ausgestattet, welche es den Anwendern erlauben, den Inhalt der API-Antwort den eigenen Anforderungen anzupassen. Einige Parameter sind hierbei erwähnenswert. * `Limit` Limit gibt an, wie viele Datenobjekte geliefert werden sollen. Das Limit liegt zwischen 1 und 1000. Das Limit ist notwendig, um die Antwortzeiten und die Arbeitslast auf den Datenbankservern besser steuern zu können.\ Daten-Endpunkte der Version 1.2 enthalten einen Header "Total-X-Count", welcher die Gesamtanzahl der Ergebnisse ausgibt. Wenn kein Limit oder Offset als Parameter gefordert sind, entfällt dieser Header. * `Offset` Der Offset gibt an, mit welchem Datenobjekt gestartet wird. Ein Offset von "0" startet mit dem ersten Objekt. Ein Limit von 100 liefert also die Datensätze 0 bis 99. Ein Offset von 100 liefert dann die nächsten 100 Datensätze. * `Id` Die Id bezieht sich immer auf die spezifischen Objekte des gerade genutzten Endpunktes. Dieser Parameter erlaubt es dem Nutzer, gezielt einen einzelnen Datensatz abzufragen. * `IdNum`, `...Number` Die IdNum ist die alphanumerische ID, welche in WOWIPORT als Identifikator für den Nutzer erkennbar ist. Die Struktur der IdNum wird in WOWIPORT über die Nummernlogik gesteuert und kann nicht von externen Anwendungen vorgegeben werden. * `showNullValues` Diese Option erlaubt es dem Nutzer, leere Datenfelder mit auszugeben. Diese Option ist insbesondere für die Tests in Kundensystemen sinnvoll, da hiermit verifiziert werden kann, dass bestimmte, erwartete Daten tatsächlich nicht vorhanden sind. * `include...` Parameter, welche mit dem "include"-Zusatz versehen sind, erlauben es, die API-Antwort durch zusätzliche Daten zu erweitern, welche ggf. einen erneuten Abruf über einen anderen Endpunkt überflüssig machen. * `...Id` Der Zusatz "Id" an einem Parameter bedeutet, dass der Endpunkt über diese IDs eine Filterung der Ergebnisse vornehmen kann. Es werden also nur Ergebnisse ausgegeben, bei denen der Datenschlüssel für die ID dem angegebenen Parameter entspricht. * `valid...` , `...Date...` und `...ActiveOn` Die Zusätze "valid", "Date" und "ActiveOn" bedeuten, dass es möglich ist, Daten anzugeben, an oder in denen ein bestimmter Datensatz gültig war. Dies ist insbesondere bei Verträgen sinnvoll. Durch diesen Parameter können z. B. ungültige Verträge herausgefiltert werden. Das Format lautet hier "YYYY-MM-dd". * `BookingPeriodNumber...` und `BookingDate...` Die Buchungsperioden werden für die jeweiligen Geschäftsjahre angelegt. Die Anzahl und Dauer der Buchungsperioden können vom Kunden individuell festgelegt werden. Die Buchungsperiode wird als ganze Zahl ausgedrückt. Das Buchungsdatum grenzt den Zeitraum nach Datum ein. Das Format lautet hier "YYYY-MM-dd". * `FiscalYearNumber` Das Fiskaljahr wird in den Buchungen verwendet und wird im Format "YYYY" angegeben. * `includeAdditionalField`Dieser Parameter erlaubt den Einbezug von undefinierten Zusatzfelddaten. Diese Felder sind für jeden Kunden unterschiedlich und müssen durch zusätzliche Einstellungen in den Zusatzfelddefinitionen für die API freigegeben werden.\ Wurde ein Feld für die OPEN WOWI freigegeben, ist dieses für alle API-Keys verfügbar, welche auf den entsprechenden Endpunkt zugreifen können.
# Request-Limits Aktuell haben wir keine festen Limits für die Anzahl an Requests in der API-Architektur hinterlegt. Um die Stabilität der Datenbanken zu gewährleisten, können zukünftig aber derartige Limits eingeführt werden. Unsere aktuelle Empfehlung lautet, die Anzahl der API-Aufrufe auf 100 pro Minute und API-Key zu begrenzen. Wir möchten hierbei insbesondere auch darauf hinweisen, dass die OPENWOWI-Schnittstelle natürlich von vielen Partnern genutzt wird und wir die verfügbaren Ressourcen mit allen Benutzern der API teilen möchten. # FAQ - Frequently asked Questions Hier finden Sie häufig gestellte Fragen. Bitte beachten Sie, dass wir davon ausgehen, dass diese Seite mehrheitlich von Partnern genutzt wird. ## Administratives / Einrichtung
Wer ist für die Einrichtung des Zuganges zur OPENWOWI verantwortlich? Als Auftragsverarbeiter kann die Dr. Klein WOWI Digital natürlich nicht aus eigenem Antrieb heraus den Zugang zu Kundeninstanzen gewähren. Die Verantwortung liegt deshalb immer direkt beim Kunden. Wir bieten zu diesem Zweck eine ausführliche [Beschreibung der Einrichtung](/grundlagen/einrichtung-openwowi) an. Da der Kunde selten den Überblick über die von Ihnen verwendeten Endpunkte hat, fällt ein Teil der Verantwortung allerdings den Partnern zu. Um die Zusammenarbeit möglichst einfach zu gestalten, bieten wir aus diesem Grund zusätzlich eine [Checkliste](/grundlagen/checkliste-fur-die-einrichtung-in-wowiport) an, welche Ihnen bei der Einrichtung der OPENWOWI behilflich sein soll.
## Strategisches / Zusammenarbeit
Wir möchten gerne eine strategische Partnerschaft mit Ihnen vereinbaren. Sie können sich mit Ihrem Anliegen gerne an [Partnermanagement@drklein-wowi.de](mailto:partnermanagement@drklein-wowi.de) wenden. Idealerweise können Sie bereits einen Pilotkunden vorweisen, mit welchem wir dann gemeinsam die praktische Anbindung besprechen können.
Ich habe einen Bug gefunden und möchte diesen gerne prüfen lassen. Wir freuen uns immer über die Aufmerksamkeit unserer Partner und Kunden. Einen Bug können Sie direkt an melden. Alternativ natürlich auch direkt an Ihren technischen Ansprechpartner bei uns.
Unser Kunde stellt gerade sein ERP System auf WOWIPORT um. Wie stellen wir sicher, dass wir dabei berücksichtigt werden? Im Rahmen der Projektphase der Kunden werden üblicherweise auch die angebundenen Partner abgefragt. Wenn Sie sich proaktiv auf die zukünftige Anbindung vorbereiten möchten, dann können Sie sich gerne an [Partnermanagement@drklein-wowi.de](mailto:partnermanagement@drklein-wowi.de) wenden. bitte stellen Sie aber sicher, dass der Kunde hierüber informiert ist, damit es in der Projektphase nicht zu Parallelkommunikation kommt. Vor einer Anbindung können wir Ihnen bereits Zugriff auf unsere [Sandbox](/grundlagen/einrichtung-openwowi) bieten. Da die effektive Anbindung des Kunden häufig erst nach der Datenmigration Sinn macht, empfehlen wir einen Testlauf mit den Daten unserer Sandbox. Um die Migration nicht zu beeinträchtigen wird eine Anbindung der Migrations-Instanz von WOWIPORT ausdrücklich nicht gewünscht.
Wie können wir Erweiterungen in der OPENWOWI beantragen? Wenn Sie bereits Partner der OPENWOWI sind, können Sie Erweiterungen mit Ihrem technischen Ansprechpartner besprechen. Wichtige Informationen hierfür sind: * Was soll erweitert werden? * Welchem Zweck dienen die Erweiterungen? * Welches Zeitfenster steht für die Erweiterung zur Verfügung? * Welcher Kunde steht hinter dem Erweiterungswunsch? * Wer sind die Ansprechpartner für die Prozesse und die technische Umsetzung auf Ihrer Seite? Bitte beachten Sie, dass wir uns vorbehalten Erweiterungen abzulehnen, wenn diese nicht in die Gesamtplanung der OPENWOWI oder von WOWIPORT passen. Eine Liste aktueller Erweiterungswünsche finden Sie hier: [User-Requests](/releaseinformationen-user-requests-und-bugs/user-requests)
Können wir auch unser eigenes Interface (iFrame) in WOWIPORT einbauen? Diese Option ist leider nicht gegeben. Die Oberfläche von WOWIPORT soll möglichst marktneutral gestaltet bleiben. Sie haben allerdings die Möglichkeit direkte [Absprünge](/grundlagen/hyperlinks-aus-wowiport-zu-externen-anwendungen-integrieren) in Ihre Web-Umgebung zu konfigurieren.
## Technisches / API-Abrufe
Wir sind nur für für ein einzelnes Subunternehmen tätig und uns fehlen Daten in der API. Wenn Sie nur für ein Subunternehmen tätig sind, ist die Wahrscheinlichkeit groß, dass Sie nicht auf der höchsten Berechtigungsebene liegen. Sie können dann nur Daten von der Ebene abrufen, auf der Ihr User und der API Key angelegt wurde. Dazu zählen auch alle Daten, welche unterhalb Ihres Berechtigungsknotens liegen. Dies kann dazu führen, dass Daten fehlen, wenn diese auf einer höheren Berechtigungsebene liegen (z.B. übergreifend genutzte Personendatensätze). In diesem Fall muss entweder der Datensatz auf den korrekten Knotenpunkt geändert werden, oder Ihr User und API Key muss in der Berechtigungsebene angepasst werden.
Wir können die Daten paginiert abrufen, wissen aber nicht, wann wir den letzten Datensatz erreicht haben. In den Datenendpunkten (alle Endpunkte mit einem Parameter "Limit"), finden Sie im Header einen Schlüssel "Total-X-Count". Dieser gibt die Anzahl aller gefundenen Datensätze an.
Welche Version eines Endpunktes sollen wir im besten Fall verwenden? Die OPENWOWI bietet einige stabile Versionen an (Version 1.0 und 1.1), welche nur dann geändert werden, wenn WOWIPORT sich geändert hat, oder schwere Bugs gefunden werden. Zudem haben wir eine Version "Work in Progress", bei welcher laufend Änderungen vorgenommen werden. Dies ist derzeit die Version 1.2. In der Swagger finden Sie zudem eine "experimentelle API". Dies ist derzeit die Version 1.3. Wenn Sie eine Anbindung etablieren, die mit wenigen Daten auskommt oder die empfindlich auf Änderungen reagiert (z.B. Plattform-Anbindungen, welche ein festes Schema erwarten), dann empfehlen wir die stabilen Versionen. Wenn Sie eine Anbindung planen, welche noch Erweiterungen benötigt und welche mit unbekannten Daten im Schema umgehen kann, dann empfehlen wir die "Work in Progress" Version. Die "experimentelle API" empfehlen wir ausdrücklich nur nach Rücksprache mit uns.
Wir verstehen die Bedeutung der Daten nicht. Wir haben uns in der OPENWOWI bewusst für eine englische Lokalisierung entschieden, damit Entwickler aus anderen Sprachregionen nicht benachteiligt werden. Dies kann im Zweifelsfall zu Verständnisproblemen mit dem Kunden führen. Leider können wir in der API keine Übersetzungsmatrix anbieten, da die Labels in WOWIPORT reine UI-Elemente und keine verbundenen, deutschen Lokalisierungen sind. Der erste Ansatz wäre immer einen Beispieldatensatz mit dem Kunden zu besprechen und anhand dessen die Felder zu identifizieren. Dies kann natürlich auch in Kooperation mit der Dr. Klein WOWI Digital erfolgen. Ihr Kunde kann den Kontakt zu uns herstellen. Kontext zu einzelnen Funktionen der API finden Sie häufig in den erweiterbaren Abschnitten unter "Weitere Hinweise zur Funktion".
Welche Bedeutung haben die Parameter? Die Beschreibung der Parameter finden Sie hier:
Warum gibt es nicht zu jeder Entität Webhooks? Daten in WOWIPORT sind hierarchisch aufgebaut und die Speicherung eines untergeordneten Datensatzes führt üblicherweise zur Speicherung des darübergelegenen Datensatzes (Beispiel: Die Speicherung einer Vertragsposition in einem Nutzungsvertrag speichert gleichzeitig den Nutzungsvertrag). Aus diesem Grund bieten wir nur Webhooks für die übergeordneten Datensätze an. Hinzu kommt die vorhersehbare Nutzung der Webhooks. Wir bieten so Webhooks für Wirtschaftseinheiten und Nutzungseinheiten an, weil diese häufig genutzt werden, jedoch nicht für Gebäude, da diese eher als Nebendatensatz zu den Wirtschaftseinheiten behandelt werden.
# Release Informationen Für alle Entwicklungen nach dem Release der OPENWOWI 1.2 finden Sie hier entsprechende Informationen. Bitte beachten Sie, dass die Testsysteme der Kunden eine neuere Version aufweisen können als die Produktivinstanzen. ## Releaseinformationen 2026 | Release | Betroffener Endpunkt | Änderung | | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | 2026.01 | POST /openwowi/v1.2/ExternalLink/EntityLink | Performanceverbesserung bei Existenz vieler externer Links. | | 2026.02 |

POST /openwowi/v1.2/CommunicationEdit/Ticket/AddComment
POST

/openwowi/v1.2/CommunicationEdit/Ticket/AddConversation

| CommentId wurde zum Response hinzugefügt. Zudem wurde ein Fehler behoben, welcher "CommentFromApi" falsch befüllt hat. | | 2026.02 | GET /openwowi/v1.2/CommissioningRead/Commissions |

Neuer Parameter "IncludeDefect". Wird der Parameter genutzt, wird eine Liste von Mängeln zu den Aufträgen im Response mitgesendet.

Neue Filter-Parameter "CommissionTypeId" und "CraftsmanId".

| | 2026.02 | GET /openwowi/v1.2/CommunicationRead/Ticket | Neues Feld "InboundCommunication". | | 2026.03 | Neu | Neuer Katalog für "Dismissal". | | 2026.04 | GET /openwowi/v1.2/CommercialInventory/BuildingLands |

Neue Felder/Objekte

  • Zuständiger Architekt
  • Zuständiger Hauswart
  • Ebene
  • Untergebäude
| | 2026.05 | GET openwowi/v1.2/RentAccounting/ContractAgreement/IndexRentalAgreement | Aufgrund von Änderungen in WOWIPORT wurde ein zusätzliches "ReferenceDate" in die oberste Ebene des Schemas aufgenommen. | | 2026.05 | Neu | Neuer Katalog für "EnergySource" und "HeatingType". | | 2026.05 | GET /openwowi/v1.2/CommercialInventoryCatalog/ComponentCatalog | Erlaubte Ausstattungsmerkmale ergänzt. | | 2026.05 |

POST
/openwowi/v1.2/AccountancyInvoiceReceipt/RecordingNew

POST

/openwowi/v1.2/AccountancyInvoiceReceipt/AccountAssignmentNew

POST

/openwowi/v1.2/AccountancyInvoiceReceipt/ReleasedNew

GET /openwowi/v1.2/AccountancyTransactionData/InvoiceReceiptNew

|

Zusätzliche Daten:

  • ReceiptDate
  • AssessmentDateFrom
  • AssessmentDateTo
  • OwnReference
  • ConnectedInvoices
| | 2026.06 | Neu | Neuer Endpunkt für Abrechnungskreis / Kostenverbund. | | 2026.08 | GET /openwowi/v1.2/CommissioningRead/Commissions | Neuer Filter für "CommissionStatusId". | | 2026.08 | GET /openwowi/v1.2/DocumentRead/{entityName}/FileData | Daten zu veralteten Dateien (FileIsObsolete) hinzugefügt. | | 2026.08 |

GET /openwowi/v1.2/CommunicationCatalog/TicketSource

GET /openwowi/v1.2/CommunicationCatalog/TicketStatus

| Informationen zu den verfügbaren StatusIds und den Status-Bedeutungen hinzugefügt. | | 2026.08 |

GET

/openwowi/v1.2/AccountancyTransactionData/InvoiceReceipt

GET

/openwowi/v1.2/CommissioningRead/InvoiceReceipt/CommissionItems

GET

/openwowi/v1.2/AccountancyInvoiceReceipt/NewInvoice/{id}

GET

/openwowi/v1.2/AccountancyInvoiceReceipt/NewInvoice/{id}

GET

/openwowi/v1.2/AccountancyTransactionData/InvoiceReceiptNew

GET

/openwowi/v1.2/CommissioningRead/InvoiceReceiptNew/CommissionItems

| Kreditor zu den Rechnungs-Endpunkten hinzugefügt. | | 2026.09 | Neu | Neuer Endpunkt für Übermittlung von Verbrauchsdaten zu Rechnungen zu Rechnungen | | 2026.09 | GET /openwowi/v1.2/DunningRead/Dunningincident | Verbindung zum Nutzungsvertrag hergestellt | | 2026.09 | GET /openwowi/v1.2/RentAccounting/LicenseAgreements | Genehmigungen sind jetzt über den Parameter "IncludeApprovals" verfügbar | | 2026.10 |

POST /openwowi/v1.2/AccountancyInvoiceReceipt/RecordingNew

POST /openwowi/v1.2/AccountancyInvoiceReceipt/AccountAssignmentNew

POST /openwowi/v1.2/AccountancyInvoiceReceipt/ReleasedNew

| Die BookingTypeId kann nun mit angegeben werden | | 2026.10 | PUT/POST /openwowi/v1.2/AccountancyMasterDataWrite/Creditor | Änderungen in der Mechanik bei der Vergabe von Kreditorennummern. Die Nummernlogik von WOWIPORT wird nun vorrangig berücksichtigt. | | 2026.11 | GET /openwowi/v1.2/CommissioningRead/CraftProcesses | "Status Versicherungsportal" sowie neuen Katalog hinzugefügt. | | 2026.11 | Neu | Neuer Endpunkt um einen Kommunikationsweg auf "Standard" zu setzen. | | 2026.11 |

POST/PUT /openwowi/v1.2/AccountancyMasterDataWrite/Creditor
POST/PUT /openwowi/v1.2/AccountancyMasterDataWrite/Debitor

|

Anpassungen für Kunden mit automatischer Nummernvergabe.
Die automatische Nummernvergabe hat nun Vorrang vor der Angabe in der IdNum.

| ## Releaseinformationen 2025 | Release | Betroffener Endpunkt | Änderung | | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 2025.01 | Neu | Neue Endpunkte für Verkehrssicherung. | | 2025.01 | Neu | Neuer Endpunkt für Sondernutzungsrechte. | | 2025.01 | GET /openwowi/v1.2/CooperativeManagement/CooperativeMemberships | "Bemerkungen" - Tab dem Datenmodell hinzugefügt. | | 2025.01 | GET/openwowi/v1.2/PersonsRead/Persons GET/openwowi/v1.2/PersonsRead/Persons/{Id} | "Kontaktpräferenz" dem Datenmodell hinzugefügt. | | 2025.01 | GET /openwowi/v1.2/CommercialInventory/EnergyCertificates | "Baujahr Wärmeerzeuger" dem Datenmodell hinzugefügt. | | 2025.01 |

GET openwowi/v1.2/AccountancyInvoiceReceipt/{id}

GET openwowi/v1.2/AccountancyVoucherProcess/{id}

GET openwowi/v1.2/SuggestedContractor/SuggestedContractor/{id}

GET openwowi/v1.2/PersonsRead/Person/{id}

| Inkonsistenz in der Datumsformatierung korrigiert. | | 2025.02 | GET/openwowi/v1.2/CommissioningRead/Commissions | Neuer Parameter "IncludeCommissionDetails" mit zusätzlichen Auftragsdaten sowie Daten zu verantwortlichen Personen. | | 2025.02 | GET /openwowi/v1.2/CommissioningRead/CraftProcesses |

Zusätzlicher Parameter "IncludeInvoiceReceipt" welche die zugehörigen Rechnungs-IDs ausgibt.
Daten zur Wirtschaftseinheit, Sachbearbeiter und Leistungspaketen hinzugefügt.

| | 2025.02 | POST/PUT /openwowi/v1.2/CommissioningEdit/CraftProcesses | Wirtschaftseinheiten können nun übertragen werden. | | 2025.02 | POST /openwowi/v1.2/SafetyInspectionEdit/SafetyInspection | IdNum hinzugefügt | | 2025.02 | GET /openwowi/v1.2/CommercialInventory/UseUnits |

Daten zur Mitgliedschaft hinzugefügt

  • Notwendige Anteile
  • Anteilskategorie

Neuer Parameter zur Filterung nach "CaretakerId" (Hauswart), sowie korrespondierende Daten im Endpunkt.

| | 2025.03 | GET /openwowi/v1.2/RentAccounting/ContractSecurity | IdNum dem Datenmodell hinzugefügt | | 2025.04 |

POST /openwowi/v1.2/CommissioningEdit/Commission | | |
POST /openwowi/v1.2/CommissioningEdit/Commission/WaitForCraftsmanFeedback

| Zusätzliche Daten zu Ausstattungen und zum Schadenszeitpunkt | | | 2025.04 | Neu | Neuer Webhook für Vorgänge (Auftragswesen) | | 2025.04 | Neu | Neue Endpunkte zum Erstellen von Projekten | | 2025.05 |

GET/openwowi/v1.2/Commissioning/CraftProcesses

POST/openwowi/v1.2/CommissioningEdit/CraftsProcess

PUT/openwowi/v1.2/CommissioningEdit/CraftsProcess/{id}

| Neue Daten zu Versicherungen in den Vorgängen | | 2025.05 | Neu | Neue Kataloge zu Schadenssparte und Schadensursachen | | 2025.05 |

POST /openwowi/v1.2/PersonsWrite/Person

PUT /openwowi/v1.2/PersonsWrite/Person/{personId}

GET

/openwowi/v1.2/PersonsRead/Persons

| Neue Daten zur Betreuung einer Person | | 2025.06 | Neu | Endpunkte für Abrechnungskreise und -perioden | | 2025.06 | GET /openwowi/v1.2/PersonsRead/Persons | Neuer Parameter um Kontakt-Verbindungen zwischen juristischen und natürlichen Personen aufzulisten. | | 2025.06 | Neu | Neuer Katalog um die möglichen Personen Rollen abzufragen. | | 2025.06 | GET /openwowi/v1.2/CommercialInventory/EconomicUnits | Management Id und Code hinzugefügt | | 2025.08 |

get

/openwowi/v1.x/CommissioningRead/CraftProcesses (all Versions)

post /openwowi/v1.2/CommissioningEdit/CraftsProcess

put /openwowi/v1.2/CommissioningEdit/CraftsProcess/{id}

post /openwowi/v1.2/CommissioningEdit/Commission

post /openwowi/v1.2/CommissioningEdit/Commission/WaitForCraftsmanFeedback

| Neue Daten zur Vorgangsbezeichnung sowie Änderung eines Knotenpunktnamens von "DamageCauseSlim" auf "DamageCause" | | 2025.08 |

GET /openwowi/v1.2/PersonsRead/Persons

PUT / POST /openwowi/v1.2/PersonsWrite/Person/(Id)

| Daten "VIP" und "Confidential" zum Datenmodell hinzugefügt | | 2025.08 |

POST /openwowi/v1.2/ManageFacilityAndComponents/Facility/{facilityId}/Component

PUT /openwowi/v1.0/ManageFacilityAndComponents/Facility/{facilityId}/Component/{componentId}

GET /openwowi/v1.2/CommercialInventory/Component

GET /openwowi/v1.2/CommercialInventory/Component/{id}

| "MarketlocationIdentifcationNumber" zum Knoten "MeteringDevice" hinzugefügt | | 2025.08 | GET /openwowi/v1.2/CommissioningRead/Commissions | Zusätzliche Daten zu Projekten, Grundstücken, Abteilungen und Fremdverwaltungsverträgen, sowie zur Versandart | | 2025.08 | GET /openwowi/v1.2/AccountancyMasterData/Creditors | Zusätzliche Daten "ExemptionCertificateUnnecessary" | | 2025.09 | GET /openwowi/v1.2/CommunicationRead/Ticket | In Vorbereitung einer künftigen E-Mail Verarbeitung im Kommunikationscenter, wurde die Node "Comments" um die Personendaten ergänzt, mit welcher die Kommunikation geführt wird. | | 2025.09 | GET /openwowi/v1.2/CommissioningRead/CraftProcesses | Neuer Filter-Parameter nach "CommissionId" und "InvoiceReceiptId" | | 2025.10 | GET /openwowi/v1.2/AccountancyMasterData/Projects | "Lands" wurden dem Schema hinzugefügt | | 2025.10 |

GET

openwowi/v1.2/CommissioningRead/InvoiceReceipt/CommissionItems

GET

openwowi/v1.2/CommissioningRead/InvoiceReceipt/PaymentOrders

| Die Endpunkte haben einen zusätzlichen Parameter "CommissionId" erhalten, welcher die Daten aus dem "Rechnungs-Tab" in WOWIPORT enthält. Eine konkrete Zuordnung der Auftrags- und Rechnungspositionen ist nicht mehr notwendig. | | 2025.12 |

GET /openwowi/v1.2/ExternalLink/EntityLink

POST /openwowi/v1.2/ExternalLink/EntityLink

PUT /openwowi/v1.2/ExternalLink/EntityLink/{entityLinkId}

| Den Links kann jetzt ein "Custom Label" mitgegeben werden, welches als Ersatztext für den Namen der Konfiguration dient. Damit kann man den Link auch individuell benennen. | | 2025.12 |

GET
/openwowi/v1.2/CommissioningRead/CraftProcesses

POST
/openwowi/v1.2/CommissioningEdit/CraftsProcess

PUT
/openwowi/v1.2/CommissioningEdit/CraftsProcess/{id}

| "InsuranceContractId" zum Endpunkt hinzugefügt | | 2025.12 |

GET
openwowi/v1.2/PersonsRead/Person/{id:int}

GET | | |
openwowi/v1.2/PersonsRead/Person/UserGuid

GET | | | |
openwowi/v1.2/PersonsRead/Persons

GET | | | |
openwowi/v1.2/CommercialInventory/Managements

GET | | | |
openwowi/v1.2/CommercialInventory/Owners

GET | | | |
openwowi/v1.2/AccountancyMasterData/Creditors

GET | | | |
openwowi/v1.2/CommercialInventory/Architect

GET | | | |
openwowi/v1.2/CommercialInventory/Caretaker

GET | | | |
openwowi/v1.2/CommercialInventory/ResponsibleOfficial

GET | | | |
openwowi/v1.2/CommissioningRead/Craftsman

GET | | | |
openwowi/v1.2/RentAccountingPersonDetails/HandoverContractParties

GET | | | |
openwowi/v1.2/RentAccountingPersonDetails/Contractors

GET | | | |
openwowi/v1.1/RentAccountingPersonDetails/Contractors

GET | | | |
openwowi/v1.2/SuggestedContractor/SuggestedContractor

GET

| | | | openwowi/v1.2/SuggestedContractor/SuggestedContractor/{id:int}

GET | | | |
openwowi/v1.2/CooperativeManagementPersonDetails/Members

GET | | | |
openwowi/v1.2/Loans/Borrower

GET | | | |
openwowi/v1.2/Loans/Lender

| Das Feld Kontaktpräferenz wurde in WOWIPORT entfernt. Entsprechend wird ach das API Feld "ContactPreference" aus der OPENWOWI gelöscht. | | | 2025.12 | GET /openwowi/v1.2/AccountancyTransactionData/MasterAccountBookings |

Neue Filterparameter:

  • SuccessDateFrom
  • SuccessDateTo
  • ReleaseDateFrom
  • ReleaseDateTo
| | 2025.12 | GET openwowi/v1.2/DocumentRead/{entityName}/FileData/ | Neues Feld "DocumentName" | | 2025.12 |

GET | | |
/openwowi/v1.2/CommunicationRead/Ticket

|

Neue Felder

  • CreatedByUserId"
  • UserId
  • CreatedByApiUser
  • ShareStatus

Die Felder werden automatisch gesetzt bzw. können nur vom User in der WOWIPORT Benutzeroberfläche gesetzt werden.

| | | 2025.13 |

GET /openwowi/v1.2/CommissioningCatalog/DamageDivisions
GET
/openwowi/v1.2/CommissioningCatalog/DamageCauses

| Anpassungen zur Benennung der Schlüssel und neue Felder | | 2025.13 | Neu | Neuer Endpunkt für die Anlage von Debitoren | | 2025.13 | Neu | Neue API für das Mahnwesen | | 2025.13 | Neu | Neue Endpunkte für SEPA Mandate | | 2025.14 | Neu | Schreibende Endpunkte für Schadensursachen und Schadenssparte sowie Endpunkte für Versicherungsverträge und Versicherungsunternehmen. | | 2025.14 | Neu | Neuer Endpunkt zur Anlage von Kreditoren | | 2025.14 |

POST
/openwowi/v1.2/PersonsWrite/Person
PUT /openwowi/v1.2/PersonsWrite/Person/{Id}

| Möglichkeit integriert, die IdNum bei der Übertragung mitzusenden. Diese Funktion steht nur zur Verfügung, wenn in WOWIPORT kein Nummernkreis für Personen definiert wurde. | | 2025.15 | GET /openwowi/v1.2/AccountancyVoucherProcess/{id} | Der Endpunkt wurde entfernt. Die Funktionen übernimmt der Endpunkt GET /openwowi/v1.2/AccountancyTransactionData/VoucherProcess | | 2025.15 | Neu |

Endpunkt für Buchungen.
Der Endpunkt wurde leider im falschen Controller angelegt und wird kurzfristig noch Änderungen erfahren.

| | 2025.15 | GET /openwowi/v1.2/PropertyManagement/PropertyManagementContracts | Eigene Referenz, Verwaltungsart und Zahlungsverkehrsdaten hinzugefügt | | 2025.15 | Neu |

Neue Endpunkte zu Fremdverwaltungsverträgen:

  • Vertragsvereinbarungen
  • Vertragsnehmer
  • Zahlungsmodus
| | 2025.15 |

POST /openwowi/v1.2/MediaEdit/{entityName}/Media

PUT /openwowi/v1.2/MediaEdit/{entityName}/Media/{id} (new)

GET /openwowi/v1.2/MediaEdit/{entityName}/Media/{id}

|

Für Medien wurden zusätzliche Daten in den schreibenden und lesenden Endpunkten bereitgestellt.

  • Bildtyp
  • Beschreibung
  • Vermietung
  • Mietverträge
| | 2025.15 |

GET

/openwowi/v1.2/CommissioningCatalog/CommissionTypes

| Die Standardrechnungsart und die erlaubten Rechnungsarten der neuen Eingangsrechnung wurden dem Datenmodell hinzugefügt. | | 2025.15 | Neu | Release der Endpunkte zur neuen Eingangsrechnung. | | 2025.15 |

GET

openwowi/v1.0/CommercialInventory/Component

GET

openwowi/v1.1/CommercialInventory/Component

GET

openwowi/v1.2/CommercialInventory/Component

GET

openwowi/v1.0/CommercialInventory/Component/{id:int}

GET

openwowi/v1.1/CommercialInventory/Component/{id:int}

GET

openwowi/v1.2/CommercialInventory/Component/{id:int}

| Die Felder "InsertAutomaticResubmission" und "ResubmissionDate" wurden in WOWIPORT entfernt. Entsprechend wurden die Felder auch aus der OPENWOWI entfernt. | | 2025.16 | Authentifizierungen für Webhooks | Die maximale Anzahl der Zeichen für die Webhook- Authentifizierungen wurde von 70 auf 1000 Zeichen erweitert | | 2025.16 | Neu | Neuer Endpunkt für "Konversationen" zu Tickets. Der Endpunkt für "Kommentare" bleibt kompatibel, wird aber durch den neuen Endpunkt ersetzt. | | 2025.16 | GET /openwowi/v1.2/CommunicationCatalog/TicketSource | Erweiterung der Daten um Informationen zur Anlage und Interpretation von Konversationen. | | 2025.16 | GET /openwowi/v1.2/CommunicationRead/Ticket | Erweiterung der "Comments" um die Daten der Konversationen. | | 2025.17 | Neu | Endpunkt für Ausgangsrechnungen | ## Releaseinformationen 2024
ReleaseBetroffener EndpunktÄnderung
2024.03NeuNeue Endpunkte für Medien (Fotos)
2024.07NeuNeue Endpunkte für die Anlage von Wohnungsübergaben
2024.07NeuNeue Endpunkte für die Zuordnung von Kontaktpersonen zu Firmen
2024.07GET /openwowi/v1.2/BudgetingRead/Budget

Durch Änderungen in WOWIPORT musste der Schlüssel "ExceedAllowed" entfernt werden und wurde durch folgende Schlüssel ersetzt:

  • Orderlock
  • InvoiceEnterLock
  • ReleaseLock
  • VoucherProcessReleaseLock
2024.07NeuNeuer Endpunkt für Änderungsgründe des Mietvertrages
2024.07GET /openwowi/v1.2/AccountancyMasterData/MasterAccounts"Weitere Parameter"-Sektion der Hauptkonten hinzugefügt.
2024.08POST/ PUT /openwowi/v1.2/PersonsWrite/Person/({personId})
und
neue Kataloge

Zusätzliche Informationen zu den natürlichen und juristischen Personen sind übertragbar.

  • IndustryId
  • CompanyFormId
  • VipId
  • Confidential
  • TaxNumber
  • TaxIdentificationNumber
2024.08GET /v1.2/AccountancyTransactionData/MasterAccountBookings

Zusätzliche Daten zum Buchungsvorgang und Parameter "includeAccountancyRelations"

  • OwnReference
  • PartnerReference
  • VoucherId
  • VoucherNumber
2024.08GET /openwowi/v1.2/CommissioningCatalog/CommissionTypes

Zusätzliche Daten zu erforderlichen Feldern

  • IsDepartmentMandatory
  • IsBudgetMandatory
  • IsResponsibleOfficialMandatory
  • IsProjectMandatory
  • MandatoryInternalDescription
  • IsExecutionFromMandatory
  • IsExecutionToMandatory
  • IsCompletionDateMandatory
  • IsCommissionCodeMandatory
  • IsLocked
  • IsFacility
  • AllowEmptyAmount
  • SelfServiceExecutionForCommissions

2024.09neu

Endpunkte für Vertragsvereinbarungen:

  • Mietanpassungesperre BGB
  • Mahngebühren fester Betrag
  • Mahngebühren Zinsen
  • Mehrfaches optionsrecht
  • Kündigungsverzicht
  • Kleinreparaturen

sowie zugehörige Kataloge

2024.10GET /openwowi/v1.2/CooperativeManagement/CooperativeMembershipsOrganfunktionen über zusätzlichen Parameter und entsprechender Katalog hinzugefügt.
2024.10GET /openwowi/v1.2/CooperativeManagement/CooperativeMembershipAnteilsübersicht über zusätzlichen Parameter hinzugefügt
2024.10neuNeuer Endpunkt und neue Endpunktberechtigungen für personenbezogene Daten zu Mitgliedern.
2024.10neuKontenschreibung für Mitgliedschaften
2024.11WebhooksDer letzte "/" wurde aus dem Schlüssel "applicationBaseURL" entfernt, damit die Daten konsistent zu einer URL zusammengesetzt werden können.
2024.11GET /openwowi/v1.2/PersonsRead/Person/{personId}/AssignmentsZuordnungen zu den Entitäten und deren Objekten hinzugefügt (Relations)
2024.11GET /openwowi/v1.2/CooperativeManagement/CooperativeMemberships

Neue Parameter und Daten:

  • IncludePaymentAssignments
  • IncludeRateAgreements
  • IncludeHousingSubsidy
2024.11neuNeuer Endpunkt und Kataloge für Bewegungen von Mitgliedsanteilen
2024.11NeuEndpunkt für Zahlungsarten von Mitgliedern
2024.12NeuExterner Link aus WOWIPORT für Kreditoren hinzugefügt
2024.12NeuNeue Endpunkte für die Anlage von Bankkonten.
2024.14NeuNeuer Webhook für Mitgliedschaften
2024.14NeuNicht beschränkter Endpunkt für Buchungsbelege
2024.14GET /openwowi/v1.2/AccountancyVoucherProcess/{id}Erweiterung um Felder zum BookingRuleType
2024.14NeuNeuer Katalog-Endpunkt zum Buchungsregeltyp
2024.14NeuEndpunkte zu Steuerinformationen der Mitgliedschaft
2024.15

GET /openwowi/v1.2/AccountancyTransactionData/InvoiceReceipt

GET /openwowi/v1.2/CommissioningRead/InvoiceReceipt/CommissionItems

"InvoiceType" zum Endpunkt hinzugefügt
2024.15GET /openwowi/v1.2/CooperativeManagement/CooperativeMemberships"Responsible"Official zum Endpunkt hinzugefügt
2024.15NeuNeuer Endpunkt für die Zuständigkeit in Verträgen
2024.15GET /openwowi/v1.2/RentAccounting/ContractAgreement/MultipleOptInAgreement"OptionDeadline" hinzugefügt
2024.15NeuNeue Endpunkte für GET/POST/PUT/DELETE von Beschreibungen. Die Änderungen waren notwendig, da sich die Datenstruktur in WOWIPORT verändert hat.
2024.16POST /openwowi/v1.2/CommunicationEdit/Ticket
GET /openwowi/v1.2/CommunicationRead/Ticket		Externe Referenz zum Datenmodell hinzugefügt
2024.16

POST/PUT /openwowi/v1.2/DefectEdit/Defect

GET /openwowi/v1.2/CommercialInventory/Defects

Schadenszeitpunkt zum Datenmodell hinzugefügt
2024.17GET /openwowi/v1.2/AccountancyMasterData/ProjectsDiverse Erweiterungen der Parameter und Daten.
2024.17GET /openwowi/v1.2/RentAccounting/ContractPositionsNeuer Parameter "ContractPositionTypeId"
2024.17

GET /openwowi/v1.2/AccountancyInvoiceReceipt/{id}

GET /openwowi/v1.2/AccountancyTransactionData/InvoiceReceipt

GET /openwowi/v1.2/CommissioningRead/InvoiceReceipt/CommissionItems

Angleich der Datenmodelle für bessere Kompatibilität.
2024.17GET /openwowi/v1.2/BudgetingRead/BudgetNeuer Parameter "IncludeProject" sowie das dazugehörige Datenmodell und Daten zum zuständigen Sachbearbeiter.
2024.17GET /openwowi/v1.2/AccountancyTransactionData/MasterAccountBookings

Neu Daten im Datenmodell:

  • IsHidden
  • IsGeneralReversal
  • IsGeneralReversalOf
2024.17GET openwowi/v1.2/CommunicationRead/Ticket

Neue Daten im Datenmodell:

  • CreatedByUserId
  • CreatedByApiUser
## Releaseinformationen 2023
ReleaseBetroffener EndpunktÄnderung
2023.09AlleRelease OPENWOWI 1.2
2023.10NeuNeue Endpunkte für Wohnungsübergaben.
Dokumentation erfolgt nach Fertigstellung weiterer Endpunkte.
2023.10/openwowi/v1.2/CommercialInventory/UseUnitsZusätzliche Ausgabe von Schlüsseln zur Nutzungseinheit
2023.10NeuNeuer Endpunkt "/openwowi/v1.2/CommissioningEdit/Commission/{Id}/Done" für die Übergabe von Aufträgen in den Status "Erledigt"
2023.10/openwowi/v1.2/PropertyManagement/PropertyManagementContractsDatum zur Gültigkeit in der Verwaltungsgesellschaft hinzugefügt
2023.10/openwowi/v1.2/CommunicationRead/
und /openwowi/v1.2/CommunicationEdit/Ticket		Abteilungs-ID und die ID des Benutzers hinzugefügt
2023.10NeuNeuer Endpunkt zur Abfrage und Erfassung von Mängeln
2023.10/openwowi/v1.2/AccountancyInvoiceReceipt/Recording
und
/openwowi/v1.2/AccountancyInvoiceReceipt/AccountAssignment
und
/openwowi/v1.2/AccountancyInvoiceReceipt/Released		Die Dokumenten-ID für ein Dokument im WOWIPORT-DMS kann nun im Rechnungsendpunkt mitgeliefert werden.
2023.10NeuEndpunkt und Kataloge für Abteilungen hinzugefügt
/openwowi/v1.2/CommercialInventory/Department
/openwowi/v1.2/CommercialInventoryCatalog/DepartmentType
/openwowi/v1.2/CommercialInventoryCatalog/DepartmentSubtype
2023.11Alle Endpunkte mit Personen-DatenNodeId hinzugefügt
2023.11Anpassungen in WOWIPORTBETA-Test: Statische Links zu Partneranwendungen können nun in WOWIPORT hinterlegt werden. Für die Nutzung muss eine Freischaltung durch Dr. Klein Wowi Digital erfolgen.
Finale Freigabe ab Release 2023.14
2023.12

POST /openwowi/v1.2/AccountancyInvoiceReceipt/Recording

/openwowi/v1.2/AccountancyInvoiceReceipt/AccountAssignment

/openwowi/v1.2/AccountancyInvoiceReceipt/Released

GET
/openwowi/v1.2/CommissioningRead/InvoiceReceipt/CommissionItems

/openwowi/v1.2/AccountancyInvoiceReceipt/{id}

/openwowi/v1.2/AccountancyTransactionData/InvoiceReceipt

Hinzufügen der
Sachbearbeiter-ID, Wirtschaftseinheiten-ID,
Abteilungs-ID,
Projekt-ID
2023.12Anpassungen in WOWIPORTWebhook für Buchungen
2023.12GET /openwowi/v1.2/AccountancyTransactionData/MasterAccountBookingsNeuer Parameter für Abfrage nach BookingId
2023.13GET
/openwowi/v1.2/RentAccounting/ContractAgreement/GraduatedRentAgreement		Einschluss der "NV-Positionsarten"
2023.13GET
/openwowi/v1.2/RentAccounting/ContractPositions		Einschluss "NV Positionsarten"
2023.13

GET /openwowi/v1.2/CommercialInventory/UseUnit/Jurisdiction

GET /openwowi/v1.2/CommercialInventory/EconomicUnit/Jurisdiction

Zusätzliche Ausgabe der Department-ID
2023.13GET /openwowi/v1.2/CommissioningRead/Commissions

Neue Felder

  • DamageReportCode
  • DamageLocation
  • DamageReportBy
2023.13GET /openwowi/v1.2/CommissioningRead/CraftProcesses

Neue Felder

  • CraftsProcessDateFrom
  • CraftsProcessDateTo
2023.13NeuNeuer Katalog für "SalesTaxId".
Einbettung in Dokumentation erfolgt nach Update der Swagger-Datei.
2023.13

GET

openwowi/v1.2/CommissioningRead/Commissions

Neuer Parameter "includeResponsibleOfficialRepair"
und neue Node mit zuständigem Sachbearbeiter
2023.13GET openwowi/v1.2/CommissioningRead/CommissionsÄnderung des Datenobjektes für Parameter "includeCommissionItems"
Anpassung des Datenobjektes für "ComponentCatalog" und "FacilityCatalog"
2023.13GET
openwowi/v1.2/CommissioningRead/ServiceCatalogue		Materialkosten und Arbeitskosten hinzugefügt
2023.14GET
/openwowi/v1.2/CommissioningRead/InvoiceReceipt/CommissionItems
GET
/openwowi/v1.2/AccountancyTransactionData/InvoiceReceipt

Neue Felder

  • ResponsibleOfficialId
  • DepartmentId
  • EconomicUnitId
  • ProjectId
2023.14GET
/openwowi/v1.2/CommissioningRead/Commissions		Neuer Parameter "IncludeAlsoCanceledCommissionItems"
2023.14NeuNeuer Katalog
/openwowi/v1.2/AccountancyMasterDataCatalog/InvoiceType
2023.14GET openwowi/v1.2/CommissioningRead/Commissions /commission

Neues Feld

  • CraftsmanPortalImportDate
2023.14GET
/openwowi/v1.2/CommissioningRead/Commissions
GET
/openwowi/v1.2/CommissioningRead/InvoiceReceipt/CommissionItems

Neues Feld

  • TransferToCraftsmanPortalWithoutCosts
2023.14NeuEndpunkt für Personen-Rollen
GET
/openwowi/v1.2/PersonsRead/Person/{personId}/Assignments
2023.15NeuEndpunkte für WEG Verwaltung
GET
/openwowi/v1.2/CondominiumManagementRead/AdvisoryBoardMember
GET
/openwowi/v1.2/CondominiumManagementRead/AdvisoryBoardSettlement

Derzeit nur für interne Nutzung vorgesehen.
2023.15NeuNeuer Endpunkt für Leistungspakete
GET
/openwowi/v1.2/CommissioningRead/ServicePackage
GET
/openwowi/v1.2/CommissioningRead/Craftsman/{craftsmanId}/ServiceCatalogue
2023.15NeuNeue API für Budget
2023.15GET /openwowi/v1.2/AccountancyTransactionData/MasterAccountBookings

Neue Felder

  • OptionTaxPercentage
  • OptionTaxSource
  • OriginalOptionAmount
  • OriginalGrossAmount

2023.16NeuNeuer Endpunkt um den Auftragsstatus auf "Storniert" zu ändern.
PUT
/openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/Canceled
2023.16

GET

/openwowi/v1.2/PersonsRead/Persons

/openwowi/v1.2/CommissioningRead/Commissions
/openwowi/v1.2/CommissioningRead/CraftProcesses

/openwowi/v1.2/AccountancyTransactionData/InvoiceReceipt
/openwowi/v1.2/AccountancyInvoiceReceipt/{id}
/openwowi/v1.2/AccountancyMasterData/MasterAccounts

/openwowi/v1.2/PropertyManagement/PropertyManagementContracts

/openwowi/v1.2/CooperativeManagement/CooperativeMemberships

/openwowi/v1.2/CommercialInventory/EconomicUnits
/openwowi/v1.2/CommercialInventory/BuildingLands
/openwowi/v1.2/CommercialInventory/UseUnits
/openwowi/v1.2/CommercialInventory/Owners
/openwowi/v1.2/CommercialInventory/Facility
/openwowi/v1.2/CommercialInventory/Facility/{id}
/openwowi/v1.2/CommercialInventory/Component
/openwowi/v1.2/CommercialInventory/Component/{id}

/openwowi/v1.2/RentAccounting/LicenseAgreements

/openwowi/v1.2/Loans/Loan

Zusatzfelder können nun für diese Endpunkte für die Ausgabe konfiguriert werden.
Weitere Informationen finden Sie unter den Parametern der OPENWOWI.
2023.16NeuNeuer Endpunkt für Ausstattungsmerkmale.
GET /openwowi/v1.2/CommercialInventory/UnderComponents
2023.16GET/POST/PUT /openwowi/v1.2/CommercialInventory/ComponentNeue Node für Ausstattungsmerkmale hinzugefügt
2023.16NeuNeuer Endpunkt für den Abruf der Zahlungsmodalitäten eines Mieters
GET /openwowi/v1.2/RentAccountingPersonDetails/PaymentMode
2023.16Neue APIEine neue API für Dokumente wird für die Nutzung freigegeben. Die Dokumentation erfolgt in Kürze.
# User-Requests Die OPENWOWI entwickelt sich stetig weiter. Auf dieser Seite informieren wir über Änderungswünsche unserer User und deren Stand.
Betroffener EndpunktFunktionAktueller Stand
NeuSchreibende Endpunkte für ZusatzdatenfelderFinal abgelehnt. Die Zusatzdatenfelder erfüllen keine prozessrelevanten Funktionen und sind zudem sehr kundenspezifisch. Eine API für diese Daten wird nicht angeboten.
NeuSchreibende Endpunkte für ObjekteFinal abgelehnt.
Die Prüfroutinen und Verbindungen des Bestandes zu allen anderen Entitäten ist zu komplex um diese alleine der API zu überlassen. Die Anlage der Objekte soll auch weiterhin in WOWIPORT erfolgen.
NeuSchreibende Endpunkte für NutzungsverträgeFinal abgelehnt.
Die Anlage und Verwaltung von Nutzungsverträgen ist einer der Kernprozesse von WOWIPORT. Die Prüfroutinen können nur bedingt über externe Systeme abgebildet werden. Fehler in der Anlage können nur bedingt in der Benutzeroberfläche korrigiert werden. Wir bieten für die Anlage von Folgemietverträge die Endpunkte für "Vorgeschlagene Vertragsnehmer" an.
NeuAusgabe der Ordnungsbegriffe der Ablesedienstleister.
Hierfür ist eine neue Architektur für die API "Umlagenabrechnung" notwendig. 		Zurückgestellt wegen Refactoring
NeuEndpunkte für UmlagenabrechnungZurückgestellt wegen Refactoring
NeuEndpunkte für die Anbindung von SignaturendienstleisternZurückgestellt
NeuEndpunkte für EigentümerversammlungenZurückgestellt. Aktuell fehlen Partner, welche die Verwendung der API zusagen würden. Bei fester Zusage mit Pilotkunden wird das Thema erneut beurteilt.
NeuErweiterung der Endpunkte zu FremdverwaltungsverträgenWird geprüft
NeuWEG Endpunkt für VerwaltergebührenWird geprüft
NeuEndpunkte für WEG VerträgeWird geprüft
NeuEndpunkte für Anlage von AbleseergebnissenWird geprüft
# Bekannte Bugs Auf dieser Seite finden Sie Informationen über bekannte Probleme mit der OPENWOWI 1.2 und Informationen über den Stand des Bugfixings. ## Gemeldete Bugs
Betroffener EndpunktFehlerbeschreibungAktueller StandPriorität
Alle GET Methoden mit PersonendatenDeathDate wird hier im Format "1900-01-01T00:00:00.000Z" angegeben.
Um die Datenstruktur in Produktivsystemen nicht zu stören, wird eine Behebung allerdings erst in der Version 1.3 erfolgen.		Nicht geplantNiedrig
Alle Zusatzdatenfelder im Format Date und Date/TimeDatumsangaben werden im Format TT/MM/YYYY übertragen.
Um die Datenstruktur in Produktivsystemen nicht zu stören, wird eine Behebung allerdings erst in der Version 1.3 erfolgen.		Nicht geplantNiedrig
GET /openwowi/v1.2/PersonsRead/PersonsDie Node "LegalPerson" enthält die Node "ContractPerson". Dies ist ein Schreibfehler und sollte "ContactPerson" lauten.
Um die Datenstruktur in Produktivsystemen nicht zu stören, wird eine Behebung allerdings erst in der Version 1.3 erfolgen.		Nicht geplantNiedrig
## Behobene Bugs
Betroffener EndpunktFehlerbeschreibungAktueller Stand
GET
/openwowi/v1.2/PropertyManagement/PropertyManagementContracts		Fehlende Daten zur Gültigkeit in der VWG Behoben in Sprint 2023.10
POST
/openwowi/v1.2/CommunicationEdit/Ticket		Es können IDs angegeben werden, welche nicht für die Entitäten vorhanden sind.Behoben in Sprint 2023.13
POST
/openwowi/v1.2/AccountancyInvoiceReceipt/Recording		Fehlerhafte Übergabe von LohnkostenBehoben mit Hotfix in Sprint 2023.12
WebhooksGelöschte Webhooks zählen zu "aktiven" Webhooks und verhindern die Doppelverwendung von URLs.Behoben in Sprint 2023.13
GET
/openwowi/v1.2/CommissioningRead/ServiceCatalogue		Werden mehrere Vorgangsarten in einer Leistungsposition geführt, wird die Leistungsposition gedoppelt.

Eine Umstellung auf Datentyp "Array" für die Vorgangsarten war notwendig.		Behoben in Sprint 2023.13
GET
/openwowi/v1.2/CommissioningCatalog/CommissionTypes		Schreibfehler (CraftsesProcessType) korrigiertBehoben in Sprint 2023.13
GET
/openwowi/v1.2/AccountancyMasterData/MasterAccounts		Für den Parameter "additionalAccountType" = 24 wird ein Fehler zurückgegeben.Behoben in Sprint 2023.14
GET
/openwowi/v1.2/SuggestedContractor/SuggestedContractor		Person wird mit NULL zurückgegeben.Behoben in Sprint 2023.15
GET /openwowi/v1.2/DocumentRead/{entityName}/FileDataTemplate Node und DataPrivacy Key sind immer NULLBehoben in Sprint 2023.16
GET /openwowi/v1.2/AccountancyTransactionData/MasterAccountBalancesWird nur ein AdditionalAccountType, ohne Auswahl eines AdditionalAccountValues angegeben, können fehlerhafte Werte als "CarryForward" ausgegeben werden. Behoben in Sprint 2024.03
Webhook FilesDie Entität wird im Webhook nicht angegebenBehoben in Sprint 2024.03
GET /openwowi/v1.2/RentAdjustment/UseUnitRentAdjustmentsDie Mietspiegel Kriterien wurden, nach Änderungen in WOWIPORT, nicht korrekt angezeigt.Behoben in Sprint 2024.09
POST openwowi/v1.2/AccountancyInvoiceReceipt/AccountAssignmentBei bestimmten Konfigurationseinstellungen kann die Fälligkeit nicht an die Buchung übergeben werden.Behoben in Sprint 2024.09
Fälligkeitsdaten werden nun immer übergeben
GET /openwowi/v1.2/PersonsRead/PersonsDer Schlüssel "Titel" wird nicht korrekt wiedergegebenBehoben in Sprint 2024.10
POST /openwowi/v1.2/CommissioningEdit/CraftsProcessAPI Key Konfiguration "Alle Buchwerke" wurde nicht korrekt angewendetBehoben in Sprint 2024.11

POST

/openwowi/v1.2/DefectEdit/Defect

POST

/openwowi/v1.2/HandoverEdit/Handover

POST

/openwowi/v1.2/SuggestedContractor/SuggestedContractor

API Key Konfiguration "Alle Buchwerke" wird nicht korrekt angewendetBehoben in Sprint 2024.13
GET openwowi/v1.2/MediaRead/:entityName/MediaContent/:fileGuid

GET /openwowi/v1.2/MediaRead/:entityName/MediaData		Die Medien können mehrfach mit der selben GUID vorhanden sein. Daher scheitert der Abruf der Mediendaten über den GUID-Pfad.Behoben in Sprint 2024.15
GET /openwowi/v1.2/AccountancyTransactionData/CollectiveAccountEs werden keine Daten geliefert, wenn in WOWIPORT die "SEPA Gläubiger-ID" nicht angegeben istBehoben in Sprint 2025.04

POST /openwowi/v1.2/AccountancyInvoiceReceipt/Recording

POST /openwowi/v1.2/AccountancyInvoiceReceipt/AccountAssignment

POST /openwowi/v1.2/AccountancyInvoiceReceipt/Release

Die Validierung der Wirtschaftseinheit bei Sondereigentumsverwaltungen in der Rechnung erfolgt nur über die Nutzungseinheit und nicht über die Wirtschaftseinheit.Behoben in Sprint 2025.05
POST /openwowi/v1.2/CommissioningEdit/CraftsProcessDie ProjectId wird nicht in den Vorgang übernommenBehoben in Sprint 2025.06
GET /openwowi/v1.2/CommissioningRead/InvoiceReceipt/CommissionItemsDer Endpunkt kann nur Rechnungen nach dem Status "Erfassung" abrufen. zudem wird nur jeweils eine Rechnung bei Filterung nach Auftrag angezeigtBehoben in Sprint 2025.08
GET /openwowi/v1.2/RentAccountingPersonDetails/ContractorsIn der Node "NaturalPerson" fehlen aktuell einige Daten. Diese sind aktuell über den PersonsRead Endpunkt verfügbar.Behoben in Sprint 2025.10
ProjectWrite EndpunkteDie Status Codes weisen momentan Fehler bei Erfolgsmeldungen auf (Http 202 anstatt 201 und falsche Status Codes in der Dokumentation für Endpunkte, welche Verbindungen lösen sollen)Behoben in Sprint 2025.10
GET /openwowi/v1.2/CommercialInventory/UseUnitsExitReason wird mit den Daten der EntryReason dargestelltBehoben in Sprint 2025.14
GET /openwowi/v1.2/PropertyManagement/PropertyManagementContractAnstatt "AccountHolder" wurde die IBAN ausgegebenBehoben in 2025.16
POST /openwowi/v1.2/CommunicationEdit/Ticket/AddConversation
POST /openwowi/v1.2/CommunicationEdit/Ticket/AddComment		Der angezeigte Username war falschBehoben in 2025.17

POST /openwowi/v1.2/AccountancyInvoiceReceipt/RecordingNew

POST /openwowi/v1.2/AccountancyInvoiceReceipt/AccountAssignmentNew

POST /openwowi/v1.2/AccountancyInvoiceReceipt/ReleasedNew

Die InvoiceDocumentId kann noch nicht erfasst werdenBehoben in Sprint 2025.17
GET /openwowi/v1.2/CommunicationRead/TicketDer Endpunkt hat nur Kommentare angezeigt, wenn diese mit einer Person verknüpft waren. Behoben in Sprint 2025.17
Externe LinksBeim Klick auf "Speichern" in der Entität in WOWIPORT, wurden die externen Links dupliziert.Behoben in Sprint 2026.01
GET /openwowi/v1.2/BudgetingRead/BudgetBudgets ohne Geschäftsjahr werden im Response nicht angezeigtBehoben in Sprint 2026.02
GET /openwowi/v1.2/RunningCostDistributionRead/AllocationGroupsDie IDs passen nicht zu denen der AK/KV Basis.
Der Endpunkt bezieht lediglich die Abrechnungskreise, nicht aber die gebräuchliche AK/KV Basis. Die Umstellung des Endpunktes auf die AK/KV Basis ist beauftragt.		Behoben in Sprint 2026.03
GET /openwowi/v1.2/BudgetingRead/:budgetId/BudgetDetailBudgets ohne Geschäftsjahr werden im Response nicht angezeigt.
Zudem sind einige der Filtermethoden ohne Funktion. Diese werden entfernt.		Behoben in Sprint 2026.05
GET /openwowi/v1.2/CommissioningRead/InvoiceReceiptNew/CommissionItemsDie Parameter "CommissionId" und "CommissionIdNum" zeigten keine WirkungBehoben in Sprint 2026.05
GET /openwowi/v1.2/AccountancyTransactionData/CollectiveAccountDas "AccountStatement" Objekt wurde nicht korrekt zurückgegebenBehoben in Sprint 2026.05
GET
openwowi/v1.2/CommercialInventory/BuildingLands		Der "Architekt" wurde mit den Daten des "Hauswarts" geliefert.Behoben in Sprint 2026.07
GET openwowi/v1.2/Loans/Loan/{id}/RepaymentPlanRückzahlungspläne wurden nicht korrekt angezeigtBehoben in Sprint 2026.08
GET /openwowi/v1.2/CooperativeManagement/ProcessMembershipsSelbst mit Parameter "IncludeInactiveShare=true" werden inaktive Anteilsbewegungen nicht angezeigt.Behoben in Sprint 2026.10
GET /openwowi/v1.2/AccountancyMasterDataCatalog/quantityTypeEs werden falsche Daten ausgegebenBehoben in Sprint 2026.10
# Authentifizierung und Berechtigungen Auf dieser Seite beschreiben wir die Authentifizierung am entsprechenden REST API-Endpunkt und die Nutzung des Bearer Tokens. ## Allgemein Um unsere Beispiele zur Nutzung der API nachvollziehen zu können, können Sie einen Zugang zu unserer Sandbox beantragen. Bitte kontaktieren Sie hierfür [Partnermanagement@drklein-wowi.de](mailto:partnermanagement@drklein-wowi.de).\ Sie erhalten dann einen technischen User und einen API Key. Für die Beantragung **benötigen wir eine E-Mailadresse** (diese wird für die Passwortvergabe an den Benutzer gebunden) für die Versendung der Einladung zu unserer Sandbox und Zustellung des API Keys. Für die OPENWOWI-API existiert ein öffentliches [Swagger Dokument](https://openwowi-demo.wowiport.de/swagger/index.html). Wir verwenden für die Beispiele in dieser Dokumentation die untenstehende Sandbox. Für die Authentifizierung benötigen Sie nur einen gültigen User und ein Passwort (siehe auch "[Hinweise zum Benutzer](#hinweise-zum-benutzer)")*.* Sandbox-URL:\ ** ## Login Das Login erfolgt über die Route "*/oauth2/token*". Der "grant\_type" lautet bei der Erstanmeldung "Password". Bei späteren Anmeldungen können Sie den "grant\_type" auf "refesh\_token" setzen und diesen mit dem Parameter "refesh\_token" erneuern. Die erneute Übersendung des Passwortes und des Users entfällt bei dieser Methode. *** {% openapi src="" path="/oauth2/token" method="post" %} {% endopenapi %} *** ## Hinweise zum Benutzer Wir empfehlen die Anlage eines technischen Nutzers für die Verwendung der OPENWOWI. Sollten Sie einen Benutzer mit Zugriff auf die Benutzeroberfläche von WOWIPORT verwenden wollen, bitten wir folgende Informationen zu beachen. Die Berechtigungen werden sowohl durch die Rechte des verwendeten Nutzers als auch durch die Endpunktberechtigungen des API-Keys limitiert. Der Nutzer benötigt hierbei dieselben Berechtigungen, welche auch in der GUI benötigt werden, um die gewünschten Daten lesen oder bearbeiten zu können. Wenn Sie die Zwei-Faktor-Authentifizierung aktiviert haben, kann die Authentifizierung über OAuth2 nicht erfolgreich vorgenommen werden. Aus Gründen der Infrastruktursicherheit bitten wir um Verständnis, dass die Dokumentation der dezidierten Nutzerrechte nicht in der öffentlichen Dokumentation zu finden ist. Bitte konsultieren Sie hierfür das WOWIPORT-Handbuch. Die Beschreibung der Einrichtung des API-Keys sowie Hinweise zur Freischaltung für unsere Sandbox finden Sie hier: {% content-ref url="/pages/8XMzcwsYk9BkoYYjlL0P" %} [Einrichtung OPENWOWI](/grundlagen/einrichtung-openwowi) {% endcontent-ref %} # Anlagenbuchhaltung Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "FixedAssets". {% hint style="warning" %} Um auf die Daten der Anlagenbuchhaltung über die API zugreifen zu können, muss die Endpunktberechtigung "Anlagevermögen" aktiviert werden. {% endhint %} Die API-Version 1.0 ist derzeit die aktuellste Version der Endpunkte. # Wirtschaftsgüter Abruf der Wirtschaftsgüter. ## Wirtschaftsgüter abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/FixedAssets/Assets" method="get" %} {% endopenapi %} *** # Abschreibungen Abschreibungen ## Abschreibungen abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/FixedAssets/AssetDepreciations" method="get" %} {% endopenapi %} *** # Kostenstellen Kostenstellen ## Kostenstellen abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/FixedAssets/AssetCostCenters" method="get" %} {% endopenapi %} *** # Finanzplanung Fin ## Finanzplanung abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/FixedAssets/AssetPreviews" method="get" %} {% endopenapi %} *** # Anlagenbuchhaltung Transfer ## Verschiebungen von Wirtschaftsgütern abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/FixedAssets/AssetMovements" method="get" %} {% endopenapi %} *** # Investitionsfreibetrag zum Wirtschaftsgut ## Investitionsfreibeträge abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/FixedAssets/AssetInvestTaxCredits" method="get" %} {% endopenapi %} *** # Ausstattung Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "ManageFacilityAndComponents". {% hint style="warning" %} Um auf die Daten der Ausstattungen über die API zugreifen zu können, muss die Endpunktberechtigung "Ausstattungsgruppen und -elemente bearbeiten" aktiviert werden. {% endhint %} Die Kataloge zu den Ausstattungsgruppen und Ausstattungselementen finden Sie unter den [Objektdaten](/schnittstelle-v1.x/objektdaten/kataloge). # Ausstattungsgruppen Über diese Endpunkte können Ausstattungsgruppen verändert werden.
Hinweise zur Funktion Ausstattungsgruppen sind einzeln definierbare **Teilbereiche** für die Objekte der Wirtschaftseinheit, des Gebäudes, des Grundstücks oder der Nutzungseinheit. Diese Teilbereiche können durch jeden Kunden einzeln definiert werden. Die Logik der Ausstattungsgruppendefinition muss deshalb vorab mit dem Kunden geklärt werden. Die Ausstattungsgruppen vereinen die darunterliegenden Ausstattungselemente in einer Sammelgruppe. Beispiele für die Verwendung von Ausstattungsgruppen: * als Raum bzw. Zimmer in einer NE oder einem Gebäude * Küche, Wohnzimmer, Heizungskeller, Waschhaus * als übergeordnete Gruppe für mehrere Ausstattungselemente * Zähler * als separater Bereich auf dem Grundstück oder am Gebäude * Gehweg, Dach, Treppenhaus
{% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Neue Ausstattungsgruppe hinzufügen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/ManageFacilityAndComponents/Facility" method="post" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/ManageFacilityAndComponents/Facility" method="post" %} {% endopenapi %} *** ## Ausstattungsgruppe ändern #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/ManageFacilityAndComponents/Facility/{id}" method="put" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/ManageFacilityAndComponents/Facility/{id}" method="put" %} {% endopenapi %} *** ## Ausstattungsgruppe löschen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/ManageFacilityAndComponents/Facility/{id}" method="delete" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/ManageFacilityAndComponents/Facility/{id}" method="delete" %} {% endopenapi %} *** ## Enumerationen für "FacilityStatusId" | Id | Type | | -- | --------- | | 1 | Unaudited | | 2 | Audited | | 3 | Automatic | # Ausstattungselemente Über diese Endpunkte können Ausstattungselemente verändert werden.
Hinweise zur Funktion Ausstattungselemente sind bewegliche Dinge im oder am Objekt. Sie müssen **immer einer Ausstattungsgruppenart zugeordnet** sein.
{% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Ausstattungselement anlegen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/ManageFacilityAndComponents/Facility/{facilityId}/Component" method="post" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/ManageFacilityAndComponents/Facility/{facilityId}/Component" method="post" %} {% endopenapi %} *** ## Ausstattungselement ändern #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/ManageFacilityAndComponents/Facility/{facilityId}/Component/{componentId}" method="put" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/ManageFacilityAndComponents/Facility/{facilityId}/Component/{componentId}" method="put" %} {% endopenapi %} *** ## Ausstattungselement löschen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/ManageFacilityAndComponents/Facility/{facilityId}/Component/{componentId}" method="delete" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/ManageFacilityAndComponents/Facility/{facilityId}/Component/{componentId}" method="delete" %} {% endopenapi %} *** ## Enumerationen für FacilityStatusId | Id | Type | | -- | --------- | | 1 | Unaudited | | 2 | Audited | | 3 | Automatic | ## Enumerationen für "MeteringDeviceTypeId" | Id | Type | | -- | ----------------------------- | | 1 | HeatCostAllocatorEvaporation | | 2 | HeatCostAllocatorElectronic | | 3 | HeatMeterHeatingWarmwater | | 4 | MeterColdwater | | 5 | MeterWarmwater | | 6 | HeatMeterWarmwater | | 7 | HeatMeterHeating | | 8 | WarmwaterAllocatorEvaporation | | 9 | WarmwaterAllocatorMechanical | | 10 | CondensateMeterHeating | | 11 | CondensateMeterWarmwater | | 12 | MeterOil | | 13 | MeterPower | | 14 | MeterGas | | 15 | PipeHeatEmission | # Auftragswesen Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "Commissioning" und "CommissioningCatalog". {% hint style="warning" %} Um auf die Daten des Auftragswesens über die API zugreifen zu können, muss die Endpunktberechtigung "Auftragswesen lesen" bzw. "Auftragswesen ändern" aktiviert werden. {% endhint %} # Aufträge Abruf der Aufträge {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Aufträge abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/Commissioning/Commissions" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommissioningRead/Commissions" method="get" %} {% endopenapi %} *** ## Aufträge anlegen
Hinweise zur Funktion Es können mehrere Aufträge mit einem Vorgang verknüpft werden. Wenn einem Auftrag die "Adresse" fehlt, dann benötigt der Auftrag mehr als eine Wirtschaftseinheit. In diesem Fall muss mindestens eine Entität angegeben werden, welche auf ein Gebäude/Grundstück zurückzuführen ist (z.B. BuildingId, UseUnitId oder LicenseAgreementId). Die Auftragsstatus der Auftragsarten sind durch den Kunden frei definierbar. Für jede Auftragsart muss deshalb der Auftragsstatusverlauf individuell geplant werden. Den Verlauf des Status finden Sie im Katalog "CommissionTypes" wenn Sie den Parameter "includeCommissionControl=true" mitsenden. Im selben Katalog finden Sie auch alle Pflichtfelder, welche zur Auftragsart zusätzlich definiert wurden.
#### Version 1.2 Aufträge im Status "Erfasst" anlegen *** {% openapi src="" path="/openwowi/v1.2/CommissioningEdit/Commission" method="post" %} {% endopenapi %} *** Aufträge im Status "Warte auf Annahme" anlegen *** {% openapi src="" path="/openwowi/v1.2/CommissioningEdit/Commission/WaitForCraftsmanFeedback" method="post" %} {% endopenapi %} *** ## Ändern des Auftragsstatus #### Version 1.2 Ändern auf "Angenommen" *** {% openapi src="" path="/openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/Accepted" method="put" %} {% endopenapi %} *** Ändern auf "Abgelehnt" *** {% openapi src="" path="/openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/Refused" method="put" %} {% endopenapi %} *** Ändern auf "Erledigt" *** {% openapi src="" path="/openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/Done" method="put" %} {% endopenapi %} *** Ändern auf "An Handwerkerportal übertragen" *** {% openapi src="" path="/openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/Imported" method="put" %} {% endopenapi %} *** Ändern auf "Rechnungseingang erwartet" *** {% openapi src="" path="/openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/AwaitInvoice" method="put" %} {% endopenapi %} *** Ändern auf "Storniert" *** {% openapi src="" path="/openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/Canceled" method="put" %} {% endopenapi %} *** ## Enumerator für "CommissionStatus" und "Id" | Id | Code | Deutsch | | -- | ------------------------ | ------------------------------ | | 1 | EffortRecording | Leistungserfassung | | 2 | CommissionRecorded | Erfasst | | 3 | CommissionPlaced | Auftragsvergabe | | 4 | ApprovalRequired | Freigabe erforderlich | | 6 | Approved | Freigegeben | | 7 | Accepted | Angenommen | | 8 | Refused | Abgelehnt | | 9 | Done | Erledigt | | 10 | Suspended | Aussetzen | | 11 | AwaitInvoice | Rechnungseingang erwartet | | 12 | WaitForCraftsmanFeedback | Warte auf Annahme | | 13 | Canceled | Storniert | | 14 | InvoiceRecorded | Rechnung erfasst | | 15 | PartSettled | Teilabgerechnet | | 16 | CraftsmanPortalImported | An Handwerkerportal übertragen | # Auftragspositionen Abruf der Auftragspositionen {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Auftragspositionen abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/Commissioning/CommissionItems" method="get" %} {% endopenapi %} *** #### Version 1.2 Die Auftragspositionen wurden direkt in den Endpunkt für die Aufträge integriert. # Eingangsrechnung Abruf der Eingangsrechnung {% hint style="warning" %} Der Eingangsprozess für Rechnungen wurde vollständig überarbeitet. Aus diesem Grund werden für den neuen Eingangsrechnungsprozess neue Endpunkte benötigt. Nach vollständiger Umstellung aller Kunden werden die alten Endpunkte abgekündigt und entfernt. Die Umstellung erfolgt in Abstimmung mit unseren Kunden und Partnern, soweit uns diese bekannt sind. {% endhint %} {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Eingangsrechnungen abrufen (alter Eingangsrechnungsprozess) #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/Commissioning/InvoiceReceipts" method="get" %} {% endopenapi %} *** ## Eingangsrechnungen mit Auftragsdetails abrufen (alter Eingangsrechnungsprozess) #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommissioningRead/InvoiceReceipt/CommissionItems" method="get" %} {% endopenapi %} *** ## Eingangsrechnungen mit Auftragsdetails abrufen (neuer Eingangsrechnungsprozess) #### Version 1.2 *** ## GET /openwowi/v1.2/CommissioningRead/InvoiceReceiptNew/CommissionItems > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowCommissioningDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Number":{"type":"string","nullable":true},"PreliminaryNumber":{"type":"string","nullable":true},"CompanyCode":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CompanyCodeSlimDto"},"InvoiceDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"MaturityDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"MonetaryTotal":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptMonetaryTotalDto"},"TaxTotal":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptTaxTotalDto"},"PaymentOrders":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptPaymentOrderDto"},"nullable":true},"CommissionItems":{"type":"array","items":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InvoiceReceiptCommissionItemDto"},"nullable":true},"AttachedCommissions":{"type":"array","items":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionUltraSlimDto"},"nullable":true},"ResponsibleOfficial":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.ResponsibleOfficialUltraSlimDto"},"Department":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DepartmentUltraSlimDto"},"EconomicUnits":{"type":"array","items":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.EconomicUnitUltraSlimDto"},"nullable":true},"Projects":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.ProjectSlimDto"},"nullable":true},"InvoiceType":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceTypeSlimDto"},"Step":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowStepDto"},"Creditor":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorSlimDto"}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CompanyCodeSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptMonetaryTotalDto":{"type":"object","properties":{"TaxExclusiveAmount":{"type":"number","format":"decimal"},"TaxInclusiveAmount":{"type":"number","format":"decimal"},"TaxInclusiveLaborCost":{"type":"number","format":"decimal","nullable":true},"TaxInclusiveMaterialCost":{"type":"number","format":"decimal","nullable":true},"TaxExclusiveLaborCost":{"type":"number","format":"decimal","nullable":true},"TaxExclusiveMaterialCost":{"type":"number","format":"decimal","nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptTaxTotalDto":{"type":"object","properties":{"TaxAmount":{"type":"number","format":"decimal"},"TaxSubtotals":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptTaxSubtotalDto"},"nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptTaxSubtotalDto":{"type":"object","properties":{"Net":{"type":"number","format":"decimal"},"Vat":{"type":"number","format":"decimal"},"Tax":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.SalesTaxSlimDto"}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.SalesTaxSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptPaymentOrderDto":{"type":"object","properties":{"PaymentOrderNumber":{"type":"string","nullable":true},"Maturity":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"TransferDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"PaymentFileStatus":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.PaymentFileStatusDto"}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.PaymentFileStatusDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InvoiceReceiptCommissionItemDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true},"UnitPrice":{"type":"number","format":"decimal","nullable":true},"GrossAmount":{"type":"number","format":"decimal"},"NetAmount":{"type":"number","format":"decimal","nullable":true},"Units":{"type":"number","format":"decimal"},"CommissionText":{"type":"string","nullable":true},"InternalDescription":{"type":"string","nullable":true},"PositionNumber":{"type":"number","format":"decimal"},"IsCanceled":{"type":"boolean"},"IsSmallRepair":{"type":"boolean"},"TransferToCraftsmanPortalWithoutCosts":{"type":"boolean"},"BudgetData":{"allOf":[{"$ref":"#/components/schemas/Budgeting.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionItemBudgetDto"}],"nullable":true},"SalesTax":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.SalesTaxSlimDto"},"ServiceCatalogue":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.ServiceCatalogueSlimDto"},"CraftActivity":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CraftActivitySlimDto"},"QuantityType":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.QuantityTypeDto"},"Component":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.ComponentSlimDto"},"Facility":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.FacilitySlimDto"},"ComponentCatalog":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.ComponentCatalogUltraSlimDto"},"FacilityCatalog":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.FacilityCatalogSlimDto"},"ApprovedNetAmount":{"type":"number","format":"decimal","nullable":true},"Commission":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionSlimDto"}},"additionalProperties":false},"Budgeting.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionItemBudgetDto":{"type":"object","properties":{"Budget":{"$ref":"#/components/schemas/Budgeting.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BudgetSlimDto"},"BudgetDetail":{"$ref":"#/components/schemas/Budgeting.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BudgetDetailSlimDto"}},"additionalProperties":false},"Budgeting.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BudgetSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Budgeting.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BudgetDetailSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"BudgetId":{"type":"integer","format":"int32"},"Hierarchy1Value":{"type":"string","nullable":true},"Hierarchy2Value":{"type":"string","nullable":true},"Hierarchy3Value":{"type":"string","nullable":true}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.ServiceCatalogueSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true},"QuantityType":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.QuantityTypeDto"}},"additionalProperties":false},"CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.QuantityTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true},"ArgeCode":{"type":"string","nullable":true}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CraftActivitySlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.ComponentSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.FacilitySlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.ComponentCatalogUltraSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.FacilityCatalogSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true},"RecordingDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ReleaseDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"PlacingDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"AcceptanceDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"CompletionDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"CommissionType":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionTypeSlimDto"},"CommissionStatus":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionStatusDto"}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionTypeSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionStatusDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionUltraSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.ResponsibleOfficialUltraSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"CodeShort":{"type":"string","nullable":true},"PersonId":{"type":"integer","format":"int32"}},"additionalProperties":false},"CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DepartmentUltraSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.EconomicUnitUltraSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.ProjectSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceTypeSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowStepDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"CreditorNumber":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/CommissioningRead/InvoiceReceiptNew/CommissionItems":{"get":{"tags":["OpenWowi Commissioning Read"],"operationId":"CommissioningRead_GetInvoiceReceiptFlowWithCommissionItems","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"number","in":"query","schema":{"type":"string"}},{"name":"companyCodeId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"companyCodeCode","in":"query","schema":{"type":"string"}},{"name":"commissionId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"commissionIdNum","in":"query","schema":{"type":"string"}},{"name":"maturityDateFrom","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"maturityDateTo","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"invoiceDateFrom","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"invoiceDateTo","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"includePaymentOrder","in":"query","schema":{"type":"boolean","default":false}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowCommissioningDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowCommissioningDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowCommissioningDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Zahlaufträge abrufen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommissioningRead/InvoiceReceipt/PaymentOrders" method="get" %} {% endopenapi %} *** # Handwerker Über diesen Endpunkt können Daten der Handwerker abgerufen werden. {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Handwerker abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.1/Commissioning/Craftsman" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommissioningRead/Craftsman" method="get" %} {% endopenapi %} *** # Kreditoren Abruf der Kreditoren {% hint style="danger" %} Ab Version 1.1 sind die Kreditorendaten im [Belegsystem](/schnittstelle-v1.x/belegsystem/belegsystem-stammdaten/kreditoren) dokumentiert und über eine neue Route abzurufen. {% endhint %} ## Kreditoren abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/Commissioning/Creditors" method="get" %} {% endopenapi %} *** # Projekte Abruf der Projekte {% hint style="danger" %} Ab der Version 1.2 finden Sie diesen Endpunkt in den Stammdaten des [Belegsystems](/schnittstelle-v1.x/belegsystem/belegsystem-stammdaten/projekte). {% endhint %} ## Projekte abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/Commissioning/Projects" method="get" %} {% endopenapi %} *** # Vorgänge Abruf der Vorgänge {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Vorgänge abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/Commissioning/CraftProcesses" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommissioningRead/CraftProcesses" method="get" %} {% endopenapi %} *** ## Vorgänge anlegen, ändern und löschen
Hinweise zur Funktion Die Änderung von vorhandenen Vorgängen unterliegt bestimmten Beschränkungen. Die CraftsProcessStatusId kann nur auf den Status "4" (Storniert) gesetzt werden. Status 1 bis 3 errechnet sich aus den Feldern "CraftsProcessFrom" und "CraftsProcessTo". Liegt das aktuelle Tagesdatum vor "CraftsProcessFrom", wird automatisch der Status "1" (Bevorstehend) gesetzt. Liegt das aktuelle Tagesdatum nach "CraftsProcessFrom" aber vor "CraftsProcessTo", wird automatisch der Status "2" (Offen) gesetzt. Liegt das aktuelle Tagesdatum nach "CraftsProcessTo", wird automatisch der Status "3" (Beendet) gesetzt. Sie können den Status durch das Setzen dieser Datumsangaben beeinflussen. Bitte beachten Sie, dass die Ausführungsdaten der mit dem Vorgang verknüpften Aufträge logisch mit diesen Daten übereinstimmen müssen.
#### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommissioningEdit/CraftsProcess" method="post" %} {% endopenapi %} *** {% openapi src="" path="/openwowi/v1.2/CommissioningEdit/CraftsProcess/{id}" method="put" %} {% endopenapi %} *** {% openapi src="" path="/openwowi/v1.2/CommissioningEdit/CraftsProcess/{id}" method="delete" %} {% endopenapi %} *** ## Vorgangsbeschreibungen lesen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommissioningRead/CraftProcess/Note" method="get" %} {% endopenapi %} *** ## Vorgangsbeschreibungen anlegen, ändern und löschen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommissioningEdit/CraftsProcess/{craftsProcessId}/Note" method="post" %} {% endopenapi %} *** {% openapi src="" path="/openwowi/v1.2/CommissioningEdit/CraftsProcess/{craftsProcessId}/Note/{id}" method="put" %} {% endopenapi %} *** {% openapi src="" path="/openwowi/v1.2/CommissioningEdit/CraftsProcess/{craftsProcessId}/Note/{id}" method="delete" %} {% endopenapi %} *** # Leistungspositionen Abruf der Leistungspositionen {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Leistungspositionen abrufen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommissioningRead/ServiceCatalogue" method="get" %} {% endopenapi %} *** {% openapi src="" path="/openwowi/v1.2/CommissioningRead/Craftsman/{craftsmanId}/ServiceCatalogue" method="get" %} {% endopenapi %} *** # Leistungspakete {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Leistungspakete abrufen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommissioningRead/ServicePackage" method="get" %} {% endopenapi %} *** # Versicherungsinformationen {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} Die Endpunkte zum Abruf der versicherungsrelevanten Informationen finden Sie in den Katalogen. ## Versicherungsverträge lesen #### Version 1.2 *** ## GET /openwowi/v1.2/CommissioningRead/InsuranceContract > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InsuranceContractDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true},"NodeId":{"type":"integer","format":"int32"},"ValidFrom":{"type":"string","format":"date-time"},"ValidTo":{"type":"string","format":"date-time"},"Insurer":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InsurerUltraSlimDto"},"AssignedCommissioningInsuranceDamageDivision":{"type":"array","items":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AssignedCommissioningInsuranceDamageDivisionUltraSlimDto"},"nullable":true},"AssignedEconomicUnits":{"type":"array","items":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.EconomicUnitSlimDto"},"nullable":true}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InsurerUltraSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AssignedCommissioningInsuranceDamageDivisionUltraSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"DivisionDamage":{"type":"string","nullable":true}},"additionalProperties":false},"CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.EconomicUnitSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"Name":{"type":"string","nullable":true},"Location":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/CommissioningRead/InsuranceContract":{"get":{"tags":["OpenWowi Commissioning Read"],"operationId":"CommissioningRead_GetInsuranceContract","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"idNum","in":"query","schema":{"type":"string"}},{"name":"insurerId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"economicUnitId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"validFrom","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"validTo","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InsuranceContractDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InsuranceContractDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InsuranceContractDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Versicherungsverträge anlegen/ ändern #### Version 1.2 *** ## POST /openwowi/v1.2/CommissioningEdit/InsuranceContract > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InsuranceContractCreateDto":{"type":"object","properties":{"IdNum":{"type":"string","nullable":true},"NodeId":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true},"InsurerId":{"type":"integer","format":"int32"},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"AssignedCommissioningInsuranceDamageDivisions":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"AssignedEconomicUnits":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.InsuranceContractResultDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/CommissioningEdit/InsuranceContract":{"post":{"tags":["OpenWowi Commissioning Edit"],"operationId":"CommissioningEdit_CreateInsuranceContract","parameters":[{"name":"apiKey","in":"query","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InsuranceContractCreateDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InsuranceContractCreateDto"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InsuranceContractCreateDto"}}}},"responses":{"201":{"description":"Created","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.InsuranceContractResultDto"}},"application/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.InsuranceContractResultDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.InsuranceContractResultDto"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## PUT /openwowi/v1.2/CommissioningEdit/InsuranceContract/{id} > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.InsuranceContractUpdateDto":{"type":"object","properties":{"IdNum":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true},"InsurerId":{"type":"integer","format":"int32"},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"AssignedCommissioningInsuranceDamageDivisions":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"AssignedEconomicUnits":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.InsuranceContractResultDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/CommissioningEdit/InsuranceContract/{id}":{"put":{"tags":["OpenWowi Commissioning Edit"],"operationId":"CommissioningEdit_UpdateInsuranceContract","parameters":[{"name":"apiKey","in":"query","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.InsuranceContractUpdateDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.InsuranceContractUpdateDto"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.InsuranceContractUpdateDto"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.InsuranceContractResultDto"}},"application/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.InsuranceContractResultDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.InsuranceContractResultDto"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Versicherungsunternehmen lesen Die Anlage neuer Versicherungsunternehmen muss in WOWIPORT erfolgen. #### Version 1.2 *** ## GET /openwowi/v1.2/CommissioningRead/Insurer > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InsurerDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"CreditorId":{"type":"integer","format":"int32"},"CreditorNumber":{"type":"string","nullable":true},"PersonId":{"type":"integer","format":"int32"},"Person":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonRoleDto"},"DefaultAddress":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressDto"},"DefaultBankaccount":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonBankAccountDto"},"AccessibilityId":{"type":"integer","format":"int32","nullable":true},"BankAccountId":{"type":"integer","format":"int32","nullable":true},"InsurerAccessibilityList":{"type":"array","items":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InsurerAccessibilityDto"},"nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonRoleDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"Shortname":{"type":"string","nullable":true},"Name":{"type":"string","nullable":true},"NodeId":{"type":"integer","format":"int32","nullable":true},"TaxNumber":{"type":"string","nullable":true},"TaxIdentificationNumber":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"IsNaturalPerson":{"type":"boolean"},"NaturalPerson":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonDto"},"LegalPerson":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonDto"},"Addresses":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressDto"},"nullable":true},"Communications":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"},"nullable":true},"BankAccounts":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonBankAccountDto"},"nullable":true},"FirstEmailCommunication":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"},"FirstLandlinePhoneCommunication":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"},"FirstMobilePhoneCommunication":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonDto":{"type":"object","properties":{"Title":{"type":"string","nullable":true},"FirstName":{"type":"string","nullable":true},"LastName":{"type":"string","nullable":true},"BirthName":{"type":"string","nullable":true},"CareOf":{"type":"string","nullable":true},"BirthDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"DeathDate":{"type":"string","format":"date-time","nullable":true},"Gender":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.GenderDto"},"MaritalType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.MaritalTypeDto"},"Nationality":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CountryDto"},"PersonInCare":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonUltraSlimDto"},"ContactFor":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonSlimDto"},"nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.GenderDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.MaritalTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CountryDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonUltraSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"LongName1":{"type":"string","nullable":true},"LongName2":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonDto":{"type":"object","properties":{"LongName1":{"type":"string","nullable":true},"LongName2":{"type":"string","nullable":true},"VatId":{"type":"string","nullable":true},"CommercialRegisterNumber":{"type":"string","nullable":true},"CommercialRegisterTown":{"type":"string","nullable":true},"ContractPersons":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonSlimDto"},"nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"FirstName":{"type":"string","nullable":true},"LastName":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Zip":{"type":"string","nullable":true},"Town":{"type":"string","nullable":true},"Street":{"type":"string","nullable":true},"HouseNumber":{"type":"string","nullable":true},"HouseNumberAddition":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"StreetComplete":{"type":"string","nullable":true},"HouseNumberComplete":{"type":"string","nullable":true},"MainAddress":{"type":"boolean"},"AddressType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressTypeDto"},"Country":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CountryDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"RelatedAddressId":{"type":"integer","format":"int32","nullable":true},"Content":{"type":"string","nullable":true},"Explanation":{"type":"string","nullable":true},"RelatedAddress":{"type":"string","nullable":true},"CommunicationType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationTypeDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonBankAccountDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Iban":{"type":"string","nullable":true},"Bic":{"type":"string","nullable":true},"AccountHolder":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"BankAccountType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountTypeDto"},"BankAccountId":{"type":"integer","format":"int32"},"BankAccountUsageType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountUsageTypeDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountUsageTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InsurerAccessibilityDto":{"type":"object","additionalProperties":false}}},"paths":{"/openwowi/v1.2/CommissioningRead/Insurer":{"get":{"tags":["OpenWowi Commissioning Read"],"operationId":"CommissioningRead_GetInsurer","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"companyCodeId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"managementId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"creditorId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"creditorNumber","in":"query","schema":{"type":"string"}},{"name":"insurerId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"personId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"includeMainCommunication","in":"query","schema":{"type":"boolean","default":false}},{"name":"includePersonAddresses","in":"query","schema":{"type":"boolean","default":false}},{"name":"includePersonCommunications","in":"query","schema":{"type":"boolean","default":false}},{"name":"includePersonBankAccounts","in":"query","schema":{"type":"boolean","default":false}},{"name":"includeInsurerAccessibility","in":"query","schema":{"type":"boolean","default":false}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InsurerDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InsurerDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InsurerDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** *** ## Schadenssparte anlegen/ ändern/ löschen #### Version 1.2 *** ## POST /openwowi/v1.2/CommissioningEdit/DamageDivision > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageDivisionUpdateDto":{"type":"object","properties":{"IdNum":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true},"ExternalIdentificationNumber":{"type":"string","nullable":true},"NodeId":{"type":"integer","format":"int32"}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageDivisionResultDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/CommissioningEdit/DamageDivision":{"post":{"tags":["OpenWowi Commissioning Edit"],"operationId":"CommissioningEdit_CreateDamageDivision","parameters":[{"name":"apiKey","in":"query","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageDivisionUpdateDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageDivisionUpdateDto"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageDivisionUpdateDto"}}}},"responses":{"201":{"description":"Created","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageDivisionResultDto"}},"application/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageDivisionResultDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageDivisionResultDto"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## PUT /openwowi/v1.2/CommissioningEdit/DamageDivision/{id} > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageDivisionUpdateDto":{"type":"object","properties":{"IdNum":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true},"ExternalIdentificationNumber":{"type":"string","nullable":true},"NodeId":{"type":"integer","format":"int32"}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageDivisionResultDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/CommissioningEdit/DamageDivision/{id}":{"put":{"tags":["OpenWowi Commissioning Edit"],"operationId":"CommissioningEdit_UpdateDamageDivision","parameters":[{"name":"apiKey","in":"query","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageDivisionUpdateDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageDivisionUpdateDto"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageDivisionUpdateDto"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageDivisionResultDto"}},"application/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageDivisionResultDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageDivisionResultDto"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## DELETE /openwowi/v1.2/CommissioningEdit/DamageDivision/{damageDivisionId} > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageDivisionResultDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/CommissioningEdit/DamageDivision/{damageDivisionId}":{"delete":{"tags":["OpenWowi Commissioning Edit"],"operationId":"CommissioningEdit_DeleteDamageDivision","parameters":[{"name":"apiKey","in":"query","required":true,"schema":{"type":"string"}},{"name":"damageDivisionId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageDivisionResultDto"}},"application/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageDivisionResultDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageDivisionResultDto"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Schadensursache anlegen/ ändern #### Version 1.2 *** ## POST /openwowi/v1.2/CommissioningEdit/DamageCause > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageCauseUpdateDto":{"type":"object","properties":{"IdNum":{"type":"string","nullable":true},"DamageDivisionId":{"type":"integer","format":"int32"},"ExternalIdentificationNumber":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageCauseResultDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/CommissioningEdit/DamageCause":{"post":{"tags":["OpenWowi Commissioning Edit"],"operationId":"CommissioningEdit_CreateDamageCause","parameters":[{"name":"apiKey","in":"query","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageCauseUpdateDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageCauseUpdateDto"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageCauseUpdateDto"}}}},"responses":{"201":{"description":"Created","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageCauseResultDto"}},"application/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageCauseResultDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageCauseResultDto"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## PUT /openwowi/v1.2/CommissioningEdit/DamageCause/{id} > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageCauseUpdateDto":{"type":"object","properties":{"IdNum":{"type":"string","nullable":true},"DamageDivisionId":{"type":"integer","format":"int32"},"ExternalIdentificationNumber":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageCauseResultDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/CommissioningEdit/DamageCause/{id}":{"put":{"tags":["OpenWowi Commissioning Edit"],"operationId":"CommissioningEdit_UpdateDamageCause","parameters":[{"name":"apiKey","in":"query","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageCauseUpdateDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageCauseUpdateDto"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageCauseUpdateDto"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageCauseResultDto"}},"application/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageCauseResultDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningEditDto.DamageCauseResultDto"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** # Kataloge Abruf der Kataloge {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} Weitere Kataloge können im Bereich [Objekte ](/schnittstelle-v1.x/objektdaten/kataloge)gefunden werden. ## Gewerkarten Dieser Abruf enthält die Gewerkarten, welche den Auftragspositionen zugeordnet sein können. #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/Commissioning/CraftActivities" method="get" %} {% endopenapi %} *** #### Version 1.1 *** {% openapi src="" path="/openwowi/v1.1/Commissioning/CraftActivities" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommissioningCatalog/CraftActivities" method="get" %} {% endopenapi %} *** ## Auftragsarten Dieser Abruf enthält die Auftragsarten, welche den Aufträgen zugeordnet sein können. #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/Commissioning/CommissionTypes" method="get" %} {% endopenapi %} *** #### Version 1.1 *** {% openapi src="" path="/openwowi/v1.1/Commissioning/CommissionTypes" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommissioningCatalog/CommissionTypes" method="get" %} {% endopenapi %} *** ## Vorgangsarten #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/Commissioning/CraftProcessTypes" method="get" %} {% endopenapi %} *** #### Version 1.1 *** {% openapi src="" path="/openwowi/v1.1/Commissioning/CraftProcessTypes" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommissioningCatalog/CraftProcessTypes" method="get" %} {% endopenapi %} *** ## Status Versicherungsportal #### Version 1.2 *** ## GET /openwowi/v1.2/CommissioningCatalog/InsurancePortalStatus > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningInsurancePortalStatusDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/CommissioningCatalog/InsurancePortalStatus":{"get":{"tags":["OpenWowi Commissioning Catalog"],"operationId":"CommissioningCatalog_GetInsurancePortalStatus","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningInsurancePortalStatusDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningInsurancePortalStatusDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissioningInsurancePortalStatusDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Schadensursachen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommissioningCatalog/DamageCauses" method="get" %} {% endopenapi %} *** ## Schadenssparte #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommissioningCatalog/DamageDivisions" method="get" %} {% endopenapi %} *** ## Versandart #### Version 1.2 *** ## GET /openwowi/v1.2/CommissioningCatalog/CommissionNotificationMethods > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionNotificationMethodDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/CommissioningCatalog/CommissionNotificationMethods":{"get":{"tags":["OpenWowi Commissioning Catalog"],"operationId":"CommissioningCatalog_GetCommissionNotificationMethods","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionNotificationMethodDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionNotificationMethodDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionNotificationMethodDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Enumeration für "CraftsProcessStatusId" Bitte beachten Sie die "Hinweise zur Funktion" in "[Vorgänge](/schnittstelle-v1.x/auftragswesen/vorgaenge)". | Id | Code | | -: | ------------ | | 1 | Bevorstehend | | 2 | Offen | | 3 | Beendet | | 4 | Storniert | # Belegsystem Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "AccountancyMasterData", "AccountancyMasterDataWrite", "AccountancyTransactionData" und "AccountancyMasterDataCatalog". Das Belegsystem steuert alle buchhalterischen Prozesse des Systems. Es entscheidet und kontrolliert den Belegfluss zwischen den Nebenbüchern (z. B. Mietenbuchhaltung, Darlehen, Mitgliederverwaltung, Umlagenabrechnung) und dem Hauptbuch, der Finanzbuchhaltung. Im Belegsystem werden die Belege und Buchungen aller Module gesammelt. Die Daten lassen sich nach Hauptkonten- oder Zusatzkontenzuordnung filtern und saldieren. Im Belegsystem ist auch die Übergabe zum Rechnungswesen (Diamant) geregelt. Die Funktionen, die z. B. für den bilanziellen Ausweis der Umsätze genutzt werden, sind über die Oberfläche ins System eingebunden, so dass kein Medienbruch entsteht und die Daten komfortabel auf einen Blick einsehbar sind. Folgendes Schaubild soll die Zusammenhänge des Belegsystems grob veranschaulichen: ![Zusammenhänge Belegsystem](/files/1v4gn5LPSEaRqBQUQTFh) Für das Belegsystem unterscheiden wir in zwei Berechtigungen. {% content-ref url="/pages/C1w8xVRRIWN4LkWeooII" %} [Stammdaten](/schnittstelle-v1.x/belegsystem/belegsystem-stammdaten) {% endcontent-ref %} {% content-ref url="/pages/VmUXzDnRpdp9Nv4MNpmU" %} [Bewegungsdaten](/schnittstelle-v1.x/belegsystem/belegsystem-bewegungsdaten) {% endcontent-ref %} # Stammdaten Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller AccountancyMasterData {% hint style="warning" %} Um auf die Stammdaten des Belegsystems über die API zugreifen zu können, muss die Endpunktberechtigung "Belegsystem Stammdaten" aktiviert werden. {% endhint %} Mit der Endpunktberechtigung "Belegsystem Stammdaten" werden einige Endpunkte aktiviert, die wir auf den folgenden Seiten aufgelistet haben. # Buchwerke Abruf der Buchwerke {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %}
Hinweise zur Funktion Buchwerke stellen eine Sammlung aller Konten eines Unternehmens dar. Erst über Buchwerke sind die Hauptkonten eines Kontenrahmenes im Unternehmen ansprechbar. Jedes Buchwerk stellt für sich eine bilanzierende Einheit dar. Im Falle einer Verwaltung fremder Objekte (reine Fremdverwaltung, Wohnungseigentumsverwaltung oder Sondereigentumsverwaltung) werden je Eigentümergemeinschaft oder je Eigentümer die Buchungen in eigenen Buchwerken gesammelt und für die Abrechnung gegenüber dem Eigentümer genutzt. Um Kostenumbuchungen in der Umlagenabrechnung der Vorjahre vornehmen zu können, ohne dass Umsätze im laufenden Geschäftsjahr entstehen, gibt es spezielle Buchwerke vom Typ „Buchung". Diese sind nicht mit der Finanzbuchhaltung verbunden und bieten die Möglichkeit, die Kosten von einem AK/KV auf einen anderen AK/KV umzubuchen.
Buchwerke lassen sich über den folgenden API-Endpunkt aufrufen: ## Buchwerke abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/AccountancyMasterData/CompanyCodes" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyMasterData/CompanyCodes" method="get" %} {% endopenapi %} *** # Bilanz/GuV Struktur Abruf der Bilanz/GuV Struktur {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Bilanzstruktur abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/AccountancyMasterData/BalanceSheets" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyMasterData/BalanceSheets" method="get" %} {% endopenapi %} *** # Hauptkonten Abruf der Sachkonten {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %}
Hinweise zur Funktion Hauptkonten können auch als Sachkonten oder FiBu-Konten bezeichnet werden. Sie sammeln die Buchungen, die innerhalb des Systems manuell oder automatisiert getätigt werden. Hauptkonten haben eine Zuordnung zum Kontenrahmen, der wiederum für die bilanzielle Abbildung des Kontos verantwortlich ist. Sie sind für die Hauptbuchhaltung im Unternehmen verantwortlich. Ein Hauptkonto kann für mehrere Buchwerke verwendet werden. Es erfolgt aber immer automatisch eine Trennung der Umsätze nach Buchwerken, so dass keine Vermischung von Buchungen zwischen den Mandanten möglich ist. Sofern Sie das Rechnungswesen (Rewe - Diamant Finanzbuchhaltung) als Schnittstelle verwenden, werden die Konten sowie die Buchungen zu den Hauptkonten an das Rechnungswesen übertragen und stehen dort u. a. für bilanzielle Auswertungen zur Verfügung. Bitte beachten Sie, dass in der WOWIPORT Benutzeroberfläche auch Hauptkonten ohne Buchwerke gespeichert werden können. Ohne Buchwerke können diese allerdings nicht genutzt werden. Hauptkonten ohne Buchwerke werden in der Schnittstelle nicht angezeigt.
## Hauptkonten abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/AccountancyMasterData/MasterAccounts" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyMasterData/MasterAccounts" method="get" %} {% endopenapi %} *** # Kostenstellen Abruf der Kostenstellen {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %}
Hinweise zur Funktion Eine Kostenstelle ist der Ort der Kostenentstehung und der Leistungserbringung. Sie wird nach Verantwortungsbereichen, räumlichen, funktionalen, aufbauorganisatorischen oder verrechnungstechnischen Aspekten gebildet. Die Kostenstelle ist ein Kostenrechnungsobjekt mit der Aufgabe, die in einem Unternehmensteil, meist einer Abteilung, angefallenen Kosten zu sammeln. Beispiele für funktionale Kostenstellen sind Materialkostenstellen, Fertigungskostenstellen, Forschungs- und Entwicklungskostenstellen, Verwaltungskostenstellen, Vertriebskostenstellen.
## Kostenstellen abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/AccountancyMasterData/CostCenters" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyMasterData/CostCenters" method="get" %} {% endopenapi %} *** # Kostenart Abruf der Kostenarten {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %}
Hinweise zur Funktion Die Kostenart kategorisiert in der Kostenrechnung angefallene Kosten nach ihrer eigenen Natur ("Was kostet?" bzw. "Welche Kosten fallen an"?). Im Unterschied dazu kategorisiert der Kostenträger die Kosten danach, wofür sie angefallen sind. Die Kostenstelle wiederum steuert, wo die Kosten angefallen sind. Kostenarten sind also beispielsweise Personalkosten, Wartungs- und Betriebsmittelkosten, Zinsen, Administrations- oder Marketingkosten. Dabei kann eine vielschichtige Staffelung vorgenommen werden.
## Kostenart abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/AccountancyMasterData/CostTypes" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyMasterData/CostTypes" method="get" %} {% endopenapi %} *** # Kostenträger Abruf der Kostenträger {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %}
Hinweise zur Funktion Der Kostenträger beschreibt ein Kontierungsobjekt in der Kostenrechnung, das nicht wie Kostenstellen organisatorische Strukturen abbildet, sondern Produkte oder auch Projekte. Zur Kosten- und Leistungsrechnung-Bearbeitung gehören auch die Kostenträger, die mit dieser Funktion verwaltet werden können.
## Kostenträger abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/AccountancyMasterData/CostUnits" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyMasterData/CostUnits" method="get" %} {% endopenapi %} *** # Kreditoren Über diese Route lassen sich die in WOWIPORT hinterlegten Kreditoren abrufen. {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Kreditoren abrufen #### Version 1.1 *** {% openapi src="" path="/openwowi/v1.1/AccountancyMasterData/Creditors" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyMasterData/Creditors" method="get" %} {% endopenapi %} *** Enumeratoren für Personendaten finden Sie unter "[Personen lesen](/schnittstelle-v1.x/personendaten/kataloge)". # Debitoren Über diese Route lassen sich die in WOWIPORT hinterlegten Kreditoren abrufen. {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Debitoren abrufen #### Version 1.2 *** ## GET /openwowi/v1.2/AccountancyMasterData/Debitors > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"DebitorNumber":{"type":"string","nullable":true},"CashDiscountPercent1":{"type":"number","format":"decimal","nullable":true},"CashDiscountPercent2":{"type":"number","format":"decimal","nullable":true},"CashDiscountPercent3":{"type":"number","format":"decimal","nullable":true},"MaturityDefault":{"type":"integer","format":"int32","nullable":true},"MaturityIn1Day":{"type":"integer","format":"int32","nullable":true},"MaturityIn2Day":{"type":"integer","format":"int32","nullable":true},"MaturityIn3Day":{"type":"integer","format":"int32","nullable":true},"AllocateOpenItemsAutomatically":{"type":"boolean"},"AvailableForAllManagements":{"type":"boolean"},"Locked":{"type":"boolean"},"DunningBlock":{"type":"boolean"},"PaymentsExclusion":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"DefaultSalesTax":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.SalesTaxSlimDto"},"IsVarious":{"type":"boolean"},"Description":{"type":"string","nullable":true},"Person":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonRoleDto"},"DefaultAddress":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressDto"},"SelectedIndividualManagement":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorManagementDto"},"nullable":true},"PersonId":{"type":"integer","format":"int32"},"DefaultBankaccount":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonBankAccountDto"},"AccessibilityId":{"type":"integer","format":"int32","nullable":true},"BankAccountId":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.SalesTaxSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonRoleDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"Shortname":{"type":"string","nullable":true},"Name":{"type":"string","nullable":true},"NodeId":{"type":"integer","format":"int32","nullable":true},"TaxNumber":{"type":"string","nullable":true},"TaxIdentificationNumber":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"IsNaturalPerson":{"type":"boolean"},"NaturalPerson":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonDto"},"LegalPerson":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonDto"},"Addresses":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressDto"},"nullable":true},"Communications":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"},"nullable":true},"BankAccounts":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonBankAccountDto"},"nullable":true},"FirstEmailCommunication":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"},"FirstLandlinePhoneCommunication":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"},"FirstMobilePhoneCommunication":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonDto":{"type":"object","properties":{"Title":{"type":"string","nullable":true},"FirstName":{"type":"string","nullable":true},"LastName":{"type":"string","nullable":true},"BirthName":{"type":"string","nullable":true},"CareOf":{"type":"string","nullable":true},"BirthDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"DeathDate":{"type":"string","format":"date-time","nullable":true},"Gender":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.GenderDto"},"MaritalType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.MaritalTypeDto"},"Nationality":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CountryDto"},"PersonInCare":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonUltraSlimDto"},"ContactFor":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonSlimDto"},"nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.GenderDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.MaritalTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CountryDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonUltraSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"LongName1":{"type":"string","nullable":true},"LongName2":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonDto":{"type":"object","properties":{"LongName1":{"type":"string","nullable":true},"LongName2":{"type":"string","nullable":true},"VatId":{"type":"string","nullable":true},"CommercialRegisterNumber":{"type":"string","nullable":true},"CommercialRegisterTown":{"type":"string","nullable":true},"ContractPersons":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonSlimDto"},"nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"FirstName":{"type":"string","nullable":true},"LastName":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Zip":{"type":"string","nullable":true},"Town":{"type":"string","nullable":true},"Street":{"type":"string","nullable":true},"HouseNumber":{"type":"string","nullable":true},"HouseNumberAddition":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"StreetComplete":{"type":"string","nullable":true},"HouseNumberComplete":{"type":"string","nullable":true},"MainAddress":{"type":"boolean"},"AddressType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressTypeDto"},"Country":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CountryDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"RelatedAddressId":{"type":"integer","format":"int32","nullable":true},"Content":{"type":"string","nullable":true},"Explanation":{"type":"string","nullable":true},"RelatedAddress":{"type":"string","nullable":true},"CommunicationType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationTypeDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonBankAccountDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Iban":{"type":"string","nullable":true},"Bic":{"type":"string","nullable":true},"AccountHolder":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"BankAccountType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountTypeDto"},"BankAccountId":{"type":"integer","format":"int32"},"BankAccountUsageType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountUsageTypeDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountUsageTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorManagementDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/AccountancyMasterData/Debitors":{"get":{"tags":["OpenWowi AccountancyMasterData"],"operationId":"AccountancyMasterData_GetDebitors","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"companyCodeId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"managementId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"debitorNumber","in":"query","schema":{"type":"string"}},{"name":"personId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"includeMainAddress","in":"query","schema":{"type":"boolean","default":false}},{"name":"includeMainCommunication","in":"query","schema":{"type":"boolean","default":false}},{"name":"includeMainBankaccount","in":"query","schema":{"type":"boolean","default":false}},{"name":"includePersonAddresses","in":"query","schema":{"type":"boolean","default":false}},{"name":"includePersonCommunications","in":"query","schema":{"type":"boolean","default":false}},{"name":"includePersonBankAccounts","in":"query","schema":{"type":"boolean","default":false}},{"name":"includeIndividualSelectedManagement","in":"query","schema":{"type":"boolean","default":false}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** Enumeratoren für Personendaten finden Sie unter "[Personen lesen](/schnittstelle-v1.x/personendaten/kataloge)". # Projekte Unter diesem Endpunkt können Projekte abgerufen werden. {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Projekte abrufen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyMasterData/Projects" method="get" %} {% endopenapi %} *** # Stammdaten schreiben Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller AccountancyMasterDataWrite {% hint style="warning" %} Um schreibend auf die Daten des Belegsystems über die API zugreifen zu können, muss die Endpunktberechtigung "Belegsystem Stammdaten schreiben" aktiviert werden. {% endhint %} # Debitoren {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %}
Hinweise zur Funktion Die "AccessibilityId" stellt die ID der Adresse der verbundenen Person dar.
## Debitoren anlegen #### Version 1.2 *** ## POST /openwowi/v1.2/AccountancyMasterDataWrite/Debitor > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorEditDto.DebitorDto":{"type":"object","properties":{"DebitorNumber":{"type":"string","nullable":true},"DefaultSalesTaxKeyId":{"type":"integer","format":"int32","nullable":true},"DefaultRegulationId":{"type":"integer","format":"int32"},"PaymentsExclusion":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"Description":{"type":"string","nullable":true},"DunningBlock":{"type":"boolean"},"Locked":{"type":"boolean"},"AllocateOpenItemsAutomatically":{"type":"boolean"},"IsVarious":{"type":"boolean"},"MaturityDefault":{"type":"integer","format":"int32","nullable":true},"MaturityIn1Day":{"type":"integer","format":"int32","nullable":true},"MaturityIn2Day":{"type":"integer","format":"int32","nullable":true},"MaturityIn3Day":{"type":"integer","format":"int32","nullable":true},"CashDiscountPercent1":{"type":"number","format":"decimal","nullable":true},"CashDiscountPercent2":{"type":"number","format":"decimal","nullable":true},"CashDiscountPercent3":{"type":"number","format":"decimal","nullable":true},"PersonId":{"type":"integer","format":"int32"},"NodeId":{"type":"integer","format":"int32"},"AvailableForAllManagements":{"type":"boolean"},"CreationDate":{"type":"string","format":"date-time"},"ManagementIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"BankaccountId":{"type":"integer","format":"int32","nullable":true},"AccessibilityId":{"type":"integer","format":"int32"}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorEditDto.DebitorResultDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"DebitorNumber":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/AccountancyMasterDataWrite/Debitor":{"post":{"tags":["OpenWowi AccountancyMasterData Write"],"operationId":"AccountancyMasterDataWrite_CreateDebitor","parameters":[{"name":"apiKey","in":"query","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorEditDto.DebitorDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorEditDto.DebitorDto"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorEditDto.DebitorDto"}}}},"responses":{"201":{"description":"Created","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorEditDto.DebitorResultDto"}},"application/json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorEditDto.DebitorResultDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorEditDto.DebitorResultDto"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Debitoren ändern #### Version 1.2 *** ## PUT /openwowi/v1.2/AccountancyMasterDataWrite/Debitor/{debitorId} > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorEditDto.DebitorDto":{"type":"object","properties":{"DebitorNumber":{"type":"string","nullable":true},"DefaultSalesTaxKeyId":{"type":"integer","format":"int32","nullable":true},"DefaultRegulationId":{"type":"integer","format":"int32"},"PaymentsExclusion":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"Description":{"type":"string","nullable":true},"DunningBlock":{"type":"boolean"},"Locked":{"type":"boolean"},"AllocateOpenItemsAutomatically":{"type":"boolean"},"IsVarious":{"type":"boolean"},"MaturityDefault":{"type":"integer","format":"int32","nullable":true},"MaturityIn1Day":{"type":"integer","format":"int32","nullable":true},"MaturityIn2Day":{"type":"integer","format":"int32","nullable":true},"MaturityIn3Day":{"type":"integer","format":"int32","nullable":true},"CashDiscountPercent1":{"type":"number","format":"decimal","nullable":true},"CashDiscountPercent2":{"type":"number","format":"decimal","nullable":true},"CashDiscountPercent3":{"type":"number","format":"decimal","nullable":true},"PersonId":{"type":"integer","format":"int32"},"NodeId":{"type":"integer","format":"int32"},"AvailableForAllManagements":{"type":"boolean"},"CreationDate":{"type":"string","format":"date-time"},"ManagementIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"BankaccountId":{"type":"integer","format":"int32","nullable":true},"AccessibilityId":{"type":"integer","format":"int32"}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorEditDto.DebitorResultDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"DebitorNumber":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/AccountancyMasterDataWrite/Debitor/{debitorId}":{"put":{"tags":["OpenWowi AccountancyMasterData Write"],"operationId":"AccountancyMasterDataWrite_UpdateDebitor","parameters":[{"name":"apiKey","in":"query","required":true,"schema":{"type":"string"}},{"name":"debitorId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorEditDto.DebitorDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorEditDto.DebitorDto"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorEditDto.DebitorDto"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorEditDto.DebitorResultDto"}},"application/json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorEditDto.DebitorResultDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorEditDto.DebitorResultDto"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Debitoren löschen #### Version 1.2 *** ## DELETE /openwowi/v1.2/AccountancyMasterDataWrite/Debitor/{debitorId} > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorEditDto.DebitorResultDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"DebitorNumber":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/AccountancyMasterDataWrite/Debitor/{debitorId}":{"delete":{"tags":["OpenWowi AccountancyMasterData Write"],"operationId":"AccountancyMasterDataWrite_DeleteDebitor","parameters":[{"name":"apiKey","in":"query","required":true,"schema":{"type":"string"}},{"name":"debitorId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorEditDto.DebitorResultDto"}},"application/json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorEditDto.DebitorResultDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DebitorEditDto.DebitorResultDto"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** # Kreditoren {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %}
Hinweise zur Funktion Die "AccessibilityId" stellt die ID der Adresse der verbundenen Person dar.
## Kreditoren anlegen #### Version 1.2 *** ## POST /openwowi/v1.2/AccountancyMasterDataWrite/Creditor > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorEditDto.CreditorDto":{"type":"object","properties":{"CreditorNumber":{"type":"string","nullable":true},"CustomerIdByCreditor":{"type":"string","nullable":true},"PaymentsExclusion":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"DefaultSalesTaxKeyId":{"type":"integer","format":"int32","nullable":true},"DefaultRegulationId":{"type":"integer","format":"int32"},"Description":{"type":"string","nullable":true},"ExemptionCertificateUnnecessary":{"type":"boolean"},"Locked":{"type":"boolean"},"LockedCommissioning":{"type":"boolean","nullable":true},"AllocateOpenItemsAutomatically":{"type":"boolean"},"RedoOIClearingAfterInvoiceReversal":{"type":"boolean"},"IsVarious":{"type":"boolean"},"MaturityDefault":{"type":"integer","format":"int32","nullable":true},"MaturityIn1Day":{"type":"integer","format":"int32","nullable":true},"MaturityIn2Day":{"type":"integer","format":"int32","nullable":true},"MaturityIn3Day":{"type":"integer","format":"int32","nullable":true},"CashDiscountPercent1":{"type":"number","format":"decimal","nullable":true},"CashDiscountPercent2":{"type":"number","format":"decimal","nullable":true},"CashDiscountPercent3":{"type":"number","format":"decimal","nullable":true},"PersonId":{"type":"integer","format":"int32"},"NodeId":{"type":"integer","format":"int32"},"CreationDate":{"type":"string","format":"date-time"},"ManagementIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"BankaccountId":{"type":"integer","format":"int32","nullable":true},"AccessibilityId":{"type":"integer","format":"int32"}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorEditDto.CreditorResultDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"CreditorNumber":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/AccountancyMasterDataWrite/Creditor":{"post":{"tags":["OpenWowi AccountancyMasterData Write"],"operationId":"AccountancyMasterDataWrite_CreateCreditor","parameters":[{"name":"apiKey","in":"query","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorEditDto.CreditorDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorEditDto.CreditorDto"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorEditDto.CreditorDto"}}}},"responses":{"201":{"description":"Created","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorEditDto.CreditorResultDto"}},"application/json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorEditDto.CreditorResultDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorEditDto.CreditorResultDto"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Kreditoren ändern #### Version 1.2 *** ## PUT /openwowi/v1.2/AccountancyMasterDataWrite/Creditor/{creditorId} > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorEditDto.CreditorDto":{"type":"object","properties":{"CreditorNumber":{"type":"string","nullable":true},"CustomerIdByCreditor":{"type":"string","nullable":true},"PaymentsExclusion":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"DefaultSalesTaxKeyId":{"type":"integer","format":"int32","nullable":true},"DefaultRegulationId":{"type":"integer","format":"int32"},"Description":{"type":"string","nullable":true},"ExemptionCertificateUnnecessary":{"type":"boolean"},"Locked":{"type":"boolean"},"LockedCommissioning":{"type":"boolean","nullable":true},"AllocateOpenItemsAutomatically":{"type":"boolean"},"RedoOIClearingAfterInvoiceReversal":{"type":"boolean"},"IsVarious":{"type":"boolean"},"MaturityDefault":{"type":"integer","format":"int32","nullable":true},"MaturityIn1Day":{"type":"integer","format":"int32","nullable":true},"MaturityIn2Day":{"type":"integer","format":"int32","nullable":true},"MaturityIn3Day":{"type":"integer","format":"int32","nullable":true},"CashDiscountPercent1":{"type":"number","format":"decimal","nullable":true},"CashDiscountPercent2":{"type":"number","format":"decimal","nullable":true},"CashDiscountPercent3":{"type":"number","format":"decimal","nullable":true},"PersonId":{"type":"integer","format":"int32"},"NodeId":{"type":"integer","format":"int32"},"CreationDate":{"type":"string","format":"date-time"},"ManagementIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"BankaccountId":{"type":"integer","format":"int32","nullable":true},"AccessibilityId":{"type":"integer","format":"int32"}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorEditDto.CreditorResultDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"CreditorNumber":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/AccountancyMasterDataWrite/Creditor/{creditorId}":{"put":{"tags":["OpenWowi AccountancyMasterData Write"],"operationId":"AccountancyMasterDataWrite_UpdateCreditor","parameters":[{"name":"apiKey","in":"query","required":true,"schema":{"type":"string"}},{"name":"creditorId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorEditDto.CreditorDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorEditDto.CreditorDto"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorEditDto.CreditorDto"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorEditDto.CreditorResultDto"}},"application/json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorEditDto.CreditorResultDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorEditDto.CreditorResultDto"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Kreditoren löschen #### Version 1.2 *** ## DELETE /openwowi/v1.2/AccountancyMasterDataWrite/Creditor/{creditorId} > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorEditDto.CreditorResultDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"CreditorNumber":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/AccountancyMasterDataWrite/Creditor/{creditorId}":{"delete":{"tags":["OpenWowi AccountancyMasterData Write"],"operationId":"AccountancyMasterDataWrite_DeleteCreditor","parameters":[{"name":"apiKey","in":"query","required":true,"schema":{"type":"string"}},{"name":"creditorId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorEditDto.CreditorResultDto"}},"application/json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorEditDto.CreditorResultDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorEditDto.CreditorResultDto"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** # Bewegungsdaten Die Endpunkte dieser Berechtigung finden Sie im Controller AccountancyTransactionData {% hint style="warning" %} Um auf die Bewegungsdaten des Belegsystems über die API zugreifen zu können, muss die Endpunktberechtigung "Belegsystem Bewegungsdaten" aktiviert werden. {% endhint %} Mit der Endpunktberechtigung "Belegsystem Bewegungsdaten" werden einige Endpunkte aktiviert, die wir auf den folgenden Seiten aufgelistet haben. # Hauptkonto Salden In diesem Abruf sind die Salden nach Hauptkonten aggregiert. {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %}
Hinweise zur Funktion Hauptkonten können auch als Sachkonten oder FiBu-Konten bezeichnet werden. Sie sammeln die Buchungen, die innerhalb des Systems manuell oder automatisiert getätigt werden. Hauptkonten haben eine Zuordnung zum Kontenrahmen, der wiederum für die bilanzielle Abbildung des Kontos verantwortlich ist. Sie sind für die Hauptbuchhaltung im Unternehmen verantwortlich.\ Sofern Sie das Rechnungswesen (ReWe – Diamant Finanzbuchhaltung) als Schnittstelle verwenden, werden die Konten sowie die Buchungen zu den Hauptkonten an das Rechnungswesen übertragen und stehen dort u. a. für bilanzielle Auswertungen zur Verfügung. Ein Hauptkonto kann für mehrere Buchwerke verwendet werden. Es erfolgt aber immer automatisch eine Trennung der Umsätze nach Buchwerken, so dass keine Vermischung von Buchungen zwischen den Mandanten möglich ist.
## Salden abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/AccountancyTransactionData/MasterAccount/Balances" method="get" %} {% endopenapi %} *** #### Version 1.2
Hinweise zur Funktion Aus Gründen der Datensparsamkeit zeigt dieser Endpunkt nur Datensätze an, welche einen Saldo zum Ende der ausgewählten Periode (Fiskaljahr oder Buchungsperiode) ausweisen. \ Konten mit einem Saldo von "0.00" werden ausgeblendet.
*** {% openapi src="" path="/openwowi/v1.2/AccountancyTransactionData/MasterAccountBalances" method="get" %} {% endopenapi %} *** Darüber hinaus lassen sich die Salden der Konten noch nach den folgenden Kriterien filtern: {% content-ref url="/pages/OAdF59opu0Hj269jvvZF" %} [Hauptkonto Salden nach Wirtschaftseinheiten](/schnittstelle-v1.x/belegsystem/belegsystem-bewegungsdaten/masteraccount-balances/masteraccount-economicunitbalances) {% endcontent-ref %} {% content-ref url="/pages/7631ey1sFOE1GqJGkKNt" %} [Hauptkonto Salden nach Nutzungseinheiten](/schnittstelle-v1.x/belegsystem/belegsystem-bewegungsdaten/masteraccount-balances/masteraccount-useunitbalances) {% endcontent-ref %} {% content-ref url="/pages/oK3TtrdXsV0gGnjhCcJi" %} [Hauptkonto Salden nach Vertragskonten](/schnittstelle-v1.x/belegsystem/belegsystem-bewegungsdaten/masteraccount-balances/masteraccount-rentaccountbookings) {% endcontent-ref %} {% content-ref url="/pages/FgFwO8NuySdhEU5UZcFy" %} [Hauptkonto Salden nach Darlehen](/schnittstelle-v1.x/belegsystem/belegsystem-bewegungsdaten/masteraccount-balances/hauptkonto-salden-nach-darlehen) {% endcontent-ref %} # Bankkonto/Sammelkonto Salden Unter diesem Endpunkt können die Salden von Bankkonten und Sammelkonten abgerufen werden. {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Bankkonto Salden abrufen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyTransactionData/CollectiveAccount" method="get" %} {% endopenapi %} *** # Hauptkonto Salden nach Wirtschaftseinheiten In diesem Abruf sind die Salden nach Hauptkonten und Wirtschaftseinheiten aggregiert. ## Hauptkonto Salden nach Wirtschaftseinheiten abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/AccountancyTransactionData/MasterAccount/EconomicUnitBalances" method="get" %} {% endopenapi %} *** Ab Version 1.2 können die Daten über den Parameter "AdditionalAccountType" im Endpunkt "[Balances](/schnittstelle-v1.x/belegsystem/belegsystem-bewegungsdaten/masteraccount-balances)" gefiltert werden. Den Katalog finden Sie in den [Stammdaten](/schnittstelle-v1.x/belegsystem/kataloge). # Hauptkonto Salden nach Nutzungseinheiten In diesem Abruf sind die Salden nach Hauptkonten und Nutzungseinheiten aggregiert. ## Hauptkonto Salden nach Nutzungseinheiten abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/AccountancyTransactionData/MasterAccount/UseUnitBalances" method="get" %} {% endopenapi %} *** Ab Version 1.2 können die Daten über den Parameter "AdditionalAccountType" im Endpunkt "[Balances](/schnittstelle-v1.x/belegsystem/belegsystem-bewegungsdaten/masteraccount-balances)" gefiltert werden. Den Katalog finden Sie in den [Stammdaten](/schnittstelle-v1.x/belegsystem/kataloge). # Hauptkonto Salden nach Vertragskonten In diesem Abruf sind die Salden nach Hauptkonten und Vertragskonten aggregiert. ## Hauptkonto Salden nach Vertragskonten abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/AccountancyTransactionData/MasterAccount/RentAccountBalances" method="get" %} {% endopenapi %} *** Ab Version 1.2 können die Daten über den Parameter "AdditionalAccountType" im Endpunkt "[Balances](/schnittstelle-v1.x/belegsystem/belegsystem-bewegungsdaten/masteraccount-balances)" gefiltert werden. Den Katalog finden Sie in den [Stammdaten](/schnittstelle-v1.x/belegsystem/kataloge). # Hauptkonto Salden nach Darlehen In diesem Abruf sind die Salden nach Hauptkonten und Darlehen aggregiert. ## Hauptkonto Salden nach Darlehen abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/AccountancyTransactionData/MasterAccount/LoanBalances" method="get" %} {% endopenapi %} *** Ab Version 1.2 können die Daten über den Parameter "AdditionalAccountType" im Endpunkt "[Balances](/schnittstelle-v1.x/belegsystem/belegsystem-bewegungsdaten/masteraccount-balances)" gefiltert werden. Den Katalog finden Sie in den [Stammdaten](/schnittstelle-v1.x/belegsystem/kataloge). # Rechnungen Über diese Funktion können Rechnungsdaten abgerufen werden. Die Anlage von Rechnungen wird in einem eigenen Abschnitt behandelt. {% hint style="warning" %} Der Eingangsprozess für Rechnungen wurde vollständig überarbeitet. Aus diesem Grund werden für den neuen Eingangsrechnungsprozess neue Endpunkte benötigt. Nach vollständiger Umstellung aller Kunden werden die alten Endpunkte abgekündigt und entfernt. Die Umstellung erfolgt in Abstimmung mit unseren Kunden und Partnern, soweit uns diese bekannt sind. {% endhint %} {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Rechnungen (alter Eingangsrechnungsprozess) #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyTransactionData/InvoiceReceipt" method="get" %} {% endopenapi %} *** ## Rechnungen (neuer Eingangsrechnungsprozess) #### Version 1.2 *** ## GET /openwowi/v1.2/AccountancyTransactionData/InvoiceReceiptNew > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"InvoiceNumber":{"type":"string","nullable":true},"PreliminaryNumber":{"type":"string","nullable":true},"CompanyCode":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CompanyCodeSlimDto"},"Step":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowStepDto"},"CorrectionRequested":{"type":"boolean"},"CorrectionReason":{"type":"string","nullable":true},"IssueDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"ReceiptDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"DueDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"ActualDeliveryDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"AssessmentDateFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"AssessmentDateTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"OwnReference":{"type":"string","nullable":true},"MonetaryTotal":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptMonetaryTotalDto"},"PaymentOrders":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptPaymentOrderDto"},"nullable":true},"ConnectedInvoices":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptSlimDto"},"nullable":true},"ResponsibleOfficial":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.ResponsibleOfficialUltraSlimDto"},"Department":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DepartmentUltraSlimDto"},"Lines":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptLineDto"},"nullable":true},"AdditionalFields":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AdditionalFieldExportServices.AdditionalFieldDto"},"nullable":true},"Withholds":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowWithholdResultDto"},"nullable":true},"AllowanceCharges":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.AllowanceChargeResultDto"},"nullable":true},"InvoiceType":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceTypeSlimDto"},"CommissioningData":{"allOf":[{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InvoiceReceiptCommissioningDataDto"}],"nullable":true},"Creditor":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorSlimDto"},"Discount":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowImportServiceDto.Request.DiscountTermDto"}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CompanyCodeSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowStepDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptMonetaryTotalDto":{"type":"object","properties":{"TaxExclusiveAmount":{"type":"number","format":"decimal"},"TaxInclusiveAmount":{"type":"number","format":"decimal"},"TaxInclusiveLaborCost":{"type":"number","format":"decimal","nullable":true},"TaxInclusiveMaterialCost":{"type":"number","format":"decimal","nullable":true},"TaxExclusiveLaborCost":{"type":"number","format":"decimal","nullable":true},"TaxExclusiveMaterialCost":{"type":"number","format":"decimal","nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptPaymentOrderDto":{"type":"object","properties":{"PaymentOrderNumber":{"type":"string","nullable":true},"Maturity":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"TransferDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"PaymentFileStatus":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.PaymentFileStatusDto"}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.PaymentFileStatusDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"InvoiceReceiptNumber":{"type":"string","nullable":true}},"additionalProperties":false},"CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.ResponsibleOfficialUltraSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"CodeShort":{"type":"string","nullable":true},"PersonId":{"type":"integer","format":"int32"}},"additionalProperties":false},"CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.DepartmentUltraSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptLineDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"GrossAmount":{"type":"number","format":"decimal"},"NetAmount":{"type":"number","format":"decimal"},"Quantity":{"type":"number","format":"decimal","nullable":true},"QuantityTypeId":{"type":"integer","format":"int32"},"Project":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.ProjectSlimDto"},"EconomicUnit":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.EconomicUnitUltraSlimDto"},"UseUnit":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.UseUnitUltraSlimDto"},"BuildingLand":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.BuildingLandSlimDto"},"LicenseAgreement":{"allOf":[{"$ref":"#/components/schemas/Contracts.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LicenseAgreementUltraSlimDto"}],"nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.ProjectSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.EconomicUnitUltraSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true}},"additionalProperties":false},"CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.UseUnitUltraSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"UseUnitNumber":{"type":"string","nullable":true}},"additionalProperties":false},"CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.BuildingLandSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"BuildingLandType":{"type":"string","nullable":true}},"additionalProperties":false},"Contracts.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LicenseAgreementUltraSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AdditionalFieldExportServices.AdditionalFieldDto":{"type":"object","properties":{"Name":{"type":"string","nullable":true},"Content":{"type":"string","nullable":true},"Type":{"type":"string","nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowWithholdResultDto":{"type":"object","properties":{"AssessmentBasis":{"type":"number","format":"decimal","nullable":true},"WithholdType":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.FIOInvoiceFlowWithholdTypeEnum"},"Percentage":{"type":"number","format":"decimal","nullable":true},"Amount":{"type":"number","format":"decimal","nullable":true},"MaturityInMonths":{"type":"integer","format":"int32"},"WithholdMaturityDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"Description":{"type":"string","nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.FIOInvoiceFlowWithholdTypeEnum":{"enum":["Warranty","Security"],"type":"string"},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.AllowanceChargeResultDto":{"type":"object","properties":{"IsCharge":{"type":"boolean"},"TaxInclusiveAmount":{"type":"number","format":"decimal"},"Reason":{"type":"string","nullable":true},"ReasonTypeId":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceTypeSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InvoiceReceiptCommissioningDataDto":{"type":"object","properties":{"CommissionItems":{"type":"array","items":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InvoiceReceiptCommissionItemDto"},"nullable":true},"AttachedCommissions":{"type":"array","items":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionUltraSlimDto"},"nullable":true}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.InvoiceReceiptCommissionItemDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true},"UnitPrice":{"type":"number","format":"decimal","nullable":true},"GrossAmount":{"type":"number","format":"decimal"},"NetAmount":{"type":"number","format":"decimal","nullable":true},"Units":{"type":"number","format":"decimal"},"CommissionText":{"type":"string","nullable":true},"InternalDescription":{"type":"string","nullable":true},"PositionNumber":{"type":"number","format":"decimal"},"IsCanceled":{"type":"boolean"},"IsSmallRepair":{"type":"boolean"},"TransferToCraftsmanPortalWithoutCosts":{"type":"boolean"},"BudgetData":{"allOf":[{"$ref":"#/components/schemas/Budgeting.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionItemBudgetDto"}],"nullable":true},"SalesTax":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.SalesTaxSlimDto"},"ServiceCatalogue":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.ServiceCatalogueSlimDto"},"CraftActivity":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CraftActivitySlimDto"},"QuantityType":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.QuantityTypeDto"},"Component":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.ComponentSlimDto"},"Facility":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.FacilitySlimDto"},"ComponentCatalog":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.ComponentCatalogUltraSlimDto"},"FacilityCatalog":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.FacilityCatalogSlimDto"},"ApprovedNetAmount":{"type":"number","format":"decimal","nullable":true},"Commission":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionSlimDto"}},"additionalProperties":false},"Budgeting.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionItemBudgetDto":{"type":"object","properties":{"Budget":{"$ref":"#/components/schemas/Budgeting.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BudgetSlimDto"},"BudgetDetail":{"$ref":"#/components/schemas/Budgeting.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BudgetDetailSlimDto"}},"additionalProperties":false},"Budgeting.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BudgetSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Budgeting.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BudgetDetailSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"BudgetId":{"type":"integer","format":"int32"},"Hierarchy1Value":{"type":"string","nullable":true},"Hierarchy2Value":{"type":"string","nullable":true},"Hierarchy3Value":{"type":"string","nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.SalesTaxSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.ServiceCatalogueSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true},"QuantityType":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.QuantityTypeDto"}},"additionalProperties":false},"CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.QuantityTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true},"ArgeCode":{"type":"string","nullable":true}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CraftActivitySlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.ComponentSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.FacilitySlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.ComponentCatalogUltraSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.FacilityCatalogSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true},"RecordingDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ReleaseDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"PlacingDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"AcceptanceDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"CompletionDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"CommissionType":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionTypeSlimDto"},"CommissionStatus":{"$ref":"#/components/schemas/Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionStatusDto"}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionTypeSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionStatusDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Commissioning.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommissionUltraSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.CreditorSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"CreditorNumber":{"type":"string","nullable":true}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowImportServiceDto.Request.DiscountTermDto":{"type":"object","properties":{"Percentage":{"type":"number","format":"decimal","nullable":true},"FixedAmount":{"type":"number","format":"decimal","nullable":true},"MaturityInDays":{"type":"integer","format":"int32"}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/AccountancyTransactionData/InvoiceReceiptNew":{"get":{"tags":["OpenWowi AccountancyTransactionData"],"operationId":"AccountancyTransactionData_GetInvoiceReceiptFlow","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"number","in":"query","schema":{"type":"string"}},{"name":"companyCodeId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"companyCodeCode","in":"query","schema":{"type":"string"}},{"name":"maturityDateFrom","in":"query","schema":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"}},{"name":"maturityDateTo","in":"query","schema":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"}},{"name":"invoiceDateFrom","in":"query","schema":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"}},{"name":"invoiceDateTo","in":"query","schema":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"}},{"name":"includePaymentOrder","in":"query","schema":{"type":"boolean","default":false}},{"name":"includeCommissionData","in":"query","schema":{"type":"boolean","default":false}},{"name":"includeAdditionalField","in":"query","schema":{"type":"boolean","default":false}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Zahlungsanweisungen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyTransactionData/InvoiceReceipt/PaymentOrders" method="get" %} {% endopenapi %} *** # Buchungen Mit diesem Aufruf lassen sich die Buchungen innerhalb von WOWIPORT abrufen. {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Abruf der Buchungen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/AccountancyTransactionData/Bookings" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyTransactionData/MasterAccountBookings" method="get" %} {% endopenapi %} *** Neben der allgemeinen Abfrage der Buchungen lassen sich diese nach den folgenden Kontierungen zurückgeben: {% content-ref url="/pages/EydYxm9USZJA15f8OMB0" %} [Buchungen nach Wirtschaftseinheiten](/schnittstelle-v1.x/belegsystem/belegsystem-bewegungsdaten/bookings/masteraccount-economicunitbookings) {% endcontent-ref %} {% content-ref url="/pages/uFDHKbYVWc22xX8e3uXq" %} [Buchungen nach Vertragskonten](/schnittstelle-v1.x/belegsystem/belegsystem-bewegungsdaten/bookings/masteraccount-rentaccountbalances) {% endcontent-ref %} {% content-ref url="/pages/FsAqkcub6Rlq9Q7sBDqp" %} [Buchungen nach Darlehen](/schnittstelle-v1.x/belegsystem/belegsystem-bewegungsdaten/bookings/buchungen-nach-darlehen) {% endcontent-ref %} # Buchungen nach Wirtschaftseinheiten Abruf der Buchungen die mit einer Wirtschaftseinheit zusatzkontiert sind. ## Buchungen nach Wirtschaftseinheiten abrufen Die Wirtschaftseinheit wird im Feld `AdditionalAccountId` und `AdditionalAccountValue` ausgeben. | Feld | Beschreibung | | ------------------------ | ---------------------------- | | `AdditionalAccountId` | Id der Wirtschaftseinheit | | `AdditionalAccountValue` | IdNum der Wirtschaftseinheit | #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/AccountancyTransactionData/MasterAccount/EconomicUnitBookings" method="get" %} {% endopenapi %} *** Ab Version 1.2 können die Daten über den Parameter "AdditionalAccountType" im Endpunkt "[MasterAccountBookings](/schnittstelle-v1.x/belegsystem/belegsystem-bewegungsdaten/bookings)" gefiltert werden. Den Katalog finden Sie in den [Stammdaten](/schnittstelle-v1.x/belegsystem/kataloge). # Buchungen nach Vertragskonten Abruf der Buchungen die mit einem Vertragskonto zusatzkontiert sind. ## Buchungen nach Vertragskonten abrufen Das MB/ET-Konto wird im Feld `AdditionalAccountId` und `AdditionalAccountValue` ausgeben. | Feld | Beschreibung | | ------------------------ | --------------------------- | | `AdditionalAccountId` | Id der MB-ET-Kontos | | `AdditionalAccountValue` | IdNum des Nutzungsvertrages | #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/AccountancyTransactionData/MasterAccount/RentAccountBookings" method="get" %} {% endopenapi %} *** Ab Version 1.2 können die Daten über den Parameter "AdditionalAccountType" im Endpunkt "[MasterAccountBookings](/schnittstelle-v1.x/belegsystem/belegsystem-bewegungsdaten/bookings)" gefiltert werden. Den Katalog finden Sie in den [Stammdaten](/schnittstelle-v1.x/belegsystem/kataloge). # Buchungen nach Darlehen Abruf der Buchungen die mit einem Darlehen zusatzkontiert sind. ## Buchungen nach Darlehen abrufen Das MB/ET-Konto wird im Feld `AdditionalAccountId` und `AdditionalAccountValue` ausgeben. | Feld | Beschreibung | | ------------------------ | ------------------- | | `AdditionalAccountId` | Id des Darlehens | | `AdditionalAccountValue` | IdNum des Darlehens | #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/AccountancyTransactionData/MasterAccount/LoanBookings" method="get" %} {% endopenapi %} *** Ab Version 1.2 können die Daten über den Parameter "AdditionalAccountType" im Endpunkt "[MasterAccountBookings](/schnittstelle-v1.x/belegsystem/belegsystem-bewegungsdaten/bookings)" gefiltert werden. Den Katalog finden Sie in den [Stammdaten](/schnittstelle-v1.x/belegsystem/kataloge). # Buchungsbelege und -vorgänge ## Buchungebelege #### Version 1.2 *** ## GET /openwowi/v1.2/AccountancyTransactionData/Voucher > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.VoucherDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"NodeId":{"type":"integer","format":"int32"},"VoucherDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"VoucherNumber":{"type":"string","nullable":true},"PartnerReference":{"type":"string","nullable":true},"OwnReference":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true},"VoucherType":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.VoucherTypeDto"}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.VoucherTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/AccountancyTransactionData/Voucher":{"get":{"tags":["OpenWowi AccountancyTransactionData"],"operationId":"AccountancyTransactionData_GetVoucher","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"companyCodeId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"fiscalYearNumber","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"bookingPeriodId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"bookingPeriodNumberFrom","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"bookingPeriodNumberTo","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"bookingDateFrom","in":"query","schema":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"}},{"name":"bookingDateTo","in":"query","schema":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"}},{"name":"voucherDateFrom","in":"query","schema":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"}},{"name":"voucherDateTo","in":"query","schema":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.VoucherDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.VoucherDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.VoucherDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Buchungsvorgänge abrufen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyTransactionData/VoucherProcess" method="get" %} {% endopenapi %} # Kataloge Folgende Katalogeinträge können Sie mit dieser Endpunktberechtigung abrufen. {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Buchwerk-Art #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/AccountancyMasterData/CompanyCodeType" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyMasterDataCatalog/CompanyCodeType" method="get" %} {% endopenapi %} *** ## Buchungsart Mietverträge #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/AccountancyMasterData/BookingTypeRentAccounting" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyMasterDataCatalog/BookingTypeRentAccounting" method="get" %} {% endopenapi %} *** ## Buchungsart #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/AccountancyMasterData/BookingTypeAccountancy" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyMasterDataCatalog/BookingTypeAccountancy" method="get" %} {% endopenapi %} *** ## Buchungsart Darlehen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/AccountancyMasterData/BookingTypeLoans" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyMasterDataCatalog/BookingTypeLoans" method="get" %} {% endopenapi %} *** ## Rechnungsart (alter Eingangsrechnungsprozess) #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyMasterDataCatalog/InvoiceType" method="get" %} {% endopenapi %} *** ## Rechnungsart (neuer Eingangsrechnungsprozess) #### Version 1.2 *** ## GET /openwowi/v1.2/AccountancyMasterDataCatalog/InvoiceReceiptFlowType > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"NodeId":{"type":"integer","format":"int32"},"IsFinalInvoice":{"type":"boolean"},"IsLocked":{"type":"boolean"},"IsCreditNote":{"type":"boolean"},"DefaultBookingDate":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowTypeEntityReferenceDto"},"DefaultVoucherProcessType":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowTypeEntityReferenceDto"},"BookingTypePayable":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowTypeEntityReferenceDto"},"BookingTypeExpense":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowTypeEntityReferenceDto"},"BookingTypeDiscount":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowTypeEntityReferenceDto"},"BookingTypeSWOutpayment":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowTypeEntityReferenceDto"},"BookingTypeWithhold":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowTypeEntityReferenceDto"},"PartnerReferenceRequired":{"type":"boolean"},"EconomicUnitRequired":{"type":"boolean"},"SecurityWithholdOutpaymentEnabled":{"type":"boolean"},"CheckupRecordingDisabled":{"type":"boolean"},"CheckupRecordingMultiLevelApproval":{"type":"integer","format":"int32","nullable":true},"CheckupRecordingRule":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowTypeEntityReferenceDto"},"CheckupCalculationDisabled":{"type":"boolean"},"CheckupCalculationMultiLevelApproval":{"type":"integer","format":"int32","nullable":true},"CheckupCalculationRule":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowTypeEntityReferenceDto"},"DiscountBookingEnabled":{"type":"boolean"},"WithholdsEnabled":{"type":"boolean"},"WithholdPercentage":{"type":"number","format":"decimal","nullable":true},"WithholdMaturityInMonths":{"type":"integer","format":"int32","nullable":true},"TreatMissingExemptionOrderAsError":{"type":"boolean"},"RecordingNextUserRequired":{"type":"boolean"},"RecordingNextDepartmentRequired":{"type":"boolean"},"RecordingNextDepartmentProposal":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowTypeEntityReferenceDto"},"CheckupRecordingNextUserRequired":{"type":"boolean"},"CheckupRecordingNextDepartmentRequired":{"type":"boolean"},"CheckupRecordingNextDepartmentProposal":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowTypeEntityReferenceDto"},"CheckupCalculationNextUserRequired":{"type":"boolean"},"CheckupCalculationNextDepartmentRequired":{"type":"boolean"},"CheckupCalculationNextDepartmentProposal":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowTypeEntityReferenceDto"},"AccountAssignmentNextUserRequired":{"type":"boolean"},"AccountAssignmentNextDepartmentRequired":{"type":"boolean"},"AccountAssignmentNextDepartmentProposal":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowTypeEntityReferenceDto"},"ApprovalNextDepartmentProposal":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowTypeEntityReferenceDto"},"IncompleteAccountAssignmentAllowed":{"type":"boolean"}},"additionalProperties":false},"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowTypeEntityReferenceDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/AccountancyMasterDataCatalog/InvoiceReceiptFlowType":{"get":{"tags":["OpenWowi AccountancyMasterData Catalog"],"operationId":"AccountancyMasterDataCatalog_GetInvoiceReceiptFlowTypes","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowTypeDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowTypeDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.InvoiceReceiptFlowTypeDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Ausgangsrechnungsart #### Version 1.2 *** ## GET /openwowi/v1.2/AccountancyMasterDataCatalog/OutgoingInvoiceType > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.OutgoingInvoiceTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/AccountancyMasterDataCatalog/OutgoingInvoiceType":{"get":{"tags":["OpenWowi AccountancyMasterData Catalog"],"operationId":"AccountancyMasterDataCatalog_GetOutgoingInvoiceTypes","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.OutgoingInvoiceTypeDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.OutgoingInvoiceTypeDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Accountancy.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.OutgoingInvoiceTypeDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Zusatzkonten #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyMasterDataCatalog/AdditionalAccountType" method="get" %} {% endopenapi %} *** ## Buchungssteuerung #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyMasterDataCatalog/MetaMasterAccount" method="get" %} {% endopenapi %} *** ## Steuersätze #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyMasterDataCatalog/SalesTax" method="get" %} {% endopenapi %} *** ## Buchungsregel Typ #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyMasterDataCatalog/BookingRuleType" method="get" %} {% endopenapi %} *** ## Buchungsvorgang Typ #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyMasterDataCatalog/VoucherProcessType" method="get" %} {% endopenapi %} *** ## Maßeinheiten für Mengenangaben #### Version 1.2 *** ## GET /openwowi/v1.2/AccountancyMasterDataCatalog/QuantityType > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.QuantityTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true},"ArgeCode":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/AccountancyMasterDataCatalog/QuantityType":{"get":{"tags":["OpenWowi AccountancyMasterData Catalog"],"operationId":"AccountancyMasterDataCatalog_GetQuantityTypes","parameters":[{"name":"apiKey","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.QuantityTypeDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.QuantityTypeDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommercialInventory.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.QuantityTypeDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Brennstoff / Energieart #### Version 1.2 *** ## GET /openwowi/v1.2/CommercialInventoryCatalog/FuelEnergyType > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"RunningCostDistribution.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.FuelEnergyTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/CommercialInventoryCatalog/FuelEnergyType":{"get":{"tags":["OpenWowi CommercialInventory Catalog"],"operationId":"CommercialInventoryCatalog_GetFuelEnergyType","parameters":[{"name":"apiKey","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RunningCostDistribution.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.FuelEnergyTypeDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RunningCostDistribution.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.FuelEnergyTypeDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RunningCostDistribution.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.FuelEnergyTypeDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` ## GET /openwowi/v1.2/AccountancyMasterDataCatalog/FuelEnergyType > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"RunningCostDistribution.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.FuelEnergyTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/AccountancyMasterDataCatalog/FuelEnergyType":{"get":{"tags":["OpenWowi AccountancyMasterData Catalog"],"operationId":"AccountancyMasterDataCatalog_GetFuelEnergyType","parameters":[{"name":"apiKey","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RunningCostDistribution.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.FuelEnergyTypeDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RunningCostDistribution.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.FuelEnergyTypeDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RunningCostDistribution.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.FuelEnergyTypeDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Enumeratoren für "AdministrationType". | Id | Name | | -- | ------------------------- | | 1 | Vollständige Verwaltung | | 2 | Fremdverwaltung | | 3 | WEG Verwaltung | | 4 | Genossenschaftsverwaltung | # Buchungsbelege Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "AccountancyVoucherProcess". {% hint style="warning" %} Um Buchungsbelege erfassen zu können, muss die Endpunktberechtigung "Belegsystem Buchungsvorgang erfassen" aktiviert werden. {% endhint %} {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} Buchungsbelege und -vorgänge können über den Controller "AccountancyTransactionData" abgefragt werden. Mehr dazu finden Sie [hier](/schnittstelle-v1.x/belegsystem/belegsystem-bewegungsdaten/bookings/buchungsbelege-und-vorgange). ## Buchungsvorgänge im Status "Erfassung" anlegen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyVoucherProcess/Create" method="post" %} {% endopenapi %} *** ## Buchungsvorgänge im Status "Freigabe" anlegen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/AccountancyVoucherProcess/CreateRelease" method="post" %} {% endopenapi %} *** # Budget Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "BudgetingRead" und "BudgetingCatalog". {% hint style="warning" %} Um Budgets abrufen zu können, muss die Endpunktberechtigung "Budget lesen" aktiviert werden. {% endhint %} {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Budgets abrufen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/BudgetingRead/Budget" method="get" %} {% endopenapi %} *** ## Budget Details abrufen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/BudgetingRead/{budgetId}/BudgetDetail" method="get" %} {% endopenapi %} *** # Kataloge {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Budgetdefinition #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/BudgetingCatalog/BudgetDefinition" method="get" %} {% endopenapi %} *** ## Budget Verwendung Typ #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/BudgetingCatalog/BudgetUsageType" method="get" %} {% endopenapi %} *** ## Budget Hierarchie Art #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/BudgetingCatalog/HierarchyType" method="get" %} {% endopenapi %} *** # Dokumente und Medien Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "DocumentRead" und "DocumentEdit". {% hint style="warning" %} Um Dokumente abrufen oder ändern zu können, müssen die Endpunktberechtigungen "Dokumente lesen" und "Dokumente ändern" aktiviert werden. Um Medien abrufen oder ändern zu können, müssen die Endpunktberechtigungen "Objektbilder lesen" und "Objektbilder ändern" aktiviert werden {% endhint %} {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Einrichtung des API-Keys Da die Dokumente für viele Entitäten hinterlegt werden können, wurde eine zusätzliche Konfiguration eingerichtet, welche es erlaubt, bestimmte Dokumtenobjekte für die API auszuwählen. Die Einrichtung erfolgt im jeweiligen API-Key im Tab "Dateien".
Die Selektion erfolgt nach einem Blacklist-Whitelist-System. Wenn Sie Entitäten oder Dateiarten ausschließen möchten, selektieren Sie diese mit der "Blacklist"-Auswahl. Wenn Sie Entitäten oder Dateiarten explizit erlauben möchten, verwenden Sie die "Whitelist"-Auswahl. Im Bereich "Dateien von bestimmten Objekten" können einzelne Entitäten für den Transfer selektiert werden. Im Bereich "Dateien bestimmter Dateiarten" wählen Sie erlaubte oder unterdrückte Dateiarten aus. Beide Selektionen werden gleichberechtigt angewendet. Die Selektion "Whitelist" und "Person" im Bereich Objektarten und die Selektion von "Blacklist" und "Allgemeines" im Bereich Dateiart würde die Dokumente aus der Entität "Person" ohne die Dokumente mit der Dateiart "Allgemeines" liefern. ## Definition von Dokumenten WOWIPORT erlaubt sowohl die Erstellung von Dokumenten im Microsoft Word- und im PDF-Format als auch den Upload von Dateien über eine entsprechende Funktion. Beide Dateiarten sind über die Schnittstelle verfügbar. Zudem können Dateien hochgeladen werden. Die Dateitypen finden Sie in der Liste am unteren Ende des Absatzes. Für Kunden mit einem WOWIPORT-DMS werden die Dokumente in einem angebundenen, externen System gespeichert. Diese Dokumente sind über unsere Schnittstelle nicht verfügbar. Erlaubte Dateitypen für den Upload:\ .pdf, .rtf, .xls, .xlsx, .doc, .docx, .txt, .jpg, .jpeg, .png, .gif, .tiff, .tif, .msg, .heic, .heif, .webp ## Einschränkungen für Kunden mit einem WOWIPORT-DMS Kunden, welche das WOWIPORT-DMS nutzen, unterliegen bestimmten Einschränkungen, da es ansonsten zu Konflikten mit dem bereits angebundenen DMS kommen kann. So ist die Zuordnung einer externen Dokumenten-ID über die schreibenden Endpunkte nicht gestattet. Der Tab "Externes DMS" sowie die dazugehörigen Schnittstellen für die Linkerstellung sind ebenfalls nicht verfügbar. ## Medien Die API für Medien folgt ähnlichen Mechanismen wie die API für Dokumente. Die Einrichtung der Dokumentberechtigungen ist hierfür allerdings nicht erforderlich. Lediglich die Endpunktberechtigungen müssen aktiviert werden. Die Medien können zusätzlich noch Thumbnails für die entsprechenden Bilddateien liefern. ## Encoding und Dateiintegrität Die Binärdatei wird grundsätzlich mit einer Base64-Encodierung übermittelt. Dies gilt sowohl für die Dokumentenübertragung an uns als auch für das Abrufen von Dateien. Zum Testen der Base64-Encodierung finden Sie kostenlose Tools z. B. im Editor "Notepad++" (beinhaltet ebenfalls einen Rechner für SHA1) oder unter . Bitte beachten Sie, dass es sich hierbei nur um Beispiele für kostenlose Testtools handelt. Um die Unversehrtheit der Dateien nach der Decodierung zu gewährleisten, benötigen wir einen SHA1-Hashkey der nicht-encodeten Binärdaten. Stimmt dieser mit unserer Berechnung überein, gehen wir davon aus, dass die Datei unverändert bei uns eingegangen ist und korrekt gespeichert wurde. # Dokumente lesen {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Metadaten zum Dokument abrufen
Hinweise zur Funktion Den "entityName" können Sie dem Katalog "FileEntity" entnehmen. WOWIPORT-Dokumente können unter Umständen unterschiedliche Revisionen beinhalten. Das Dokument (Node "Document") dient dabei als Container für die Revisionen. Wenn Sie vorherige Revisionen abrufen möchten, benötigen Sie den Parameter "IncludeRevision". Die FileGuid kann zwei Ausprägungen haben, welche jeweils entweder das PDF-Dokument oder das Word-Dokument repräsentieren. Die letzte Revision ist in der Top-Node als "FileGuid" hinterlegt. Beinhaltet die letzte Revision ein Word- und ein PDF-Dokument, finden Sie dort das PDF-Dokument. Hochgeladene Dateien haben keinen Dokumentencontainer und keine Revisionen.
#### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/DocumentRead/{entityName}/FileData" method="get" %} {% endopenapi %} *** ## Binärdatei abrufen
Hinweise zur Funktion Die Daten werden über die entsprechende FileGuid abgerufen. Für die Übertragung wurden die Dateien nach dem Base64-Verfahren encodiert. Weitere Informationen finden Sie auf der Seite "[Dokumente und Medien](/schnittstelle-v1.x/dokumente-und-medien)".
#### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/DocumentRead/{entityName}/FileContent/{fileGuid}" method="get" %} {% endopenapi %} *** ## Dokumentenvorlagen abrufen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/DocumentRead/{entityName}/DocumentTemplate" method="get" %} {% endopenapi %} *** ## Externe Dokumenten-Links abrufen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/DocumentRead/{entityName}/ExternalDocumentLinks" method="get" %} {% endopenapi %} *** # Dokumente ändern {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Dateien übertragen
Hinweise zur Funktion Die "ExternalDocumentId" erlaubt es Ihnen, Ihre eigene ID an das Dokument zu übertragen und nachzuverfolgen. Die "EntityId" ist die ID des Datensatzes der jeweiligen Entität, für die ein Dokument hochgeladen werden soll (Beispielsweise die ID einer einzelnen Rechnung wenn man über den "EntityName" Pfad "InvoiceReceipt" eine Rechnung übermittelt). Im Schlüssel "Contents" können Sie die Base64-encodierten Binärdaten hinterlegen. Der Upload ist auf eine Payload-Größe von 10 MB beschränkt. Der SHA1-Hashkey wird aus den nicht-encodierten Binärdaten errechnet und soll die Datenintegrität nach der Decodierung in unserem System gewährleisten. Stimmt der Hashkey nicht überein, wird die Datei nicht gespeichert. Weitere Informationen zur Encodierung und zum Hashkey erhalten Sie auf der Seite "[Dokumente und Medien](/schnittstelle-v1.x/dokumente-und-medien)". Die Funktionen "externe Dokumenten-Links speichern" und "externe Dokumenten-ID setzen" stehen Ihnen nicht zur Verfügung, wenn der Kunde bereits das WOWIPORT-DMS nutzt. Da die Testinstanz der OPEN WOWI über ein externes DMS verfügt, können die API-Endpunkte hier nicht getestet werden. Die Speicherung von neuen Dateien ist auch mit einem WOWIPORT-DMS möglich. Wir empfehlen jedoch, diese Dateien direkt im WOWIPORT-DMS zu speichern. Weitere Informationen zur Schnittstelle des WOWIPORT-DMS finden Sie bei unserem Partner [d.velop](https://help.d-velop.de/dev/documentation/dms-app).
#### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/DocumentEdit/{entityName}/File" method="post" %} {% endopenapi %} *** ## Externe Dokumenten-ID setzen
Hinweise zur Funktion Nach dem Abruf einer Datei und der Speicherung in einem externen DMS können Sie Ihre eigene ID an unser Dokument übergeben, um dieses erneut identifizieren zu können. Die "ExternalDocumentId" wird am Dokumentencontainer und nicht an der einzelnen Revision gespeichert. Wir empfehlen deshalb, die Nummer der Dokumentenrevision ebenfalls zu speichern, damit Sie Folge-Revisionen identifizieren können.
#### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/DocumentEdit/{entityName}/FileData/{fileGuid}/SetExternalDocumentId" method="put" %} {% endopenapi %} *** ## Externe Dokumenten-Links speichern Um Ihren Kunden die Möglichkeit zu geben, direkt aus WOWIPORT in die korrekten Dateien in einem externen DMS abzuspringen, bieten wir die Möglichkeit, einen neuen Tab "Externes DMS" in WOWIPORT anzulegen. In diesem Tab können Sie Links zu allen relevanten Dokumenten hinterlegen. Die Freischaltung dieses Tabs erfolgt über die API Key Konfiguration (siehe letzte Checkbox unterhalb der Endpunktberechtigungen in der [Beschreibung zur API Key Einrichtung](/grundlagen/einrichtung-openwowi)).
Bitte beachten Sie, dass diese Links nur über die API verwaltet werden können. Der Nutzer hat in der UI keine Möglichkeit zur Verwaltung der Links. Die Wartung der Links obliegt dem API-Nutzer. Bitte beachten Sie, dass diese Funktion nicht für Kunden mit einem [WOWIPORT DMS ](/schnittstelle-v1.x/dokumente-und-medien#einschrankungen-fur-kunden-mit-einem-wowiport-dms)zur Verfügung stehen. ## Externen Link anlegen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/DocumentEdit/{entityName}/ExternalDocumentLink" method="post" %} {% endopenapi %} *** ## Externen Link bearbeiten #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/DocumentEdit/{entityName}/ExternalDocumentLink/{externalDocumentLinkId}" method="put" %} {% endopenapi %} *** ## Externen Link löschen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/DocumentEdit/{entityName}/ExternalDocumentLink/{externalDocumentLinkId}" method="delete" %} {% endopenapi %} *** # Medien lesen {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Metadaten von Medien abrufen Den "entityName" können Sie dem Katalog "MediaEntity" entnehmen. #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/MediaRead/{entityName}/MediaData" method="get" %} {% endopenapi %} *** ## Binärdatei abrufen
Weitere Hinweise zur Funktion Die Daten werden über die entsprechende FileGuid abgerufen. Für die Übertragung wurden die Dateien nach dem Base64-Verfahren encodiert. Weitere Informationen finden Sie auf der Seite "[Dokumente und Medien](/schnittstelle-v1.x/dokumente-und-medien)".
#### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/MediaRead/{entityName}/MediaContent/{fileGuid}" method="get" %} {% endopenapi %} *** ## Thumbnails abrufen Die FileId des Thumbnails wird in den Metadaten gesondert angegeben und ist nicht identisch mit den Daten der Ursprungsdatei. #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/MediaRead/{entityName}/MediaThumbnailContent/{fileGuid}" method="get" %} {% endopenapi %} *** # Medien ändern {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Medien übertragen
Weitere Hinweise zur Funktion Im Schlüssel "Contents" können Sie die Base64-encodierten Binärdaten hinterlegen. Der Upload ist auf eine Payload-Größe von 10 MB beschränkt. Der SHA1-Hashkey wird aus den nicht-encodierten Binärdaten errechnet und soll die Datenintegrität nach der Decodierung in unserem System gewährleisten. Stimmt der Hashkey nicht überein, wird die Datei nicht gespeichert. Weitere Informationen zur Encodierung und zum Hashkey erhalten Sie auf der Seite "[Dokumente und Medien](/schnittstelle-v1.x/dokumente-und-medien)".
#### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/MediaEdit/{entityName}/Media" method="post" %} {% endopenapi %} *** ## Medien ändern #### Version 1.2 *** *** # Kataloge {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Dokument Entitäten #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/DocumentReadCatalog/FileEntity" method="get" %} {% endopenapi %} *** ## Dateiarten #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/DocumentReadCatalog/FileType" method="get" %} {% endopenapi %} *** ## Datenschutzkategorien #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/DocumentReadCatalog/DataPrivacyCategory" method="get" %} {% endopenapi %} *** ## Entitäten der Dokumentenvorlagen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/DocumentReadCatalog/DocumentTemplateEntity" method="get" %} {% endopenapi %} *** ## Bildtyp #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/MediaReadCatalog/EstatePictureType" method="get" %} {% endopenapi %} *** ## Medien Entitäten #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/MediaReadCatalog/MediaEntity" method="get" %} {% endopenapi %} *** # Finanzierung Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "Loans" und "LoansCatalog". {% hint style="warning" %} Um auf die Daten der Finanzierungen über die API zugreifen zu können, muss die Endpunktberechtigung "Finanzierung" aktiviert werden. {% endhint %} # Darlehensnehmer Abruf der Darlehensnehmer. {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Darlehensnehmer abrufen #### Version 1.1 *** {% openapi src="" path="/openwowi/v1.1/Loans/Borrower" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/Loans/Borrower" method="get" %} {% endopenapi %} *** # Darlehensgeber Abruf der Darlehengeber {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Darlehensgeber abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/Loans/Lender" method="get" %} {% endopenapi %} *** #### Version 1.1 *** {% openapi src="" path="/openwowi/v1.1/Loans/Lender" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/Loans/Lender" method="get" %} {% endopenapi %} *** # Darlehen Abruf der Darlehen {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Darlehen abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/Loans/LoanMasterData" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/Loans/Loan" method="get" %} {% endopenapi %} *** # Konditionen Abruf der Darlehenskonditionen ## Konditionen abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/Loans/LoanCondition" method="get" %} {% endopenapi %} *** Ab Version 1.2 können die Konditionen über einen Parameter im Abruf des Darlehens eingeschlossen werden. # Objektzuordnungen Abruf der Objektzuordnungen ## Objektzuordnung abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/Loans/LoanObjectAssignment" method="get" %} {% endopenapi %} *** Ab Version 1.2 können die Objektzuordnungen über einen Parameter im Abruf des Darlehens eingeschlossen werden. # Tilgungsplan Abruf des Tilgungsplans {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} Wir unterscheiden hier zwei verschiedene Abrufe. ## Abruf abgespeicherter Tilgungspläne #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/Loans/LoanRepaymentPlan" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/Loans/Loan/{loanId}/RepaymentPlan" method="get" %} {% endopenapi %} *** ## Abruf Tilgungspläne Echtzeit #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/Loans/LoanOnlineRepaymentPlan" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/Loans/Loan/{loanId}/OnlineRepaymentPlan" method="get" %} {% endopenapi %} *** # Zahlungen Abruf der Zahlungen ## Zahlungen abrufen #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/Loans/LoanPayout" method="get" %} {% endopenapi %} *** Diese Daten können ab Version 1.2 über den [Buchungs-Endpunkt](/schnittstelle-v1.x/belegsystem/belegsystem-bewegungsdaten/bookings) des Belegsystemes abgefragt werden. # Kataloge Abruf der Kataloge {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Darlehensarten Dieser Abruf enthält die Darlehensarten, welche dem Darlehen zugeordnet werden können. #### Version 1.0 *** {% openapi src="" path="/openwowi/v1.0/Loans/LoanTypes" method="get" %} {% endopenapi %} *** #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/LoansCatalog/LoanTypes" method="get" %} {% endopenapi %} *** # Fremdverwaltung Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "PropertyManagementContract" und "PropertyManagementPersonDetails". {% hint style="warning" %} Um auf die Daten der Fremdverwaltung über die API zugreifen zu können, müssen die Endpunktberechtigungen "Fremdverwaltung" und "Fremdverwaltung mit personenbezogenen Details" aktiviert werden. {% endhint %} # Fremdverwaltung Stammdaten {% hint style="warning" %} Um auf die Daten der Fremdverwaltung über die API zugreifen zu können, muss die Endpunktberechtigung "Fremdverwaltung" aktiviert werden. {% endhint %} {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Fremdverwaltungsverträge abrufen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/PropertyManagement/PropertyManagementContracts" method="get" %} {% endopenapi %} *** ## Vertragsvereinbarungen #### Version 1.2 *** *** # personenbezogene Daten der Fremdverwaltung {% hint style="warning" %} Um auf die personenbezogenen Daten der Fremdverwaltung über die API zugreifen zu können, muss die Endpunktberechtigung "Fremdverwaltung mit personenbezogenen Details" aktiviert werden. {% endhint %} {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Vertragsnehmer #### Version 1.2 *** ## GET /openwowi/v1.2/PropertyManagement/PropertyManagementPersonDetails/ContractParty > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"PropertyManagement.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.ContractPartyDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Type":{"$ref":"#/components/schemas/PropertyManagement.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PropertyManagementContractPartyTypeDto"},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"PersonId":{"type":"integer","format":"int32"},"DefaultBankaccount":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonBankAccountDto"},"AccessibilityId":{"type":"integer","format":"int32","nullable":true},"BankAccountId":{"type":"integer","format":"int32","nullable":true},"Person":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonRoleDto"},"DefaultAddress":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressDto"}},"additionalProperties":false},"PropertyManagement.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PropertyManagementContractPartyTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonBankAccountDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Iban":{"type":"string","nullable":true},"Bic":{"type":"string","nullable":true},"AccountHolder":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"BankAccountType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountTypeDto"},"BankAccountId":{"type":"integer","format":"int32"},"BankAccountUsageType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountUsageTypeDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountUsageTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonRoleDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"Shortname":{"type":"string","nullable":true},"Name":{"type":"string","nullable":true},"NodeId":{"type":"integer","format":"int32","nullable":true},"TaxNumber":{"type":"string","nullable":true},"TaxIdentificationNumber":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"IsNaturalPerson":{"type":"boolean"},"NaturalPerson":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonDto"},"LegalPerson":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonDto"},"Addresses":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressDto"},"nullable":true},"Communications":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"},"nullable":true},"BankAccounts":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonBankAccountDto"},"nullable":true},"FirstEmailCommunication":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"},"FirstLandlinePhoneCommunication":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"},"FirstMobilePhoneCommunication":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonDto":{"type":"object","properties":{"Title":{"type":"string","nullable":true},"FirstName":{"type":"string","nullable":true},"LastName":{"type":"string","nullable":true},"BirthName":{"type":"string","nullable":true},"CareOf":{"type":"string","nullable":true},"BirthDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"DeathDate":{"type":"string","format":"date-time","nullable":true},"Gender":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.GenderDto"},"MaritalType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.MaritalTypeDto"},"Nationality":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CountryDto"},"PersonInCare":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonUltraSlimDto"},"ContactFor":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonSlimDto"},"nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.GenderDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.MaritalTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CountryDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonUltraSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"LongName1":{"type":"string","nullable":true},"LongName2":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonDto":{"type":"object","properties":{"LongName1":{"type":"string","nullable":true},"LongName2":{"type":"string","nullable":true},"VatId":{"type":"string","nullable":true},"CommercialRegisterNumber":{"type":"string","nullable":true},"CommercialRegisterTown":{"type":"string","nullable":true},"ContractPersons":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonSlimDto"},"nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"FirstName":{"type":"string","nullable":true},"LastName":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Zip":{"type":"string","nullable":true},"Town":{"type":"string","nullable":true},"Street":{"type":"string","nullable":true},"HouseNumber":{"type":"string","nullable":true},"HouseNumberAddition":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"StreetComplete":{"type":"string","nullable":true},"HouseNumberComplete":{"type":"string","nullable":true},"MainAddress":{"type":"boolean"},"AddressType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressTypeDto"},"Country":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CountryDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"RelatedAddressId":{"type":"integer","format":"int32","nullable":true},"Content":{"type":"string","nullable":true},"Explanation":{"type":"string","nullable":true},"RelatedAddress":{"type":"string","nullable":true},"CommunicationType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationTypeDto"},"IsStandard":{"type":"boolean"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/PropertyManagement/PropertyManagementPersonDetails/ContractParty":{"get":{"tags":["OpenWowi PropertyManagement"],"operationId":"PropertyManagement_GetPropertyManagementContractPartys","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"personId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"propertyManagementContractPartyActiveOn","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"includeMainAddress","in":"query","schema":{"type":"boolean","default":false}},{"name":"includeMainCommunication","in":"query","schema":{"type":"boolean","default":false}},{"name":"includePersonAddresses","in":"query","schema":{"type":"boolean","default":false}},{"name":"includePersonCommunications","in":"query","schema":{"type":"boolean","default":false}},{"name":"includePersonBankAccounts","in":"query","schema":{"type":"boolean","default":false}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PropertyManagement.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.ContractPartyDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PropertyManagement.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.ContractPartyDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PropertyManagement.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.ContractPartyDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Zahlungsmodus #### Version 1.2 *** ## GET /openwowi/v1.2/PropertyManagement/PropertyManagementPersonDetails/PaymentModes > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"PropertyManagement.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PropertyManagementPaymentModeDto":{"type":"object","properties":{"Contractor":{"type":"string","nullable":true},"Mode":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"EntryDateTime":{"type":"string","format":"date-time"},"Iban":{"type":"string","nullable":true},"MandateId":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/PropertyManagement/PropertyManagementPersonDetails/PaymentModes":{"get":{"tags":["OpenWowi PropertyManagement"],"operationId":"PropertyManagement_GetPropertyManagementPaymentModes","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"validFrom","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"validTo","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PropertyManagement.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PropertyManagementPaymentModeDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PropertyManagement.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PropertyManagementPaymentModeDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PropertyManagement.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PropertyManagementPaymentModeDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** # Kommunikationsmodul Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "CommunicationRead", "CommunicationEdit" und "CommunicationCatalog". {% hint style="danger" %} Bei dem Kommunikationsmodul handelt es sich um ein kostenpflichtiges Zusatzmodul. Bitte informieren Sie sich bei Ihrem Kunden, ob dieses Modul gebucht wurde. {% endhint %} {% hint style="warning" %} Um auf die Endpunkte des Kommunikationsmoduls zugreifen zu können, benötigen Sie die Endpunktberechtigungen "Ticket lesen" und "Ticket ändern". {% endhint %} ## Einleitung Das Kommunikationsmodul ist eine neue Applikation in WOWIPORT. Dieses Modul ist vorrangig darauf ausgerichtet, die Kommunikation von Partneranwendungen mit den Anwendern von WOWIPORT zu gewährleisten. Bei der Verwendung von schreibenden Endpunkten kommt es unweigerlich zu Situationen, in denen ein Teil des Prozesses in der Partneranwendung abgebildet wird, während Folgeprozesse in WOWIPORT vollzogen werden müssen. Das Kommunikationsmodul soll diese Lücke schließen. Sie können das Modul nutzen, um den Sachbearbeitern in WOWIPORT Nachrichten zu senden und erstellte Objekte beizufügen. ## Einrichtung Das Kommunikationsmodul ist an Quellen gebunden. Die Absenderquelle definiert, wer auf ein Ticket oder eine Nachricht Zugriff hat. Hierdurch ist gewährleistet, dass unbefugte Dritte keinen Zugriff auf die Kommunikation zwischen Ihrer Anwendung und WOWIPORT erhalten. Um eine neue Nachrichtenquelle anzulegen, muss der Kunde in WOWIPORT die Berechtigungen "Kommunikation" / "Nachrichtenquelle" haben. Im Menü "Kommunikation" können dann unter "Einstellungen" die Nachrichtenquellen angelegt werden.
Wenn eine Nachrichtenquelle angelegt wird, können Sie Pflichtfelder für diese Nachrichten definieren. Zudem benötigt die Nachrichtenquelle jeweils einen Nachrichtenstatus für jeden Zustand der Nachricht:
Es müssen mindestens Status für "neu", "gelesen" und "beendet" definiert werden. Die Nachrichtenquelle muss dann einem Nutzer und einem API-Key zugewiesen werden. In der API-Key-Konfiguration können beide Einstellungen vorgenommen werden.

Nutzer und Nachrichtenquelle verknüpfen

# Beispiel Workflow Hier finden Sie Beispiele, wie die API in der Praxis angewendet werden kann. In diesem Beispiel findet ein Startereignis in einer Partneranwendung auf Ebene der Nutzungseinheit statt. Die Anwendung erzeugt eine Nachricht und der Sachbearbeiter antwortet innerhalb der Nachricht. Die Partneranwendung ergänzt dann eine weitere Antwort.
# Ticket lesen Mit diesen Endpunkten können Sie Tickets lesen. {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Ticket lesen
Hinweise zur Funktion Bei der Kommunikation über die API wird die "UserId" üblicherweise immer vorhanden sein, da nur registrierte WOWIPORT Benutzer die Schnittstellen bzw. die Benutzeroberfläche verwenden können. \ Bei der Weiterentwicklung des Kommunikationsmodules werden jedoch auch andere Kommunikationsmittel berücksichtigt. Bei einer Kommunikation via E-Mail wird der Benutzer durch eine verknüpfte Person bzw. durch die Node "Person" im Bereich "Communication" ersetzt. Bitte beachten Sie die verschiedenen Abhängigkeiten bei unterschiedlichen Kommunikationsformen. Der Schlüssel "CommentFromApi" sagt aus, dass der "Mitarbeiter" im Kommentar gem. Benutzeroberfläche in WOWIPORT, dem Benutzer entspricht, der den Abruf der Tickets über die API vornimmt. Dieser User ist in dem Feld "API User" im API Key definiert. Bei der Nutzung des "AddComment" Endpunktes wird diese Spalte in der Nachricht in WOWIPORT immer leer sein. Im Endpunkt "AddConversation" kann die UserId mit gesendet werden. \ Um ausgehende von eingehenden Nachrichten zu unterscheiden, verwenden Sie bitte den Schlüssel "InboundComment".
#### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommunicationRead/Ticket" method="get" %} {% endopenapi %} *** # Ticket bearbeiten Mit diesen Endpunkten können Sie Tickets bearbeiten.
Hinweise zur Funktion Das Kommunikationsmodul sollte Anwendung finden, wenn Sie über eine API ein neues Objekt erstellen und erwartet wird, dass dieses Objekt in WOWIPORT weiterverarbeitet wird. Beispiele hierfür wären: * Ein vorgeschlagener Vertragsnehmer wird erstellt. * Eine Rechnung wird übergeben. * Ein Auftrag wurde erstellt. "AssignmentEntityId" verweist auf die Entitäts-ID aus dem entsprechenden Katalog. Die ID des Objektes wird im Schlüssel "EntityId" angegeben.\ \ Daten zu den Abteilungen können in den Objektdaten abgerufen werden.\
{% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Ticket anlegen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommunicationEdit/Ticket" method="post" %} {% endopenapi %} *** ## Kommentar hinzufügen {% hint style="danger" %} Dieser Endpunkt wird zukünftig zugunsten der Konversationen abgekündigt. Der Endpunkt ist mit den Tickets weiterhin kompatibel, allerdings fehlen wesentliche Daten für die Konversationen. {% endhint %} #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommunicationEdit/Ticket/AddComment" method="post" expanded="false" %} {% endopenapi %} *** ## Konversationen hinzufügen
Hinweise zur Funktion Sie können in den Konversationen andere Ticketquellen verwenden, wenn diese Ihrem API Key zugeordnet sind. Die "Location" kann nur in der Nachrichtenquelle "Gesprächsnotiz" verwendet werden.
#### Version 1.2 *** ## POST /openwowi/v1.2/CommunicationEdit/Ticket/AddConversation > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"CommunicationCenter.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.EditServiceDto.TicketAddConversationDto":{"type":"object","properties":{"TicketId":{"type":"integer","format":"int32"},"TicketSourceId":{"type":"integer","format":"int32"},"PersonId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"CreatedAt":{"type":"string","format":"date-time"},"Location":{"type":"string","nullable":true},"Content":{"type":"string","nullable":true}},"additionalProperties":false},"CommunicationCenter.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.EditServiceDto.TicketConversationChangeResultDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"CommentId":{"type":"integer","format":"int32"}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/CommunicationEdit/Ticket/AddConversation":{"post":{"tags":["OpenWowi Communication Edit"],"operationId":"CommunicationEdit_AddTicketConversation","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunicationCenter.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.EditServiceDto.TicketAddConversationDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/CommunicationCenter.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.EditServiceDto.TicketAddConversationDto"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CommunicationCenter.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.EditServiceDto.TicketAddConversationDto"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CommunicationCenter.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.EditServiceDto.TicketConversationChangeResultDto"}},"application/json":{"schema":{"$ref":"#/components/schemas/CommunicationCenter.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.EditServiceDto.TicketConversationChangeResultDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/CommunicationCenter.Bll.Services.RestAPIServices.OpenWowi.Dto_V1_2.EditServiceDto.TicketConversationChangeResultDto"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Ticket löschen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommunicationEdit/Ticket/{ticketId}" method="delete" %} {% endopenapi %} *** # Kataloge Hier finden Sie die Kataloge für das Kommunikationsmodul. ## Zugeordnete Entitäten #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommunicationCatalog/TicketAssignmentEntity" method="get" %} {% endopenapi %} *** ## Ticket Priorität #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommunicationCatalog/TicketPriority" method="get" %} {% endopenapi %} *** ## Ticket Quellen
Hinweise zur Funktion Sie können alle Ticketquellen des Kantonsystems sehen. Ob sie diese Ticketquellen in einem schreibenden Endpunkt verwenden können, hängt von der Konfiguration des API Keys ab. Sie können diese Information im Feld "AllowTicketCreationForApiKey" sehen. Bestimmte Ticketquellen (z.B. das Anrufprotokoll) sind für die API Anlage grundsätzlich gesperrt.
#### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommunicationCatalog/TicketSource" method="get" %} {% endopenapi %} *** ## Ticket Status #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/CommunicationCatalog/TicketStatus" method="get" %} {% endopenapi %} *** # Mahnwesen Die Endpunkte dieser Berechtigung finden Sie im Controller "DunningRead" und "DunningCatalog". {% hint style="warning" %} Um auf die Daten des Mahnwesens über die API zugreifen zu können, muss die Endpunktberechtigung "Mahnwesen lesen" aktiviert werden. {% endhint %} # Stammdaten Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "DunningRead". {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Mahn- und Klagevorfall abrufen
Hinweise zur Funktion Bitte beachten Sie, dass "RentAccountId" und "DunningRentAccountId" nicht deckungsgleich sind. Sie kommen über diese ID nicht auf das Vertragskonto. "DunningRentAccount" beschreibt einen Container, der verschiedene- Mahn und Klagevorfälle umfasst, ansonsten aber ohne Inhalt ist und deshalb keinen eigenen Endpunkt besitzt. Eine Verbindung zum Nutzungsvertrag wird demnächst bereitgestellt.
#### Version 1.2 *** ## GET /openwowi/v1.2/DunningRead/DunningIncident > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningIncidentDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"Status":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningIncidentStatusDto"},"ProceduralNumber":{"type":"string","nullable":true},"InLegalDepartmentSince":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"Description":{"type":"string","nullable":true},"SpecialFeaures":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningSpecialFeaturesDto"},"DebtorProceeding":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DebtorProceedingDto"},"DunningProcedures":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningIncidentProcedureDto"},"nullable":true},"DunningRentAccountId":{"type":"integer","format":"int32"},"DunningLevelResets":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningLevelResetDto"},"nullable":true},"DunningLevelRaises":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningLevelRaiseDto"},"nullable":true}},"additionalProperties":false},"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningIncidentStatusDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningSpecialFeaturesDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DebtorProceedingDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"PersonId":{"type":"integer","format":"int32"},"LocalCourt":{"type":"string","nullable":true},"ResolutionNumber":{"type":"string","nullable":true},"ResolutionValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ResolutionValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"LiquidatorId":{"type":"integer","format":"int32","nullable":true},"Info":{"type":"string","nullable":true},"DebtorProceedingsType":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DebtorProceedingTypeDto"},"TrustAccount":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountDto"}},"additionalProperties":false},"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DebtorProceedingTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Iban":{"type":"string","nullable":true},"Bic":{"type":"string","nullable":true},"AccountHolder":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"BankAccountType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountTypeDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningIncidentProcedureDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"DunningDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"Description":{"type":"string","nullable":true},"Deadline":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ObjectionDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"Amount":{"type":"number","format":"decimal","nullable":true},"ReminderFee":{"type":"number","format":"decimal","nullable":true},"ReminderInterestAmount":{"type":"number","format":"decimal","nullable":true},"ResponsibleLawyerId":{"type":"integer","format":"int32","nullable":true},"DistrictCourtId":{"type":"integer","format":"int32","nullable":true},"DunningProcedure":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningProcedureControlSlimDto"},"DunningProcedureNextStep":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningProcedureControlSlimDto"}},"additionalProperties":false},"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningProcedureControlSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningLevelResetDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"FromLevel":{"type":"integer","format":"int32"},"ToLevel":{"type":"integer","format":"int32"},"Date":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"}},"additionalProperties":false},"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningLevelRaiseDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Date":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/DunningRead/DunningIncident":{"get":{"tags":["OpenWowi DunningRead"],"operationId":"DunningRead_GetDunningIncident","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"useUnitId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"useUnitIdNum","in":"query","schema":{"type":"string"}},{"name":"economicUnitId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"economicUnitIdNum","in":"query","schema":{"type":"string"}},{"name":"licenseAgreementId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"licenseAgreementIdNum","in":"query","schema":{"type":"string"}},{"name":"contractorId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"contractorIdNum","in":"query","schema":{"type":"string"}},{"name":"managementId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"responsibleOfficialId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningIncidentDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningIncidentDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningIncidentDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Mahn- und Klage Maßnahme abrufen #### Version 1.2 *** ## GET /openwowi/v1.2/DunningRead/DunningProcedure > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningProcedureDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true},"DunningLevelShort":{"type":"integer","format":"int32"},"DunningLevel":{"$ref":"#/components/schemas/Contracts.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.DunningLevelDto"},"DunningProcedureType":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningProcedureTypeDto"},"DunningProcedureClassification":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningProcedureClassificationDto"},"DunningProcedureNextStep":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningProcedureControlSlimDto"}},"additionalProperties":false},"Contracts.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.DunningLevelDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningProcedureTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningProcedureClassificationDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningProcedureControlSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/DunningRead/DunningProcedure":{"get":{"tags":["OpenWowi DunningRead"],"operationId":"DunningRead_GetDunningProcedure","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningProcedureDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningProcedureDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningProcedureDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Rechtsanwälte #### Version 1.2 *** ## GET /openwowi/v1.2/DunningRead/Lawyer > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.LawyerDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Person":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonRoleDto"},"DefaultAddress":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressDto"},"DefaultBankaccount":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonBankAccountDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonRoleDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"Shortname":{"type":"string","nullable":true},"Name":{"type":"string","nullable":true},"NodeId":{"type":"integer","format":"int32","nullable":true},"TaxNumber":{"type":"string","nullable":true},"TaxIdentificationNumber":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"IsNaturalPerson":{"type":"boolean"},"NaturalPerson":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonDto"},"LegalPerson":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonDto"},"Addresses":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressDto"},"nullable":true},"Communications":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"},"nullable":true},"BankAccounts":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonBankAccountDto"},"nullable":true},"FirstEmailCommunication":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"},"FirstLandlinePhoneCommunication":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"},"FirstMobilePhoneCommunication":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonDto":{"type":"object","properties":{"Title":{"type":"string","nullable":true},"FirstName":{"type":"string","nullable":true},"LastName":{"type":"string","nullable":true},"BirthName":{"type":"string","nullable":true},"CareOf":{"type":"string","nullable":true},"BirthDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"DeathDate":{"type":"string","format":"date-time","nullable":true},"Gender":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.GenderDto"},"MaritalType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.MaritalTypeDto"},"Nationality":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CountryDto"},"PersonInCare":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonUltraSlimDto"},"ContactFor":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonSlimDto"},"nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.GenderDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.MaritalTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CountryDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonUltraSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"LongName1":{"type":"string","nullable":true},"LongName2":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonDto":{"type":"object","properties":{"LongName1":{"type":"string","nullable":true},"LongName2":{"type":"string","nullable":true},"VatId":{"type":"string","nullable":true},"CommercialRegisterNumber":{"type":"string","nullable":true},"CommercialRegisterTown":{"type":"string","nullable":true},"ContractPersons":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonSlimDto"},"nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"FirstName":{"type":"string","nullable":true},"LastName":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Zip":{"type":"string","nullable":true},"Town":{"type":"string","nullable":true},"Street":{"type":"string","nullable":true},"HouseNumber":{"type":"string","nullable":true},"HouseNumberAddition":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"StreetComplete":{"type":"string","nullable":true},"HouseNumberComplete":{"type":"string","nullable":true},"MainAddress":{"type":"boolean"},"AddressType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressTypeDto"},"Country":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CountryDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"RelatedAddressId":{"type":"integer","format":"int32","nullable":true},"Content":{"type":"string","nullable":true},"Explanation":{"type":"string","nullable":true},"RelatedAddress":{"type":"string","nullable":true},"CommunicationType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationTypeDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonBankAccountDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Iban":{"type":"string","nullable":true},"Bic":{"type":"string","nullable":true},"AccountHolder":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"BankAccountType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountTypeDto"},"BankAccountId":{"type":"integer","format":"int32"},"BankAccountUsageType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountUsageTypeDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountUsageTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/DunningRead/Lawyer":{"get":{"tags":["OpenWowi DunningRead"],"operationId":"DunningRead_GetLawyer","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"personId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"personNumber","in":"query","schema":{"type":"string"}},{"name":"includeMainAddress","in":"query","schema":{"type":"boolean","default":false}},{"name":"includePersonAddresses","in":"query","schema":{"type":"boolean","default":false}},{"name":"includeMainCommunication","in":"query","schema":{"type":"boolean","default":false}},{"name":"includePersonBankAccounts","in":"query","schema":{"type":"boolean","default":false}},{"name":"includePersonCommunications","in":"query","schema":{"type":"boolean","default":false}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.LawyerDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.LawyerDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.LawyerDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Amtsgerichte #### Version 1.2 *** ## GET /openwowi/v1.2/DunningRead/DistrictCourt > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DistrictCourtDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Person":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonRoleDto"},"DefaultAddress":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressDto"},"DefaultBankaccount":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonBankAccountDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonRoleDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"Shortname":{"type":"string","nullable":true},"Name":{"type":"string","nullable":true},"NodeId":{"type":"integer","format":"int32","nullable":true},"TaxNumber":{"type":"string","nullable":true},"TaxIdentificationNumber":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"IsNaturalPerson":{"type":"boolean"},"NaturalPerson":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonDto"},"LegalPerson":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonDto"},"Addresses":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressDto"},"nullable":true},"Communications":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"},"nullable":true},"BankAccounts":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonBankAccountDto"},"nullable":true},"FirstEmailCommunication":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"},"FirstLandlinePhoneCommunication":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"},"FirstMobilePhoneCommunication":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonDto":{"type":"object","properties":{"Title":{"type":"string","nullable":true},"FirstName":{"type":"string","nullable":true},"LastName":{"type":"string","nullable":true},"BirthName":{"type":"string","nullable":true},"CareOf":{"type":"string","nullable":true},"BirthDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"DeathDate":{"type":"string","format":"date-time","nullable":true},"Gender":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.GenderDto"},"MaritalType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.MaritalTypeDto"},"Nationality":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CountryDto"},"PersonInCare":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonUltraSlimDto"},"ContactFor":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonSlimDto"},"nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.GenderDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.MaritalTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CountryDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonUltraSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"LongName1":{"type":"string","nullable":true},"LongName2":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonDto":{"type":"object","properties":{"LongName1":{"type":"string","nullable":true},"LongName2":{"type":"string","nullable":true},"VatId":{"type":"string","nullable":true},"CommercialRegisterNumber":{"type":"string","nullable":true},"CommercialRegisterTown":{"type":"string","nullable":true},"ContractPersons":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonSlimDto"},"nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"FirstName":{"type":"string","nullable":true},"LastName":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Zip":{"type":"string","nullable":true},"Town":{"type":"string","nullable":true},"Street":{"type":"string","nullable":true},"HouseNumber":{"type":"string","nullable":true},"HouseNumberAddition":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"StreetComplete":{"type":"string","nullable":true},"HouseNumberComplete":{"type":"string","nullable":true},"MainAddress":{"type":"boolean"},"AddressType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressTypeDto"},"Country":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CountryDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"RelatedAddressId":{"type":"integer","format":"int32","nullable":true},"Content":{"type":"string","nullable":true},"Explanation":{"type":"string","nullable":true},"RelatedAddress":{"type":"string","nullable":true},"CommunicationType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationTypeDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonBankAccountDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Iban":{"type":"string","nullable":true},"Bic":{"type":"string","nullable":true},"AccountHolder":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"BankAccountType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountTypeDto"},"BankAccountId":{"type":"integer","format":"int32"},"BankAccountUsageType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountUsageTypeDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountUsageTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/DunningRead/DistrictCourt":{"get":{"tags":["OpenWowi DunningRead"],"operationId":"DunningRead_GetDistrictCourt","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"personId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"personNumber","in":"query","schema":{"type":"string"}},{"name":"includeMainAddress","in":"query","schema":{"type":"boolean","default":false}},{"name":"includePersonAddresses","in":"query","schema":{"type":"boolean","default":false}},{"name":"includeMainCommunication","in":"query","schema":{"type":"boolean","default":false}},{"name":"includePersonBankAccounts","in":"query","schema":{"type":"boolean","default":false}},{"name":"includePersonCommunications","in":"query","schema":{"type":"boolean","default":false}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DistrictCourtDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DistrictCourtDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DistrictCourtDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Insolvenzverwalter #### Version 1.2 *** ## GET /openwowi/v1.2/DunningRead/Liquidator > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.LiquidatorDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Person":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonRoleDto"},"DefaultAddress":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressDto"},"DefaultBankaccount":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonBankAccountDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonRoleDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"Shortname":{"type":"string","nullable":true},"Name":{"type":"string","nullable":true},"NodeId":{"type":"integer","format":"int32","nullable":true},"TaxNumber":{"type":"string","nullable":true},"TaxIdentificationNumber":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"IsNaturalPerson":{"type":"boolean"},"NaturalPerson":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonDto"},"LegalPerson":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonDto"},"Addresses":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressDto"},"nullable":true},"Communications":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"},"nullable":true},"BankAccounts":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonBankAccountDto"},"nullable":true},"FirstEmailCommunication":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"},"FirstLandlinePhoneCommunication":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"},"FirstMobilePhoneCommunication":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonDto":{"type":"object","properties":{"Title":{"type":"string","nullable":true},"FirstName":{"type":"string","nullable":true},"LastName":{"type":"string","nullable":true},"BirthName":{"type":"string","nullable":true},"CareOf":{"type":"string","nullable":true},"BirthDate":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"DeathDate":{"type":"string","format":"date-time","nullable":true},"Gender":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.GenderDto"},"MaritalType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.MaritalTypeDto"},"Nationality":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CountryDto"},"PersonInCare":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonUltraSlimDto"},"ContactFor":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonSlimDto"},"nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.GenderDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.MaritalTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CountryDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonUltraSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"LongName1":{"type":"string","nullable":true},"LongName2":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.LegalPersonDto":{"type":"object","properties":{"LongName1":{"type":"string","nullable":true},"LongName2":{"type":"string","nullable":true},"VatId":{"type":"string","nullable":true},"CommercialRegisterNumber":{"type":"string","nullable":true},"CommercialRegisterTown":{"type":"string","nullable":true},"ContractPersons":{"type":"array","items":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonSlimDto"},"nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.NaturalPersonSlimDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"IdNum":{"type":"string","nullable":true},"FirstName":{"type":"string","nullable":true},"LastName":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Zip":{"type":"string","nullable":true},"Town":{"type":"string","nullable":true},"Street":{"type":"string","nullable":true},"HouseNumber":{"type":"string","nullable":true},"HouseNumberAddition":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"StreetComplete":{"type":"string","nullable":true},"HouseNumberComplete":{"type":"string","nullable":true},"MainAddress":{"type":"boolean"},"AddressType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressTypeDto"},"Country":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CountryDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.AddressTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"RelatedAddressId":{"type":"integer","format":"int32","nullable":true},"Content":{"type":"string","nullable":true},"Explanation":{"type":"string","nullable":true},"RelatedAddress":{"type":"string","nullable":true},"CommunicationType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationTypeDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.CommunicationTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.PersonBankAccountDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Iban":{"type":"string","nullable":true},"Bic":{"type":"string","nullable":true},"AccountHolder":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"BankAccountType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountTypeDto"},"BankAccountId":{"type":"integer","format":"int32"},"BankAccountUsageType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountUsageTypeDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountUsageTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/DunningRead/Liquidator":{"get":{"tags":["OpenWowi DunningRead"],"operationId":"DunningRead_GetLiquidator","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"personId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"personNumber","in":"query","schema":{"type":"string"}},{"name":"includeMainAddress","in":"query","schema":{"type":"boolean","default":false}},{"name":"includePersonAddresses","in":"query","schema":{"type":"boolean","default":false}},{"name":"includeMainCommunication","in":"query","schema":{"type":"boolean","default":false}},{"name":"includePersonBankAccounts","in":"query","schema":{"type":"boolean","default":false}},{"name":"includePersonCommunications","in":"query","schema":{"type":"boolean","default":false}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.LiquidatorDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.LiquidatorDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.LiquidatorDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Schuldnerverfahren #### Version 1.2 *** ## GET /openwowi/v1.2/DunningRead/DebtorProceeding > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DebtorProceedingDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"PersonId":{"type":"integer","format":"int32"},"LocalCourt":{"type":"string","nullable":true},"ResolutionNumber":{"type":"string","nullable":true},"ResolutionValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ResolutionValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"LiquidatorId":{"type":"integer","format":"int32","nullable":true},"Info":{"type":"string","nullable":true},"DebtorProceedingsType":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DebtorProceedingTypeDto"},"TrustAccount":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountDto"}},"additionalProperties":false},"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DebtorProceedingTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Iban":{"type":"string","nullable":true},"Bic":{"type":"string","nullable":true},"AccountHolder":{"type":"string","nullable":true},"ValidFrom":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date"},"ValidTo":{"pattern":"\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])","type":"string","format":"date","nullable":true},"BankAccountType":{"$ref":"#/components/schemas/Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountTypeDto"}},"additionalProperties":false},"Persons.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.BankAccountTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/DunningRead/DebtorProceeding":{"get":{"tags":["OpenWowi DunningRead"],"operationId":"DunningRead_GetDebtorProceeding","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"personId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"personNumber","in":"query","schema":{"type":"string"}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DebtorProceedingDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DebtorProceedingDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DebtorProceedingDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** # Kataloge Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "DunningCatalog". {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Mahnstufe #### Version 1.2 *** ## GET /openwowi/v1.2/DunningCatalog/DunningLevel > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Contracts.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.DunningLevelDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/DunningCatalog/DunningLevel":{"get":{"tags":["OpenWowi DunningRead Catalog"],"operationId":"DunningCatalog_GetDunningLevel","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Contracts.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.DunningLevelDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Contracts.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.DunningLevelDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Contracts.Bll.Services.RestApiServices.OpenWowi.Dto_V1_2.DunningLevelDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Maßnahmenart #### Version 1.2 *** ## GET /openwowi/v1.2/DunningCatalog/DunningProcedureType > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningProcedureTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/DunningCatalog/DunningProcedureType":{"get":{"tags":["OpenWowi DunningRead Catalog"],"operationId":"DunningCatalog_GetDunningProcedureType","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningProcedureTypeDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningProcedureTypeDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningProcedureTypeDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Maßnahmenklassifikation #### Version 1.2 *** ## GET /openwowi/v1.2/DunningCatalog/DunningProcedureClassification > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningProcedureClassificationDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/DunningCatalog/DunningProcedureClassification":{"get":{"tags":["OpenWowi DunningRead Catalog"],"operationId":"DunningCatalog_GetDunningProcedureClassification","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningProcedureClassificationDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningProcedureClassificationDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningProcedureClassificationDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Schuldnerverfahren #### Version 1.2 *** ## GET /openwowi/v1.2/DunningCatalog/DebtorProceedingType > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DebtorProceedingTypeDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/DunningCatalog/DebtorProceedingType":{"get":{"tags":["OpenWowi DunningRead Catalog"],"operationId":"DunningCatalog_GetDebtorProceedingType","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DebtorProceedingTypeDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DebtorProceedingTypeDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DebtorProceedingTypeDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Mahnung Status #### Version 1.2 *** ## GET /openwowi/v1.2/DunningCatalog/DunningStatus > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningStatusDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/DunningCatalog/DunningStatus":{"get":{"tags":["OpenWowi DunningRead Catalog"],"operationId":"DunningCatalog_GetDunningStatus","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningStatusDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningStatusDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningStatusDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** ## Mahnbesonderheiten #### Version 1.2 *** ## GET /openwowi/v1.2/DunningCatalog/SpecialFeatures > ```json {"openapi":"3.0.4","info":{"title":"OpenWowi","version":"V1.2"},"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"oauth2","description":"Use username and password.","flows":{"password":{"tokenUrl":"../oauth2/token","scopes":{}}}}},"schemas":{"Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningSpecialFeaturesDto":{"type":"object","properties":{"Id":{"type":"integer","format":"int32"},"Code":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/openwowi/v1.2/DunningCatalog/SpecialFeatures":{"get":{"tags":["OpenWowi DunningRead Catalog"],"operationId":"DunningCatalog_GetDunningSpecialFeatures","parameters":[{"name":"apiKey","in":"query","schema":{"type":"string"}},{"name":"showNullValues","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningSpecialFeaturesDto"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningSpecialFeaturesDto"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dunning.Bll.Services.RestApiServices.OpenWowi.Dto_v1_2.DunningSpecialFeaturesDto"}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"Unauthorized"}}}}}} ``` *** # Mängel Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "DefectEdit". {% hint style="warning" %} Um auf die Daten der Mängel über die API zugreifen zu können, muss die Endpunktberechtigung "Mängel bearbeiten" aktiviert werden. {% endhint %} {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Mängel anlegen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/DefectEdit/Defect" method="post" %} {% endopenapi %} *** ## Mängel ändern #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/DefectEdit/Defect/{defectId}" method="put" %} {% endopenapi %} *** ## Mängel löschen #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/DefectEdit/Defect/{defectId}" method="delete" %} {% endopenapi %} *** ## Enumerationen für RestorationDutyId | ID | Code | Deutsch | | -: | -------------- | ----------- | | 1 | None | Keine | | 2 | Renter | Mieter | | 3 | Owner | Vermieter | | 4 | FollowUpRenter | Folgemieter | | 5 | PreviousRenter | Vormieter | # Mietanpassungen Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "RentAdjustmentCatalog" und "RentAdjustment". {% hint style="warning" %} Um auf die Daten der Mietanpassungen über die API zugreifen zu können, muss die Endpunktberechtigung "Mietanpassung" aktiviert werden. {% endhint %} {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Mietspiegel #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/RentAdjustment/RentIndex" method="get" %} {% endopenapi %} *** ## Altersklasse #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/RentAdjustment/RentIndex/{rentIndexId}/AgeClass" method="get" %} {% endopenapi %} *** ## Wohnungsgrößenklasse #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/RentAdjustment/RentIndex/{rentIndexId}/ApartmentSizeClass" method="get" %} {% endopenapi %} *** ## Wohnlage #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/RentAdjustment/RentIndex/{rentIndexId}/Area" method="get" %} {% endopenapi %} *** ## Sanierungsstatus #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/RentAdjustment/RentIndex/{rentIndexId}/RemediationStatus" method="get" %} {% endopenapi %} *** ## Objekt #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/RentAdjustment/RentIndex/{rentIndexId}/Facility" method="get" %} {% endopenapi %} *** ## Profile
Hinweise zur Funktion Profile beschreiben die Summe an Merkmalen, welche den Mietwert bestimmen. Ein Profil wird innerhalb des Mietspiegels angelegt. Eine Nutzungseinheit, welche einem Profil entspricht, wird dann entsprechend neu bepreist.
#### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/RentAdjustment/RentIndex/Profiles" method="get" %} {% endopenapi %} *** ## Nutzungseinheiten Mietanpassung
Hinweise zur Funktion Die Mietanpassungen werden nicht direkt auf Basis der Daten der Nutzungseinheiten (CommercialInventory) bestimmt. Die Daten werden im Mietanpassungsmodul gespiegelt aufbewahrt und für die Mietanpassungen verwendet. \ In dieser Spiegelung können zusätzliche Daten erfasst werden, welche im Bestand nicht verfügbar sind.\ Diese Daten können über den untenstehenden Endpunkt abgerufen werden.
#### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/RentAdjustment/UseUnitRentAdjustments" method="get" %} {% endopenapi %} *** # Kataloge Hier finden Sie Kataloge zur Mietanpassung. {% hint style="danger" %} Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren. {% endhint %} ## Rechtsform #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/RentAdjustmentCatalog/LegalState" method="get" %} {% endopenapi %} *** ## Gemeinde #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/RentAdjustmentCatalog/Municipality" method="get" %} {% endopenapi %} *** ## Kappungsgrenze #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/RentAdjustmentCatalog/CapLimit" method="get" %} {% endopenapi %} *** ## Sondermerkmale #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/RentAdjustmentCatalog/SpecialAttribute" method="get" %} {% endopenapi %} *** ## Ausstattung-Merkmalsgruppe #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/RentAdjustmentCatalog/FacilityCharacteristicGroup" method="get" %} {% endopenapi %} *** ## Ausstattungsmerkmal #### Version 1.2 *** {% openapi src="" path="/openwowi/v1.2/RentAdjustmentCatalog/FacilityCharacteristic" method="get" %} {% endopenapi %} *** # Mietenbuchhaltung Die Endpunkte dieser Berechtigung finden Sie im Controller "RentAccounting", "RentAccountingTransactionData" und "RentAccountingPersonDetails". {% hint style="warning" %} Um auf die Daten der Mietenbuchhaltung über die API zugreifen zu können, müssen die Endpunktberechtigungen "Vertragsdaten ohne personenbezogene Details", "Vertragsdaten mit personenbezogenen Details" sowie "Verträge Bewegungen" aktiviert werden. {% endhint %} Für die Mietenbuchhaltung unterscheiden wir in zwei Berechtigungen. {% content-ref url="/pages/YxcUN4WUePkVPCEpRD1l" %} [Endpunkte ohne personenbezogene Daten](/schnittstelle-v1.x/mietenbuchhaltung/endpunkte-ohne-personenbezogenen-daten) {% endcontent-ref %} {% content-ref url="/pages/PboXWoTOQlOSkBr5uoYZ" %} [Endpunkte mit personenbezogenen Daten](/schnittstelle-v1.x/mietenbuchhaltung/endpunkte-mit-personenbezogenen-daten) {% endcontent-ref %} --- [Next Page](/llms-full.txt/1)