Freigeben über

Impower ERP (Vorschau)

Interaktion mit impower.de Buchhaltungssystem für Immobilienmanager zulassen

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name API-Unterstützung
URL https://impower.de
Email support+api@impower.de
Connectormetadaten
Herausgeber Impower GmbH
Webseite https://www.impower.de
Datenschutzrichtlinie https://www.impower.de/datenschutzerklaerung
Kategorien Unternehmensführung; Finanzieren

Mit dem Impower-Connector können Sie auf das Masterdataset zugreifen, z. B. Eigenschaften, Einheiten, Verträge und Kontakte. Darüber hinaus können Sie Dokumente und Rechnungen hochladen. Man kann die Daten auf geplanter Basis lesen oder Webhooks mithilfe des integrierten Triggers registrieren.

Voraussetzungen

Um Impower zu nutzen, benötigen Sie:

  1. Kostenpflichtiges Impower-Abonnement
  2. Powerautomate Premium-Abonnement

So erhalten Sie Anmeldeinformationen

Um den APIKey für Ihre Domäne zum Herstellen einer Verbindung mit Powerautomate zu erhalten, schreiben Sie bitte eine Anforderung unter support@impower.de.

Erste Schritte mit Ihrem Connector

Szenarien, die Sie möglicherweise erstellen sollten:

  1. Sehen Sie sich einen SharePoint/OneDrive-Ordner auf Änderungen an, und wenn neue PDF-Dateien angezeigt werden, werden sie in "Impower" hochgeladen.
  2. Synchronisieren der Kontaktliste mit Ihrem Teams-Adressbuch

Bekannte Probleme und Einschränkungen

Herunterladen/Hochladen von Dateien

Die Dateien werden als mehrteilige Formulardaten im Binärformat hochgeladen. Das gleiche gilt für den Download: Dateien werden wie bei einem vorgeschlagenen Dateinamen in der Kopfzeile bereitgestellt – genau wie in http-Standard

Ratelimiting

Bitte möchten Sie nicht mehr als 5000 Anfragen pro Minute ausführen. Wir legen eine Ratelimitierung für die API fest, um sicherzustellen, dass das System Benutzer schnell bedienen kann

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:
Vorgabe Parameter zum Erstellen einer Verbindung. Alle Regionen Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name Typ Description Erforderlich
API-Key securestring API-Key für diese API Richtig

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

(Legacy) Rechnung hochladen

Laden Sie eine PDF-Datei mithilfe der legacy-API auf Impower hoch. Verwenden Sie stattdessen den uploadInvoiceUsingPOST-Vorgang.
Abrufen aller Einheiten nach bestimmten Filterparametern

Gibt alle Einheiten zurück, die die angegebenen Filterkriterien berücksichtigen.
Abrufen aller vordefinierten Fehlercodewerte

Gibt eine Liste aller vordefinierten Fehlercodes zurück.
Abrufen einer Eigenschaft anhand der angegebenen ID

Ruft eine Eigenschaft anhand der angegebenen ID ab.
Abrufen einer Einheit durch die angegebene ID

Zurückgeben der Einheit mit der angegebenen ID
Abrufen einer Rechnung durch die angegebene ID

Ruft eine Rechnung anhand der angegebenen ID ab.
Abrufen eines Kontakts anhand der angegebenen ID

Ruft einen Kontakt anhand der angegebenen ID ab.
Abrufen eines Vertrags durch die angegebene ID

Ruft einen Vertrag anhand der angegebenen ID ab.
Abrufen von Details zu einem bestimmten Fehlercode

Ruft die Beschreibung eines bestimmten Fehlercodes ab.
Abrufen von Dokumenten durch die angegebenen Filterparameter

Abrufen von Dokumenten durch die angegebenen Filterparameter
Abrufen von Dokumenttags

Standard- und domänenspezifische Dokumenttags werden als Antwort zurückgegeben.
Abrufen von Eigenschaften durch die angegebenen Filterparameter

Abrufen von Eigenschaften durch die angegebenen Filterparameter
Abrufen von Kontakten anhand der angegebenen Filterparameter

Abrufen von Kontakten durch die angegebenen Filterparameter
Abrufen von Rechnungen durch die angegebenen Filterparameter

Ruft Rechnungen anhand der angegebenen Filterparameter ab.
Abrufen von Verträgen durch die angegebenen Filterparameter

Abrufen von Verträgen durch die angegebenen Filterparameter
Aktualisieren des Buchungstexts des angegebenen Rechnungsbuchungselements

Buchungstext aktualisieren
Aktualisieren einer Rechnung basierend auf bereitgestellten Feldern

Rechnung aktualisieren
Aktualisieren einer Verbindung

Aktualisieren einer Verbindung
Aktualisieren eines vorhandenen Dokuments basierend auf dem angegebenen Anforderungstext

Alle benötigten Informationen sind im Anforderungstext enthalten.
Aktualisieren eines vorhandenen Dokumenttags basierend auf der angegebenen ID

Das aktualisierte Dokumenttag wird als Antwort zurückgegeben.
Erstellen eines neuen Dokuments basierend auf der angegebenen Datei

Das neu erstellte Dokument wird als Antwort zurückgegeben.
Erstellen eines neuen Dokumenttags

Das neu erstellte Dokumenttag wird als Antwort zurückgegeben.
Herunterladen eines einzelnen Dokuments anhand der angegebenen ID

Das Format des Dokuments wird durch den Mimetyp definiert.
Herunterladen mehrerer Dokumente durch bestimmte Filterbedingungen

Dokumente werden im ZIP-Format angezeigt
Lesen einer Verbindung

Lesen einer Verbindung
Löschen einer Verbindung

Löschen einer Verbindung
Löschen eines vorhandenen Dokuments basierend auf der angegebenen ID

Vom System generierte Dokumente können nicht gelöscht werden.
Löschen eines vorhandenen Dokumenttags basierend auf der angegebenen ID

Vom System generierte Tags können nicht gelöscht werden.
PDF-Dokument für Rechnung hochladen

Standardmäßig wird das Dokument in eine OCR-Analyse verschoben.
Ältere Rechnungsdetails

Abrufen von Rechnungsdetails von Impower über legacy-API. Verwenden Sie stattdessen getInvoiceByIdUsingGET.

(Legacy) Rechnung hochladen

Vorgangs-ID:
UploadInvoice

Laden Sie eine PDF-Datei mithilfe der legacy-API auf Impower hoch. Verwenden Sie stattdessen den uploadInvoiceUsingPOST-Vorgang.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Angeben der pdf-Datei, die hochgeladen werden soll
 file True file

Angeben der pdf-Datei, die hochgeladen werden soll

Gibt zurück

LegacyInvoiceDto
LegacyInvoiceDto

Abrufen aller Einheiten nach bestimmten Filterparametern

Vorgangs-ID:
getUnitsByFilterUsingGET

Gibt alle Einheiten zurück, die die angegebenen Filterkriterien berücksichtigen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Sortierrichtung. Mögliche Werte: ASC, DESC
 order string

Sortierrichtung. Mögliche Werte: ASC, DESC
Zurückzugebende Seitenzahl
 page integer

Zurückzugebende Seitenzahl
Eindeutiger Bezeichner der Eigenschaft, zu der eine Einheit gehört
 propertyId integer

Eindeutiger Bezeichner der Eigenschaft, zu der eine Einheit gehört
Anzahl der Elemente, die auf einer einzelnen Seite zurückgegeben werden sollen
 size integer

Anzahl der Elemente, die auf einer einzelnen Seite zurückgegeben werden sollen
Sortierparameter
 sort string

Sortierparameter

Gibt zurück

PageOfUnitDto
PageOfUnitDto

Abrufen aller vordefinierten Fehlercodewerte

Vorgangs-ID:
errorCodesUsingGET

Gibt eine Liste aller vordefinierten Fehlercodes zurück.

Gibt zurück

Name Pfad Typ Beschreibung
array of string

Abrufen einer Eigenschaft anhand der angegebenen ID

Vorgangs-ID:
getPropertyByIdUsingGET

Ruft eine Eigenschaft anhand der angegebenen ID ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner einer Eigenschaft
 propertyId True integer

Eindeutiger Bezeichner einer Eigenschaft

Gibt zurück

Eigenschaftendatenstruktur.

PropertyDto
PropertyDto

Abrufen einer Einheit durch die angegebene ID

Vorgangs-ID:
getUnitByIdUsingGET

Zurückgeben der Einheit mit der angegebenen ID

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutige ID einer Einheit
 unitId True integer

Eindeutige ID einer Einheit

Gibt zurück

Einheitendatenstruktur.

UnitDto
UnitDto

Abrufen einer Rechnung durch die angegebene ID

Vorgangs-ID:
getInvoiceByIdUsingGET

Ruft eine Rechnung anhand der angegebenen ID ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner einer Rechnung
 invoiceId True integer

Eindeutiger Bezeichner einer Rechnung

Gibt zurück

Rechnungsdatenstruktur.

InvoiceDto
InvoiceDto

Abrufen eines Kontakts anhand der angegebenen ID

Vorgangs-ID:
getContactByIdUsingGET

Ruft einen Kontakt anhand der angegebenen ID ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner eines Kontakts
 contactId True integer

Eindeutiger Bezeichner eines Kontakts

Gibt zurück

Ein Kontakt steht für eine natürliche Person oder juristische Person und die Möglichkeit, sie zu kontaktieren. Hat eine Identität/firma mehrere Postanschrift, über die sie kontaktiert werden kann. Diese werden als 2 verschiedene Kontakte dargestellt.

ContactDto
ContactDto

Abrufen eines Vertrags durch die angegebene ID

Vorgangs-ID:
getContractByIdUsingGET

Ruft einen Vertrag anhand der angegebenen ID ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner eines Vertrags
 contractId True integer

Eindeutiger Bezeichner eines Vertrags

Gibt zurück

Vertragsdatenstruktur.

ContractDto
ContractDto

Abrufen von Details zu einem bestimmten Fehlercode

Vorgangs-ID:
errorCodeUsingGET

Ruft die Beschreibung eines bestimmten Fehlercodes ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
value
 value True string

value

Gibt zurück

ErrorCodeDetailsDto
ErrorCodeDetailsDto

Abrufen von Dokumenten durch die angegebenen Filterparameter

Vorgangs-ID:
getDocumentsByFilterUsingGET

Abrufen von Dokumenten durch die angegebenen Filterparameter

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Buchhaltername der Eigenschaft.
 accountant string

Buchhaltername der Eigenschaft.
Administratorname der Eigenschaft.
 administrator string

Administratorname der Eigenschaft.
ID der Kontaktentität, zu der das Dokument gehört.
 contactId integer

ID der Kontaktentität, zu der das Dokument gehört.
Dokumente, die mit Verträgen mit ähnlichem Namen verknüpft sind.
 contractName string

Dokumente, die mit Verträgen mit ähnlichem Namen verknüpft sind.
IDs der dokumente, die zurückgegeben werden sollen.
 documentIds array

IDs der dokumente, die zurückgegeben werden sollen.
Der Name der zurückzugebenden Dokumente.
 documentName string

Der Name der zurückzugebenden Dokumente.
Ausgestellt am Dokument.
 issuedDate string

Ausgestellt am Dokument.
Dokumente, die vor dem Ausstellungsdatum ausgestellt wurden.
 maxIssuedDate string

Dokumente, die vor dem Ausstellungsdatum ausgestellt wurden.
Dokumente, die nach dem Ausstellungsdatum ausgestellt wurden.
 minIssuedDate string

Dokumente, die nach dem Ausstellungsdatum ausgestellt wurden.
Sortierrichtung. Mögliche Werte: ASC, DESC
 order string

Sortierrichtung. Mögliche Werte: ASC, DESC
Zurückzugebende Seitenzahl
 page integer

Zurückzugebende Seitenzahl
Die lesbare ID der Eigenschaft, zu der das Dokument gehört.
 propertyHrId string

Die lesbare ID der Eigenschaft, zu der das Dokument gehört.
DIE ID der Eigenschaft, zu der das Dokument gehört.
 propertyId integer

DIE ID der Eigenschaft, zu der das Dokument gehört.
Der Name der Eigenschaft, zu der das Dokument gehört.
 propertyName string

Der Name der Eigenschaft, zu der das Dokument gehört.
Anzahl der Elemente, die auf einer einzelnen Seite zurückgegeben werden sollen
 size integer

Anzahl der Elemente, die auf einer einzelnen Seite zurückgegeben werden sollen
Sortierparameter
 sort string

Sortierparameter
ID der Quellentität, zu der das Dokument gehört.
 sourceId integer

ID der Quellentität, zu der das Dokument gehört.
Quelltypen des Dokuments.
 sourceType array

Quelltypen des Dokuments.
IDs von Tags, der das Dokument zugeordnet ist.
 tagIds array

IDs von Tags, der das Dokument zugeordnet ist.
Ein ähnlicher Name des Tags, dem das Dokument zugeordnet ist.
 tagName string

Ein ähnlicher Name des Tags, dem das Dokument zugeordnet ist.
ID der Einheitenentität, zu der das Dokument gehört.
 unitId integer

ID der Einheitenentität, zu der das Dokument gehört.

Gibt zurück

PageOfDocumentDto
PageOfDocumentDto

Abrufen von Dokumenttags

Vorgangs-ID:
getDocumentTagsUsingGET

Standard- und domänenspezifische Dokumenttags werden als Antwort zurückgegeben.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Suchzeichenfolge, die auf Name und Beschreibung angewendet wurde
 description string

Suchzeichenfolge, die auf Name und Beschreibung angewendet wurde

Gibt zurück

response
array of DocumentTagDto

Abrufen von Eigenschaften durch die angegebenen Filterparameter

Vorgangs-ID:
getPropertiesByFilterUsingGET

Abrufen von Eigenschaften durch die angegebenen Filterparameter

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Name der Eigenschaft.
 name string

Name der Eigenschaft.
Sortierrichtung. Mögliche Werte: ASC, DESC
 order string

Sortierrichtung. Mögliche Werte: ASC, DESC
Zurückzugebende Seitenzahl
 page integer

Zurückzugebende Seitenzahl
Lesbare ID der Eigenschaft.
 propertyHrId string

Lesbare ID der Eigenschaft.
Anzahl der Elemente, die auf einer einzelnen Seite zurückgegeben werden sollen
 size integer

Anzahl der Elemente, die auf einer einzelnen Seite zurückgegeben werden sollen
Sortierparameter
 sort string

Sortierparameter

Gibt zurück

PageOfPropertyDto
PageOfPropertyDto

Abrufen von Kontakten anhand der angegebenen Filterparameter

Vorgangs-ID:
getContactsByFilterUsingGET

Abrufen von Kontakten durch die angegebenen Filterparameter

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Liste der Kontakt-IDs zum Filtern von Kontakten nach.
 contactIds array

Liste der Kontakt-IDs zum Filtern von Kontakten nach.
E-Mail-Adresse des Kontakts.
 email string

E-Mail-Adresse des Kontakts.
Ein beliebiger Name des Kontakts. Kann Vorname, Nachname oder Firmenname sein.
 name string

Ein beliebiger Name des Kontakts. Kann Vorname, Nachname oder Firmenname sein.
Sortierrichtung. Mögliche Werte: ASC, DESC
 order string

Sortierrichtung. Mögliche Werte: ASC, DESC
Zurückzugebende Seitenzahl
 page integer

Zurückzugebende Seitenzahl
Anzahl der Elemente, die auf einer einzelnen Seite zurückgegeben werden sollen
 size integer

Anzahl der Elemente, die auf einer einzelnen Seite zurückgegeben werden sollen
Sortierparameter
 sort string

Sortierparameter

Gibt zurück

PageOfContactDto
PageOfContactDto

Abrufen von Rechnungen durch die angegebenen Filterparameter

Vorgangs-ID:
getInvoicesByFilterUsingGET

Ruft Rechnungen anhand der angegebenen Filterparameter ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner des Gegenstückkontakts
 counterpartContactId integer

Eindeutiger Bezeichner des Gegenstückkontakts
Datum der abzurufenden Rechnungen
 issuedDate string

Datum der abzurufenden Rechnungen
Sortierrichtung. Mögliche Werte: ASC, DESC
 order string

Sortierrichtung. Mögliche Werte: ASC, DESC
Zurückzugebende Seitenzahl
 page integer

Zurückzugebende Seitenzahl
Eindeutiger Bezeichner der Eigenschaft, zu der eine Rechnung gehört
 propertyId integer

Eindeutiger Bezeichner der Eigenschaft, zu der eine Rechnung gehört
Anzahl der Elemente, die auf einer einzelnen Seite zurückgegeben werden sollen
 size integer

Anzahl der Elemente, die auf einer einzelnen Seite zurückgegeben werden sollen
Sortierparameter
 sort string

Sortierparameter
Zustände der zu befragenden Rechnungen
 states array

Zustände der zu befragenden Rechnungen

Gibt zurück

PageOfInvoiceDto
PageOfInvoiceDto

Abrufen von Verträgen durch die angegebenen Filterparameter

Vorgangs-ID:
getContractsByFilterUsingGET

Abrufen von Verträgen durch die angegebenen Filterparameter

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID der Kontaktinstanz, der der Vertrag zugeordnet ist.
 contactId integer

Die ID der Kontaktinstanz, der der Vertrag zugeordnet ist.
Liste der Vertrags-IDs zum Filtern von Verträgen nach.
 contractIds array

Liste der Vertrags-IDs zum Filtern von Verträgen nach.
Sortierrichtung. Mögliche Werte: ASC, DESC
 order string

Sortierrichtung. Mögliche Werte: ASC, DESC
Zurückzugebende Seitenzahl
 page integer

Zurückzugebende Seitenzahl
DIE ID der Eigenschaftsinstanz, zu der der Vertrag gehört.
 propertyId integer

DIE ID der Eigenschaftsinstanz, zu der der Vertrag gehört.
Anzahl der Elemente, die auf einer einzelnen Seite zurückgegeben werden sollen
 size integer

Anzahl der Elemente, die auf einer einzelnen Seite zurückgegeben werden sollen
Sortierparameter
 sort string

Sortierparameter
Typ des Vertrags. Optionen: BESITZER | MANDANT | PROPERTY_OWNER
 type array

Typ des Vertrags. Optionen: BESITZER | MANDANT | PROPERTY_OWNER
Die ID der Einheitsinstanz, der der Vertrag zugeordnet ist.
 unitId integer

Die ID der Einheitsinstanz, der der Vertrag zugeordnet ist.
Geben Sie gültige Verträge zum Datum zurück. Null wird als Anfang/Ende der Zeit interpretiert.
 validAtDate string

Geben Sie gültige Verträge zum Datum zurück. Null wird als Anfang/Ende der Zeit interpretiert.

Gibt zurück

PageOfContractDto
PageOfContractDto

Aktualisieren des Buchungstexts des angegebenen Rechnungsbuchungselements

Vorgangs-ID:
updateInvoiceItemUsingPUT

Buchungstext aktualisieren

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutige ID des Rechnungsbuchungselements
 invoiceItemId True integer

Eindeutige ID des Rechnungsbuchungselements
Buchungstext des Rechnungsartikels.
 bookingText string

Buchungstext des Rechnungsartikels.

Gibt zurück

InvoiceItemDto
InvoiceItemDto

Aktualisieren einer Rechnung basierend auf bereitgestellten Feldern

Vorgangs-ID:
updateInvoiceUsingPUT

Rechnung aktualisieren

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutige ID einer Rechnung
 invoiceId True integer

Eindeutige ID einer Rechnung
Neues ausgestelltes Datum der Rechnung.
 issuedDate string

Neues ausgestelltes Datum der Rechnung.
Neuer Name der Rechnung.
 name string

Neuer Name der Rechnung.

Gibt zurück

Rechnungsdatenstruktur.

InvoiceDto
InvoiceDto

Aktualisieren einer Verbindung

Vorgangs-ID:
updateConnectionUsingPUT

Aktualisieren einer Verbindung

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID der Verbindung
 connectionIdX True integer

ID der Verbindung
Name der Verbindung, wie sie auf der Benutzeroberfläche dargestellt werden soll. Wenn nicht angegeben, wird standardmäßig der Name der Anwendung verwendet.
name string

Name der Verbindung, wie sie auf der Benutzeroberfläche dargestellt werden soll. Wenn nicht angegeben, wird standardmäßig der Name der Anwendung verwendet.
Die URL wird mit einem Autorisierungstoken aufgerufen, das Sie überprüfen können, und den folgenden Textkörper: {"connectionId":123,"entityType":"properties","entityId":123,"eventType": "UPDATE"}
 webhookUrl string

Die URL wird mit einem Autorisierungstoken aufgerufen, das Sie überprüfen können, und den folgenden Textkörper: {"connectionId":123,"entityType":"properties","entityId":123,"eventType": "UPDATE"}

Gibt zurück

Daten, die eine vorhandene Verbindung beschreiben

ConnectionDto
ConnectionDto

Aktualisieren eines vorhandenen Dokuments basierend auf dem angegebenen Anforderungstext

Vorgangs-ID:
updateDocumentsUsingPUT

Alle benötigten Informationen sind im Anforderungstext enthalten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Neuer Wert, auf den der Dokumentbetrag aktualisiert werden soll
 amount float

Neuer Wert, auf den der Dokumentbetrag aktualisiert werden soll
Neues Gebäude, dem das Dokument zugewiesen werden soll.
 buildingId integer

Neues Gebäude, dem das Dokument zugewiesen werden soll.
Neuer Kontakt mit dem Dokument, dem zugewiesen werden soll
 contactId integer

Neuer Kontakt mit dem Dokument, dem zugewiesen werden soll
Neuer Vertrag, dem das Dokument zugewiesen werden soll
 contractId integer

Neuer Vertrag, dem das Dokument zugewiesen werden soll
Der eindeutige Bezeichner des dokuments, das aktualisiert werden soll
 id True integer

Der eindeutige Bezeichner des dokuments, das aktualisiert werden soll
Neues Datum, an dem das ausgestellte Dokument aktualisiert werden soll
 issuedDate string

Neues Datum, an dem das ausgestellte Dokument aktualisiert werden soll
Neuer Wert, auf den der Dokumentname aktualisiert werden soll
 name string

Neuer Wert, auf den der Dokumentname aktualisiert werden soll
Neue Eigenschaft, der das Dokument zugewiesen werden soll
 propertyId integer

Neue Eigenschaft, der das Dokument zugewiesen werden soll
Neue Quellprozess-ID des Dokuments, dem zugewiesen werden soll
 sourceId integer

Neue Quellprozess-ID des Dokuments, dem zugewiesen werden soll
Bezeichner von Tags, die dem Dokument zugewiesen werden sollen
 tagIds array of integer

Bezeichner von Tags, die dem Dokument zugewiesen werden sollen
Neue Einheit, der das Dokument zugewiesen werden soll
 unitId integer

Neue Einheit, der das Dokument zugewiesen werden soll

Gibt zurück

response
array of DocumentDto

Aktualisieren eines vorhandenen Dokumenttags basierend auf der angegebenen ID

Vorgangs-ID:
updateDocumentTagUsingPUT

Das aktualisierte Dokumenttag wird als Antwort zurückgegeben.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner eines Dokumenttags
 tagId True integer

Eindeutiger Bezeichner eines Dokumenttags
Neue Beschreibung des Dokumenttags.
 description string

Neue Beschreibung des Dokumenttags.
Neuer Name des Dokumenttags.
 name string

Neuer Name des Dokumenttags.

Gibt zurück

Modellklasse eines Dokumenttags.

DocumentTagDto
DocumentTagDto

Erstellen eines neuen Dokuments basierend auf der angegebenen Datei

Vorgangs-ID:
createDocumentByUploadUsingPOST

Das neu erstellte Dokument wird als Antwort zurückgegeben.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
PDF-Datei zum Hochladen
 file True file

PDF-Datei zum Hochladen

Gibt zurück

Dokumentdatenstruktur.

DocumentDto
DocumentDto

Erstellen eines neuen Dokumenttags

Vorgangs-ID:
createDocumentTagUsingPOST

Das neu erstellte Dokumenttag wird als Antwort zurückgegeben.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Beschreibung des neu erstellten Dokumenttags.
 description string

Beschreibung des neu erstellten Dokumenttags.
Der Name des neu erstellten Dokumenttags.
 name string

Der Name des neu erstellten Dokumenttags.

Gibt zurück

Modellklasse eines Dokumenttags.

DocumentTagDto
DocumentTagDto

Herunterladen eines einzelnen Dokuments anhand der angegebenen ID

Vorgangs-ID:
downloadUsingGET

Das Format des Dokuments wird durch den Mimetyp definiert.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner eines Dokuments
 documentId True integer

Eindeutiger Bezeichner eines Dokuments

Gibt zurück

response
file

Herunterladen mehrerer Dokumente durch bestimmte Filterbedingungen

Vorgangs-ID:
downloadDocumentsByFilterUsingGET

Dokumente werden im ZIP-Format angezeigt

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Buchhaltername der Eigenschaft.
 accountant string

Buchhaltername der Eigenschaft.
Administratorname der Eigenschaft.
 administrator string

Administratorname der Eigenschaft.
ID der Kontaktentität, zu der das Dokument gehört.
 contactId integer

ID der Kontaktentität, zu der das Dokument gehört.
Dokumente, die mit Verträgen mit ähnlichem Namen verknüpft sind.
 contractName string

Dokumente, die mit Verträgen mit ähnlichem Namen verknüpft sind.
IDs der dokumente, die zurückgegeben werden sollen.
 documentIds array

IDs der dokumente, die zurückgegeben werden sollen.
Der Name der zurückzugebenden Dokumente.
 documentName string

Der Name der zurückzugebenden Dokumente.
Ausgestellt am Dokument.
 issuedDate string

Ausgestellt am Dokument.
Dokumente, die vor dem Ausstellungsdatum ausgestellt wurden.
 maxIssuedDate string

Dokumente, die vor dem Ausstellungsdatum ausgestellt wurden.
Dokumente, die nach dem Ausstellungsdatum ausgestellt wurden.
 minIssuedDate string

Dokumente, die nach dem Ausstellungsdatum ausgestellt wurden.
Die lesbare ID der Eigenschaft, zu der das Dokument gehört.
 propertyHrId string

Die lesbare ID der Eigenschaft, zu der das Dokument gehört.
DIE ID der Eigenschaft, zu der das Dokument gehört.
 propertyId integer

DIE ID der Eigenschaft, zu der das Dokument gehört.
Der Name der Eigenschaft, zu der das Dokument gehört.
 propertyName string

Der Name der Eigenschaft, zu der das Dokument gehört.
ID der Quellentität, zu der das Dokument gehört.
 sourceId integer

ID der Quellentität, zu der das Dokument gehört.
Quelltypen des Dokuments.
 sourceType array

Quelltypen des Dokuments.
IDs von Tags, der das Dokument zugeordnet ist.
 tagIds array

IDs von Tags, der das Dokument zugeordnet ist.
Ein ähnlicher Name des Tags, dem das Dokument zugeordnet ist.
 tagName string

Ein ähnlicher Name des Tags, dem das Dokument zugeordnet ist.
ID der Einheitenentität, zu der das Dokument gehört.
 unitId integer

ID der Einheitenentität, zu der das Dokument gehört.

Gibt zurück

response
file

Lesen einer Verbindung

Vorgangs-ID:
getConnectionUsingGET

Lesen einer Verbindung

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die ID der Verbindung
 connectionIdX True integer

Die ID der Verbindung

Gibt zurück

Daten, die eine vorhandene Verbindung beschreiben

ConnectionDto
ConnectionDto

Löschen einer Verbindung

Vorgangs-ID:
deleteConnectionUsingDELETE

Löschen einer Verbindung

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID der Verbindung
 connectionIdX True integer

ID der Verbindung

Löschen eines vorhandenen Dokuments basierend auf der angegebenen ID

Vorgangs-ID:
deleteDocumentUsingDELETE

Vom System generierte Dokumente können nicht gelöscht werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
documentId
 documentId True integer

documentId

Löschen eines vorhandenen Dokumenttags basierend auf der angegebenen ID

Vorgangs-ID:
deleteDocumentTagUsingDELETE

Vom System generierte Tags können nicht gelöscht werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner des zu löschenden Dokumenttags
 tagId True integer

Eindeutiger Bezeichner des zu löschenden Dokumenttags

PDF-Dokument für Rechnung hochladen

Vorgangs-ID:
uploadInvoiceUsingPOST

Standardmäßig wird das Dokument in eine OCR-Analyse verschoben.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
PDF-Datei einer Rechnung
 file True file

PDF-Datei einer Rechnung

Gibt zurück

Rechnungsdatenstruktur.

InvoiceDto
InvoiceDto

Ältere Rechnungsdetails

Vorgangs-ID:
GetInvoice

Abrufen von Rechnungsdetails von Impower über legacy-API. Verwenden Sie stattdessen getInvoiceByIdUsingGET.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Rechnungskennung
 invoiceId True integer

Angeben der Rechnungs-ID für Details

Gibt zurück

LegacyInvoiceDto
LegacyInvoiceDto

Trigger

Erstellen einer Anwendungsverbindung

Erstellen einer Anwendungsverbindung

Erstellen einer Anwendungsverbindung

Vorgangs-ID:
createConnectionUsingPOST

Erstellen einer Anwendungsverbindung

Gibt zurück

Body
ConnectionNotificationDto

Definitionen

ConnectionNotificationDto

Name Pfad Typ Beschreibung
Die ID der Verbindung, für die die Benachrichtigung gilt
 connectionId integer

connectionId
entityType
 entityType string

entityType
entityId
 entityId integer

entityId
eventType
 eventType string

eventType

ConnectionDto

Daten, die eine vorhandene Verbindung beschreiben

Name Pfad Typ Beschreibung
ID einer Anwendung
 appId integer

ID einer Anwendung
Name der Anwendung der Verbindung
 appName string

Name der Anwendung der Verbindung
Erstellungszeit der Entität.
 created string

Erstellungszeit der Entität.
ID der Entität.
 id integer

ID der Entität.
Name der Verbindung
 name string

Name der Verbindung
Zeitpunkt der letzten Aktualisierung der Entität.
 updated string

Zeitpunkt der letzten Aktualisierung der Entität.
Webhook der Verbindung, die wie ''' POST-Autorisierung https://your.webhook.url/path/somewhere aufgerufen wird: Bearer TOKEN { "connectionId": 0, "entityType": "properties|contacts|invoices|etc.", "entityId": 0, "eventType": "CREATE|UPDATE|DELETE" }'''
 webhookUrl string

Webhook der Verbindung, die wie folgt aufgerufen wird

POST https://your.webhook.url/path/somewhere
Authorization: Bearer TOKEN

{
  "connectionId": 0,
  "entityType": "properties|contacts|invoices|etc.",
  "entityId": 0,
  "eventType": "CREATE|UPDATE|DELETE"
}```

ContactDetailsDto

Kontaktdetails

Name Pfad Typ Beschreibung
Geschäftliche Telefonnummer des Kontakts
 businessPhoneNumber array of string

Geschäftliche Telefonnummer des Kontakts
Geburtsdatum des Kontakts.
 dateOfBirth string

Geburtsdatum des Kontakts.
E-Mail-Adresse des Kontakts
 email array of string

E-Mail-Adresse des Kontakts
Faxnummer des Kontakts
 fax array of string

Faxnummer des Kontakts
Mobiltelefonnummer des Kontakts
 mobilePhoneNumber array of string

Mobiltelefonnummer des Kontakts
Private Telefonnummer des Kontakts
 privatePhoneNumber array of string

Private Telefonnummer des Kontakts
Handelsregisternummer.
 tradeRegisterNumber string

Handelsregisternummer.
Umsatzsteuer-ID des Kontakts.
 vatId string

Umsatzsteuer-ID des Kontakts.
Webseite des Kontakts
 website array of string

Webseite des Kontakts

ContactDto

Ein Kontakt steht für eine natürliche Person oder juristische Person und die Möglichkeit, sie zu kontaktieren. Hat eine Identität/firma mehrere Postanschrift, über die sie kontaktiert werden kann. Diese werden als 2 verschiedene Kontakte dargestellt.

Name Pfad Typ Beschreibung
Name der Stadt.
 city string

Name der Stadt.
Name des Unternehmens, falls der Kontakt ein Unternehmen ist.
 companyName string

Name des Unternehmens, falls der Kontakt ein Unternehmen ist.
Ländercode gemäß ISO 3166-1 Alpha-2-Standard.
 country string

Ländercode gemäß ISO 3166-1 Alpha-2-Standard.
Erstellungszeit des Kontakts.
 created string

Erstellungszeit des Kontakts.
ContactDetailsDto
 details ContactDetailsDto

Kontaktdetails
Vorname des Kontakts, falls der Kontakt eine Person ist.
 firstName string

Vorname des Kontakts, falls der Kontakt eine Person ist.
ID der Kontaktinstanz.
 id integer

ID der Kontaktinstanz.
Nachname des Kontakts, falls der Kontakt eine Person ist.
 lastName string

Nachname des Kontakts, falls der Kontakt eine Person ist.
Straßennummer.
 number string

Straßennummer.
Postleitzahl oder Postleitzahl. Stellen Sie sicher, dass sie für jede Person angegeben ist, die einen physischen Briefkontakt per E-Post erfordert.
 postalCode string

Postleitzahl oder Postleitzahl. Stellen Sie sicher, dass sie für jede Person angegeben ist, die einen physischen Briefkontakt per E-Post erfordert.
Empfängername des Kontakts.
 recipientName string

Empfängername des Kontakts.
Eine Standardformel von Wörtern, die zum Adressieren des Kontakts verwendet werden.
 salutation string

Eine Standardformel von Wörtern, die zum Adressieren des Kontakts verwendet werden.
Name des Staates, auch Als Provinz, Unterteilung oder Region bezeichnet.
 state string

Name des Staates, auch Als Provinz, Unterteilung oder Region bezeichnet.
Name der Straße.
 street string

Name der Straße.
Position des Kontakts.
 title string

Position des Kontakts.
Zeitpunkt der letzten Aktualisierung des Kontakts.
 updated string

Zeitpunkt der letzten Aktualisierung des Kontakts.

ContactSimpleDto

Vereinfachte Datenstruktur des Kontakts.

Name Pfad Typ Beschreibung
ID der Kontaktinstanz.
 id integer

ID der Kontaktinstanz.
Der Name des Kontakts. Ausführlichere Informationen laden den Kontakt über die ID.
 name string

Der Name des Kontakts. Ausführlichere Informationen laden den Kontakt über die ID.

ContractDto

Vertragsdatenstruktur.

Name Pfad Typ Beschreibung
Liste der Kontakte, die dem Vertrag zugeordnet sind.
 contacts array of ContactSimpleDto

Liste der Kontakte, die dem Vertrag zugeordnet sind.
Die Nummer des Vertrags.
 contractNumber string

Die Nummer des Vertrags.
Erstellungszeit des Vertrags.
 created string

Erstellungszeit des Vertrags.
Datum der Gültigkeitsdauer des Vertrags endet. Null wird als Ende der Zeit interpretiert.
 endDate string

Datum der Gültigkeitsdauer des Vertrags endet. Null wird als Ende der Zeit interpretiert.
ID der Vertragsinstanz.
 id integer

ID der Vertragsinstanz.
Beschreibt, ob dieser Vertrag ein leerer Typvertrag ist. Ab sofort kann er nur wahr sein, wenn der Vertrag vom Typ MANDANT ist. Leerer Vertrag bedeutet, dass die Einheit nicht ausgeliehen wird.
isVacant boolean

Beschreibt, ob dieser Vertrag ein leerer Typvertrag ist. Ab sofort kann er nur wahr sein, wenn der Vertrag vom Typ MANDANT ist. Leerer Vertrag bedeutet, dass die Einheit nicht ausgeliehen wird.
Name des Vertrags, bestehend aus dem Einheitsschlüssel und dem Namen des Postansprechkontakts.
 name string

Name des Vertrags, bestehend aus dem Einheitsschlüssel und dem Namen des Postansprechkontakts.
DIE ID der Eigenschaftsinstanz, zu der der Vertrag gehört.
 propertyId integer

DIE ID der Eigenschaftsinstanz, zu der der Vertrag gehört.
Datum der Gültigkeitsdauer des Vertrages beginnt ab. Null wird als Anfang der Zeit interpretiert.
 startDate string

Datum der Gültigkeitsdauer des Vertrages beginnt ab. Null wird als Anfang der Zeit interpretiert.
Typ des Vertrags. 1. EIGENTÜMER - ein Vertrag dieser Art beweist den Besitz der Einheit. 2. MANDANT - ein Vertrag dieser Art mietet die Einheit. 3. PROPERTY_OWNER - ein Vertrag dieser Art beweist das Eigentum an dem Eigentum.
 type string

Typ des Vertrags.

  1. BESITZER - ein Vertrag dieser Art beweist den Besitz der Einheit.
  2. MANDANT - ein Vertrag dieser Art mietet die Einheit.
  3. PROPERTY_OWNER - ein Vertrag dieser Art beweist den Besitz der Immobilie.
DIE ID der Einheitsinstanz, zu der der Vertrag gehört.
 unitId integer

DIE ID der Einheitsinstanz, zu der der Vertrag gehört.
Zeitpunkt der letzten Aktualisierung des Vertrags.
 updated string

Zeitpunkt der letzten Aktualisierung des Vertrags.

DocumentDto

Dokumentdatenstruktur.

Name Pfad Typ Beschreibung
Gesamtbetrag, der im Dokument vorhanden ist.
 amount float

Gesamtbetrag, der im Dokument vorhanden ist.
DIE ID des Gebäudes, zu dem das Dokument gehört.
 buildingId integer

DIE ID des Gebäudes, zu dem das Dokument gehört.
DIE ID des Kontakts, zu dem das Dokument gehört.
 contactId integer

DIE ID des Kontakts, zu dem das Dokument gehört.
DIE ID des Vertrags, zu dem das Dokument gehört.
 contractId integer

DIE ID des Vertrags, zu dem das Dokument gehört.
Erstellungszeit des Dokuments.
 created string

Erstellungszeit des Dokuments.
ID der Dokumentinstanz.
 id integer

ID der Dokumentinstanz.
Ausgestellt am Dokument.
 issuedDate string

Ausgestellt am Dokument.
Name der Dokumentinstanz.
 name string

Name der Dokumentinstanz.
Die lesbare ID der Eigenschaft, der das Dokument zugewiesen ist.
 propertyHrId string

Die lesbare ID der Eigenschaft, der das Dokument zugewiesen ist.
DIE ID der Eigenschaft, zu der das Dokument gehört.
 propertyId integer

DIE ID der Eigenschaft, zu der das Dokument gehört.
Der Name der Eigenschaft, der das Dokument zugewiesen ist.
 propertyName string

Der Name der Eigenschaft, der das Dokument zugewiesen ist.
ID der Quellentität, zu der das Dokument gehört.
 sourceId integer

ID der Quellentität, zu der das Dokument gehört.
Quelltyp des Dokuments. Zusammen mit der ID wird der Geschäftsprozess desselben Namens identifiziert, an den das Dokument stammt/ist angefügt. Er kann null sein.
 sourceType string

Quelltyp des Dokuments. Zusammen mit der ID wird der Geschäftsprozess desselben Namens identifiziert, an den das Dokument stammt/ist angefügt. Er kann null sein.
Status des Dokuments.
 state string

Status des Dokuments.
tags
 tags array of DocumentTagSimpleDto
Die lesbare ID der Einheit, der das Dokument zugewiesen ist.
 unitHrId string

Die lesbare ID der Einheit, der das Dokument zugewiesen ist.
DIE ID der Einheit, zu der das Dokument gehört.
 unitId integer

DIE ID der Einheit, zu der das Dokument gehört.
Zeitpunkt der letzten Aktualisierung des Dokuments.
 updated string

Zeitpunkt der letzten Aktualisierung des Dokuments.

DocumentTagDto

Modellklasse eines Dokumenttags.

Name Pfad Typ Beschreibung
Beschreibung des Dokumenttags.
 description string

Beschreibung des Dokumenttags.
ID des Dokumenttags.
 id integer

ID des Dokumenttags.
Name des Dokumenttags.
 name string

Name des Dokumenttags.

DocumentTagSimpleDto

Modellklasse eines Dokumenttags.

Name Pfad Typ Beschreibung
Eindeutiger Bezeichner des Dokumenttags.
 id integer

Eindeutiger Bezeichner des Dokumenttags.
Name des Dokumenttags.
 name string

Name des Dokumenttags.

ErrorCodeDetailsDto

Name Pfad Typ Beschreibung
Code
 code string
Beschreibung
 description string

InvoiceDto

Rechnungsdatenstruktur.

Name Pfad Typ Beschreibung
Betrag, der gemäß der Rechnung bezahlt werden soll.
 amount float

Betrag, der gemäß der Rechnung bezahlt werden soll.
ID des Gegenstückkontakts der Rechnung.
 counterpartContactId integer

ID des Gegenstückkontakts der Rechnung.
Name des Gegenstückkontakts der Rechnung.
 counterpartContactName string

Name des Gegenstückkontakts der Rechnung.
Erstellungszeit der Entität.
 created string

Erstellungszeit der Entität.
ID der Entität.
 id integer

ID der Entität.
Ausgestellt am Rechnungsdatum.
 issuedDate string

Ausgestellt am Rechnungsdatum.
items
 items array of InvoiceItemDto
Name der Rechnung.
 name string

Name der Rechnung.
BIC-Nummer des Bankkontos des Gegenstücks.
 orderCounterpartBic string

BIC-Nummer des Bankkontos des Gegenstücks.
IBAN des Bankkontos des Gegenstücks.
 orderCounterpartIban string

IBAN des Bankkontos des Gegenstücks.
Die Anzahl der Tage vor oder nach dem Buchungsdatum, an dem der Bankauftrag zur Ausführung angezeigt werden soll.
 orderDayOffset integer

Die Anzahl der Tage vor oder nach dem Buchungsdatum, an dem der Bankauftrag zur Ausführung angezeigt werden soll.
Eindeutiger Bezeichner des Bankkontos der Immobilie.
 orderPropertyBankAccountId integer

Eindeutiger Bezeichner des Bankkontos der Immobilie.
BIC-Nummer des Immobilienbankkontos.
 orderPropertyBic string

BIC-Nummer des Immobilienbankkontos.
IBAN des Immobilienbankkontos.
 orderPropertyIban string

IBAN des Immobilienbankkontos.
True, falls eine entsprechende Bestellung der Rechnung vorhanden ist.
 orderRequired boolean

True, falls eine entsprechende Bestellung der Rechnung vorhanden ist.
Anweisung der generierten Reihenfolge.
 orderStatement string

Anweisung der generierten Reihenfolge.
Die lesbare ID der Eigenschaft, zu der die Rechnung gehört.
 propertyHrId string

Die lesbare ID der Eigenschaft, zu der die Rechnung gehört.
DIE ID der Eigenschaft, zu der die Rechnung gehört.
 propertyId integer

DIE ID der Eigenschaft, zu der die Rechnung gehört.
Der Name der Eigenschaft, zu der die Rechnung gehört.
 propertyName string

Der Name der Eigenschaft, zu der die Rechnung gehört.
Status der Rechnung. Mögliche Werte: 1. ENTWURF - Rechnung erstellt, aber unvollständig. 2. BEREIT - Rechnung für die Buchung bereit. 3. GEBUCHT - Rechnung gebucht. 4. GEPLANT - gilt nur für wiederkehrende Rechnungen. 5. REVERSED – alle von der Rechnung generierten Buchungen wurden rückgängig gemacht.
 state string

Status der Rechnung. Mögliche Werte:

  1. ENTWURF - Rechnung erstellt, aber unvollständig.
  2. READY - Rechnung bereit für die Buchung.
  3. GEBUCHT - Rechnung gebucht.
  4. GEPLANT – gilt nur für wiederkehrende Rechnungen.
  5. REVERSED – alle von der Rechnung generierten Buchungen wurden rückgängig gemacht.
Zeitpunkt der letzten Aktualisierung der Entität.
 updated string

Zeitpunkt der letzten Aktualisierung der Entität.

InvoiceItemDto

Name Pfad Typ Beschreibung
Kontocode des Buchungselements.
 accountCode string

Kontocode des Buchungselements.
Konto-ID des Buchungselements.
 accountId integer

Konto-ID des Buchungselements.
Kontoname des Buchungselements.
 accountName string

Kontoname des Buchungselements.
Betrag, der dem Buchungselement entspricht.
 amount float

Betrag, der dem Buchungselement entspricht.
Buchungstext des Buchungselements.
 bookingText string

Buchungstext des Buchungselements.
Erstellungszeit des Rechnungselements.
 created string

Erstellungszeit des Rechnungselements.
Eindeutiger Bezeichner des Buchungselements.
 id integer

Eindeutiger Bezeichner des Buchungselements.
Für die Einkommensteuererklärung relevanter Betrag gemäß dem Einkommensteuergesetz: [Einkommenstueregesetz EStG 35a](https://www.gesetze-im-internet.de/estg/__35a.html).
 laborCostAmount float

Für die Einkommensteuererklärung relevanter Betrag nach dem Einkommensteuergesetz: Einkommenstueregesetz EStG 35a.
Je nach ausgewähltem Typ: Prozentsätze der Beträge werden in den 35a Anhängen mehrerer Berichte nach dem Einkommensteuergesetz gemeldet: [Einkommenstueregesetz EStG 35a](https://www.gesetze-im-internet.de/estg/__35a.html). Ex: Housemoney Settlement (Hausgeldabrechnung) oder Opscost Report (Nebenkostenabrechnung). 1. HOUSEHOLD_RELATED_SERVICES - haushaltsnahe Dienstleistungen 2. TECHNICIAN_SERVICE - haushaltsnahe Handwerkerleistungen 3. MARGINAL_EMPLOYMENT - haushaltsnahe geringfügige Beschäftigungsverhältnisse 4. INSURABLE_EMPLOYMENT - sozialversicherungspflichtigen haushaltsnahen Beschäftigungsverhältnissen
 laborCostType string

Je nach ausgewähltem Typ: Prozentsätze der Beträge werden an den 35a Anhängen mehrerer Berichte gemäß dem Einkommensteuergesetz gemeldet: Einkommenstueregesetz EStG 35a.

Ex: Housemoney Settlement (Hausgeldabrechnung) oder Opscost Report (Nebenkostenabrechnung).

  1. HOUSEHOLD_RELATED_SERVICES - haushaltsnahe Dienstleistungen
  2. TECHNICIAN_SERVICE - haushaltsnahe Handwerkerleistungen
  3. MARGINAL_EMPLOYMENT - haushaltsnahe geringfügige Beschäftigungsverhältnisse
  4. INSURABLE_EMPLOYMENT - sozialversicherungspflichtigen haushaltsnahen Beschäftigungsverhältnissen
Zeitpunkt der letzten Aktualisierung des Rechnungselements.
 updated string

Zeitpunkt der letzten Aktualisierung des Rechnungselements.
Entsprechender MwSt-Betrag des Buchungsartikels.
 vatAmount float

Entsprechender MwSt-Betrag des Buchungsartikels.
Entsprechender MwSt-Prozentsatz des Mehrwertsteuerbetrags des Gesamtbetrags.
 vatPercentage float

Entsprechender MwSt-Prozentsatz des Mehrwertsteuerbetrags des Gesamtbetrags.

PageOfContactDto

Name Pfad Typ Beschreibung
Inhalt
 content array of ContactDto
empty
 empty boolean
erste
 first boolean
last
 last boolean
number
 number integer
numberOfElements
 numberOfElements integer
Seitenfähig
 pageable Pageable
size
 size integer
Sortieren
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

PageOfContractDto

Name Pfad Typ Beschreibung
Inhalt
 content array of ContractDto
empty
 empty boolean
erste
 first boolean
last
 last boolean
number
 number integer
numberOfElements
 numberOfElements integer
Seitenfähig
 pageable Pageable
size
 size integer
Sortieren
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

PageOfDocumentDto

Name Pfad Typ Beschreibung
Inhalt
 content array of DocumentDto
empty
 empty boolean
erste
 first boolean
last
 last boolean
number
 number integer
numberOfElements
 numberOfElements integer
Seitenfähig
 pageable Pageable
size
 size integer
Sortieren
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

PageOfInvoiceDto

Name Pfad Typ Beschreibung
Inhalt
 content array of InvoiceDto
empty
 empty boolean
erste
 first boolean
last
 last boolean
number
 number integer
numberOfElements
 numberOfElements integer
Seitenfähig
 pageable Pageable
size
 size integer
Sortieren
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

PageOfPropertyDto

Name Pfad Typ Beschreibung
Inhalt
 content array of PropertyDto
empty
 empty boolean
erste
 first boolean
last
 last boolean
number
 number integer
numberOfElements
 numberOfElements integer
Seitenfähig
 pageable Pageable
size
 size integer
Sortieren
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

PageOfUnitDto

Name Pfad Typ Beschreibung
Inhalt
 content array of UnitDto
empty
 empty boolean
erste
 first boolean
last
 last boolean
number
 number integer
numberOfElements
 numberOfElements integer
Seitenfähig
 pageable Pageable
size
 size integer
Sortieren
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

Seitenfähig

Name Pfad Typ Beschreibung
offset
 offset integer
pageNumber
 pageNumber integer
pageSize
 pageSize integer
seitennummeriert
 paged boolean
Sortieren
 sort Sort
nicht aufgerufen
 unpaged boolean

PropertyDto

Eigenschaftendatenstruktur.

Name Pfad Typ Beschreibung
Erstellungszeit der Eigenschaftsinstanz.
 created string

Erstellungszeit der Eigenschaftsinstanz.
ID der Eigenschaftsinstanz.
 id integer

ID der Eigenschaftsinstanz.
Name der Eigenschaftsinstanz.
 name string

Name der Eigenschaftsinstanz.
Die lesbare ID der Eigenschaftsinstanz.
 propertyHrId string

Die lesbare ID der Eigenschaftsinstanz.
Aktueller Status der Eigenschaft. 1. ENTWURF - Eigenschaft noch nicht aktiviert, daher können keine Buchungen/Bankaufträge/Berichte generiert werden. 2. READY - Eigenschaft wurde aktiviert und kann für bookings/bank orders/reports generation verwendet werden. 3. DEAKTIVIERT - Eigenschaft wurde deaktiviert und kann nicht mehr Buchungen/Bankaufträge/Berichte generieren.
state string

Aktueller Status der Eigenschaft.

  1. DRAFT - Eigenschaft noch nicht aktiviert, daher können keine Buchungen/Bankaufträge/Berichte generiert werden.
  2. READY - Eigenschaft wurde aktiviert und kann für die Generierung von Buchungen/Bankaufträgen/Berichten verwendet werden.
  3. DISABLED - Eigenschaft wurde deaktiviert und kann keine Buchungen/Bankaufträge/Berichte mehr generieren.
Verwaltungstyp der Eigenschaft. OWNER - Home Owner Association. RENTAL - Mandantenverwaltung.
 type string

Verwaltungstyp der Eigenschaft. OWNER - Home Owner Association. RENTAL - Mandantenverwaltung.
Aktualisierungszeit der Eigenschaftsinstanz.
 updated string

Aktualisierungszeit der Eigenschaftsinstanz.

Sortieren

Name Pfad Typ Beschreibung
empty
 empty boolean
sortiert
 sorted boolean
unsortiert
 unsorted boolean

UnitDto

Einheitendatenstruktur.

Name Pfad Typ Beschreibung
Erstellungszeit der Einheiteninstanz.
 created string

Erstellungszeit der Einheiteninstanz.
Boden, auf dem sich die Einheit befindet.
 floor string

Boden, auf dem sich die Einheit befindet.
ID der Einheiteninstanz.
 id integer

ID der Einheiteninstanz.
Position der Einheit innerhalb des Bodens.
 position string

Position der Einheit innerhalb des Bodens.
DIE ID der Eigenschaftsinstanz, zu der die Einheit gehört.
 propertyId integer

DIE ID der Eigenschaftsinstanz, zu der die Einheit gehört.
Zweck, für den die Einheit verwendet wird. APARTMENT - Einheit, die für Wohnzwecke verwendet wird. PARKPLATZ - Einheit, die für Parkzwecke verwendet wird. COMMERCIAL - Einheit, die für geschäfts-/kommerzielle Zwecke verwendet wird. OTHER - Einheit, die für andere Zwecke verwendet wird.
 type string

Zweck, für den die Einheit verwendet wird. APARTMENT - Einheit, die für Wohnzwecke verwendet wird. PARKPLATZ - Einheit, die für Parkzwecke verwendet wird. COMMERCIAL - Einheit, die für geschäfts-/kommerzielle Zwecke verwendet wird. OTHER - Einheit, die für andere Zwecke verwendet wird.
Lesbare ID der Einheitsinstanz.
 unitHrId string

Lesbare ID der Einheitsinstanz.
Der Rang definiert die Reihenfolge, in der Einheiten auf der Benutzeroberfläche /Berichte angezeigt werden. Der Benutzer kann ihn auf der Benutzeroberfläche aktualisieren.
 unitRank integer

Der Rang definiert die Reihenfolge, in der Einheiten auf der Benutzeroberfläche /Berichte angezeigt werden. Der Benutzer kann ihn auf der Benutzeroberfläche aktualisieren.
Aktualisierungszeit der Einheiteninstanz.
 updated string

Aktualisierungszeit der Einheiteninstanz.

LegacyInvoiceDto

Name Pfad Typ Beschreibung
BIC-Gegenstück
 counterpartBic string

BIC-Gegenstück
ContactID-Gegenstück
 counterpartContactId integer

ContactID-Gegenstück
IBAN-Gegenstück
 counterpartIban string

IBAN-Gegenstück
Gegenstück
 counterpartName string

Gegenstück
Datum
 created string

Datum
Rechnungs-URL
 documentUrl string

Rechnungs-URL
ID
 id integer

ID
Rechnungsdatum
 invoiceDate string

Rechnungsdatum
Rechnungskennung
 invoiceHrId string

Rechnungskennung
Rechnungsnummer
 invoiceNumber string

Rechnungsnummer
Zieldatum der Zahlung
 paymentTargetDate string

Zieldatum der Zahlung
Zahlungsmethode
 paymentType string

Zahlungsmethode
Eigenschaft NR
 propertyHrId string

Eigenschaft NR
Eigenschaften-ID
 propertyId integer

Eigenschaften-ID
Interne Eigenschafts-ID
 propertyIdInternal string

Interne Eigenschafts-ID
Objektname
 propertyName string

Objektname
Referenz nr
 refNr string

Referenz nr
Status der Rechnung
 state string

Status der Rechnung
Bruttosumme
 totalGross float

Bruttosumme
Gesamtergebnis
 totalNet float

Gesamtergebnis
MwSt. inkl. MwSt.
 vatIncluded boolean

MwSt. inkl. MwSt.
MwSt.-Prozentsatz
 vatPercentage float

MwSt.-Prozentsatz

file

Dies ist der grundlegende Datentyp "Datei".