Sdílet prostřednictvím


Impower ERP (Preview)

Povolit interakci s účetním systémem impower.de pro správce vlastností

Tento konektor je dostupný v následujících produktech a oblastech:

Service Class Regions
Copilot Studio Premium Všechny oblasti Power Automate s výjimkou následujících:
     – státní správa USA (GCC)
     – státní správa USA (GCC High)
     - China Cloud provozovaný společností 21Vianet
     - Ministerstvo obrany USA (DoD)
Logic Apps Standard Všechny oblasti Logic Apps s výjimkou následujících:
     – Oblasti Azure Government
     – Oblasti Azure China
     - Ministerstvo obrany USA (DoD)
Power Apps Premium Všechny oblasti Power Apps s výjimkou následujících:
     – státní správa USA (GCC)
     – státní správa USA (GCC High)
     - China Cloud provozovaný společností 21Vianet
     - Ministerstvo obrany USA (DoD)
Power Automate Premium Všechny oblasti Power Automate s výjimkou následujících:
     – státní správa USA (GCC)
     – státní správa USA (GCC High)
     - China Cloud provozovaný společností 21Vianet
     - Ministerstvo obrany USA (DoD)
Kontakt
Název Podpora rozhraní API
URL https://impower.de
Email support+api@impower.de
Metadata konektoru
Vydavatel Impower GmbH
Internetová stránka https://www.impower.de
Zásady ochrany osobních údajů https://www.impower.de/datenschutzerklaerung
Kategorie Řízení podniku; Finance

Konektor Impower umožňuje přístup k hlavní datové sadě, jako jsou vlastnosti, jednotky, kontrakty a kontakty. Kromě toho můžete nahrávat dokumenty a faktury. Data můžete číst podle plánu nebo registrací webhooků pomocí integrovaného triggeru.

Požadavky

K použití Impower budete potřebovat:

  1. Placené předplatné Impower
  2. Předplatné Powerautomate Premium

Jak získat přihlašovací údaje

Pokud chcete získat klíč ROZHRANÍ API pro vaši doménu pro připojení powerautomatu, napište prosím žádost na adrese support@impower.de.

Začínáme s konektorem

Scénáře, které byste mohli zvážit při vytváření:

  1. Sledujte změny ve složce SharePointu nebo OneDrivu a pokud se nové soubory PDF objeví, nahrajte je tak, aby byly vymožené.
  2. Synchronizace seznamu kontaktů s adresářem týmů

Známé problémy a omezení

Stahování a nahrávání souborů

Soubory se nahrají jako data formuláře s více částmi v binárním formátu. Totéž platí pro stahování: soubory jsou k dispozici stejně jako navrhované názvy souborů v hlavičce – stejně jako ve standardu HTTP.

Ratelimiting

Snažte se maximálně 5 000 žádostí za minutu. Pro rozhraní API ukládáme míru, abychom zajistili, že systém může rychle obsluhovat uživatele.

Vytvoření připojení

Konektor podporuje následující typy ověřování:

výchozí Parametry pro vytvoření připojení Všechny oblasti Nesdílitelné

Výchozí

Použitelné: Všechny oblasti

Parametry pro vytvoření připojení

Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.

Název Typ Description Povinné
API-Key securestring API-Key pro toto rozhraní API Pravdivé

Limity omezování

Name Volání Období obnovení
Volání rozhraní API na připojení 100 60 sekund

Akce

(Starší verze) Nahrání faktury

Nahrajte soubor PDF do Impower pomocí starší verze rozhraní API. Místo toho použijte operaci uploadInvoiceUsingPOST.

Aktualizace existující značky dokumentu na základě daného ID

Aktualizovaná značka dokumentu se vrátí jako odpověď.

Aktualizace existujícího dokumentu na základě daného textu požadavku

Všechny informace o potřebě jsou v textu požadavku.

Aktualizace faktury na základě zadaných polí

Aktualizace faktury

Aktualizace připojení

Aktualizace připojení

Aktualizace textu rezervace dané položky rezervace faktury

Aktualizace textu rezervace

Nahrání dokumentu PDF faktury

Ve výchozím nastavení dokument přejde přes analýzu OCR.

Odstranění existující značky dokumentu na základě daného ID

Systémem generované značky nelze odstranit.

Odstranění existujícího dokumentu na základě daného ID

Systémové vygenerované dokumenty nelze odstranit.

Odstranění připojení

Odstranění připojení

Starší podrobnosti o faktuře

Získejte podrobnosti o faktuře z Impower prostřednictvím zastaralého rozhraní API. Místo toho použijte getInvoiceByIdUsingGET.

Stažení jednoho dokumentu podle daného ID

Formát dokumentu je definován typem mimetype.

Stažení více dokumentů podle zadaných podmínek filtru

Dokumenty jsou ve formátu ZIP.

Vytvoření nové značky dokumentu

Nově vytvořená značka dokumentu se vrátí jako odpověď.

Vytvoření nového dokumentu na základě daného souboru

Nově vytvořený dokument se vrátí jako odpověď.

Získání dokumentů podle zadaných parametrů filtru

Načtení dokumentů podle zadaných parametrů filtru

Získání faktur podle zadaných parametrů filtru

Načte faktury podle zadaných parametrů filtru.

Získání faktury podle daného ID

Načte fakturu podle daného ID.

Získání jednotky podle daného ID

Vrácení jednotky s daným ID

Získání kontaktu podle daného ID

Načte kontakt podle daného ID.

Získání kontaktů podle zadaných parametrů filtru

Načtení kontaktů podle zadaných parametrů filtru

Získání kontraktu podle daného ID

Načte kontrakt podle daného ID.

Získání kontraktů podle zadaných parametrů filtru

Načtení kontraktů podle zadaných parametrů filtru

Získání podrobností o konkrétním kódu chyby

Načte popis konkrétního kódu chyby.

Získání vlastnosti podle daného ID

Načte vlastnost podle daného ID.

Získání vlastností podle zadaných parametrů filtru

Načtení vlastností podle zadaných parametrů filtru

Získání všech jednotek podle zadaných parametrů filtru

Vrátí všechny jednotky respektující daná kritéria filtru.

Získání všech předdefinovaných hodnot kódu chyby

Vrátí seznam všech předdefinovaných kódů chyb.

Získání značek dokumentu

Standardní a doménové značky dokumentů se vrátí jako odpověď.

Čtení připojení

Čtení připojení

(Starší verze) Nahrání faktury

Nahrajte soubor PDF do Impower pomocí starší verze rozhraní API. Místo toho použijte operaci uploadInvoiceUsingPOST.

Parametry

Name Klíč Vyžadováno Typ Description
Zadejte soubor PDF, který se má nahrát.
file True file

Zadejte soubor PDF, který se má nahrát.

Návraty

LegacyInvoiceDto
LegacyInvoiceDto

Aktualizace existující značky dokumentu na základě daného ID

Aktualizovaná značka dokumentu se vrátí jako odpověď.

Parametry

Name Klíč Vyžadováno Typ Description
Jedinečný identifikátor značky dokumentu
tagId True integer

Jedinečný identifikátor značky dokumentu

Nový popis značky dokumentu
description string

Nový popis značky dokumentu

Nový název značky dokumentu
name string

Nový název značky dokumentu

Návraty

Třída modelu značky dokumentu

DocumentTagDto
DocumentTagDto

Aktualizace existujícího dokumentu na základě daného textu požadavku

Všechny informace o potřebě jsou v textu požadavku.

Parametry

Name Klíč Vyžadováno Typ Description
Nová hodnota množství dokumentu, na kterou se má aktualizovat
amount float

Nová hodnota množství dokumentu, na kterou se má aktualizovat

Nová budova, ke které má být dokument přiřazen.
buildingId integer

Nová budova, ke které má být dokument přiřazen.

Nový kontakt na dokument, ke kterému má být přiřazen
contactId integer

Nový kontakt na dokument, ke kterému má být přiřazen

Nová smlouva, ke které má být dokument přiřazen
contractId integer

Nová smlouva, ke které má být dokument přiřazen

Jedinečný identifikátor dokumentu, který se má aktualizovat
id True integer

Jedinečný identifikátor dokumentu, který se má aktualizovat

Nové datum vydání dokumentu, na které se má aktualizovat
issuedDate string

Nové datum vydání dokumentu, na které se má aktualizovat

Nová hodnota názvu dokumentu, na který se má aktualizovat
name string

Nová hodnota názvu dokumentu, na který se má aktualizovat

Nová vlastnost, ke které má být dokument přiřazen
propertyId integer

Nová vlastnost, ke které má být dokument přiřazen

Nové ID zdrojového procesu, ke kterému má být dokument přiřazen
sourceId integer

Nové ID zdrojového procesu, ke kterému má být dokument přiřazen

Identifikátory značek, které se mají přiřadit k dokumentu
tagIds array of integer

Identifikátory značek, které se mají přiřadit k dokumentu

Nová jednotka, ke které má být dokument přiřazen
unitId integer

Nová jednotka, ke které má být dokument přiřazen

Návraty

Aktualizace faktury na základě zadaných polí

Aktualizace faktury

Parametry

Name Klíč Vyžadováno Typ Description
Jedinečné ID faktury
invoiceId True integer

Jedinečné ID faktury

Nové datum vystavení faktury.
issuedDate string

Nové datum vystavení faktury.

Nový název faktury
name string

Nový název faktury

Návraty

Struktura dat faktury

InvoiceDto
InvoiceDto

Aktualizace připojení

Aktualizace připojení

Parametry

Name Klíč Vyžadováno Typ Description
ID připojení
connectionIdX True integer

ID připojení

Název připojení, který se zobrazí v uživatelském rozhraní. Pokud není zadáno, použije se výchozí název aplikace.
name string

Název připojení, který se zobrazí v uživatelském rozhraní. Pokud není zadáno, použije se výchozí název aplikace.

Adresa URL bude volána pomocí autorizačního tokenu, který můžete ověřit, a následující text: {"connectionId":123,"entityType":"properties","entityId":123,"eventType": "UPDATE"}
webhookUrl string

Adresa URL bude volána pomocí autorizačního tokenu, který můžete ověřit, a následující text: {"connectionId":123,"entityType":"properties","entityId":123,"eventType": "UPDATE"}

Návraty

Data popisující existující připojení

ConnectionDto
ConnectionDto

Aktualizace textu rezervace dané položky rezervace faktury

Aktualizace textu rezervace

Parametry

Name Klíč Vyžadováno Typ Description
Jedinečné ID položky rezervace faktury
invoiceItemId True integer

Jedinečné ID položky rezervace faktury

Booking text of the invoice item.
bookingText string

Booking text of the invoice item.

Návraty

InvoiceItemDto
InvoiceItemDto

Nahrání dokumentu PDF faktury

Ve výchozím nastavení dokument přejde přes analýzu OCR.

Parametry

Name Klíč Vyžadováno Typ Description
Pdf soubor faktury
file True file

Pdf soubor faktury

Návraty

Struktura dat faktury

InvoiceDto
InvoiceDto

Odstranění existující značky dokumentu na základě daného ID

Systémem generované značky nelze odstranit.

Parametry

Name Klíč Vyžadováno Typ Description
Jedinečný identifikátor značky dokumentu, která se má odstranit
tagId True integer

Jedinečný identifikátor značky dokumentu, která se má odstranit

Odstranění existujícího dokumentu na základě daného ID

Systémové vygenerované dokumenty nelze odstranit.

Parametry

Name Klíč Vyžadováno Typ Description
documentId
documentId True integer

documentId

Odstranění připojení

Odstranění připojení

Parametry

Name Klíč Vyžadováno Typ Description
ID připojení
connectionIdX True integer

ID připojení

Starší podrobnosti o faktuře

Získejte podrobnosti o faktuře z Impower prostřednictvím zastaralého rozhraní API. Místo toho použijte getInvoiceByIdUsingGET.

Parametry

Name Klíč Vyžadováno Typ Description
ID faktury
invoiceId True integer

Zadání ID faktury pro podrobnosti

Návraty

LegacyInvoiceDto
LegacyInvoiceDto

Stažení jednoho dokumentu podle daného ID

Formát dokumentu je definován typem mimetype.

Parametry

Name Klíč Vyžadováno Typ Description
Jedinečný identifikátor dokumentu
documentId True integer

Jedinečný identifikátor dokumentu

Návraty

response
file

Stažení více dokumentů podle zadaných podmínek filtru

Dokumenty jsou ve formátu ZIP.

Parametry

Name Klíč Vyžadováno Typ Description
Název účetní vlastnosti.
accountant string

Název účetní vlastnosti.

Jméno správce vlastnosti.
administrator string

Jméno správce vlastnosti.

ID entity kontaktu, do které dokument patří.
contactId integer

ID entity kontaktu, do které dokument patří.

Dokumenty propojené se smlouvami s podobným názvem
contractName string

Dokumenty propojené se smlouvami s podobným názvem

ID dokumentů, které se mají vrátit.
documentIds array

ID dokumentů, které se mají vrátit.

Název dokumentů, které se mají vrátit.
documentName string

Název dokumentů, které se mají vrátit.

Datum vydání dokumentu.
issuedDate string

Datum vydání dokumentu.

Dokumenty, které byly vydány před datem vydání.
maxIssuedDate string

Dokumenty, které byly vydány před datem vydání.

Dokumenty, které byly vydány po datu vydání.
minIssuedDate string

Dokumenty, které byly vydány po datu vydání.

Id vlastnosti, do které dokument patří, je čitelné.
propertyHrId string

Id vlastnosti, do které dokument patří, je čitelné.

ID vlastnosti, do které dokument patří.
propertyId integer

ID vlastnosti, do které dokument patří.

Název vlastnosti, do které dokument patří.
propertyName string

Název vlastnosti, do které dokument patří.

ID zdrojové entity, do které dokument patří.
sourceId integer

ID zdrojové entity, do které dokument patří.

Zdrojové typy dokumentu.
sourceType array

Zdrojové typy dokumentu.

ID značek, ke které je dokument přidružený.
tagIds array

ID značek, ke které je dokument přidružený.

Podobný název značky, ke které je dokument přidružený.
tagName string

Podobný název značky, ke které je dokument přidružený.

ID entity jednotky, do které dokument patří.
unitId integer

ID entity jednotky, do které dokument patří.

Návraty

response
file

Vytvoření nové značky dokumentu

Nově vytvořená značka dokumentu se vrátí jako odpověď.

Parametry

Name Klíč Vyžadováno Typ Description
Popis nově vytvořené značky dokumentu
description string

Popis nově vytvořené značky dokumentu

Název nově vytvořené značky dokumentu
name string

Název nově vytvořené značky dokumentu

Návraty

Třída modelu značky dokumentu

DocumentTagDto
DocumentTagDto

Vytvoření nového dokumentu na základě daného souboru

Nově vytvořený dokument se vrátí jako odpověď.

Parametry

Name Klíč Vyžadováno Typ Description
Soubor PDF k nahrání
file True file

Soubor PDF k nahrání

Návraty

Struktura dat dokumentu

DocumentDto
DocumentDto

Získání dokumentů podle zadaných parametrů filtru

Načtení dokumentů podle zadaných parametrů filtru

Parametry

Name Klíč Vyžadováno Typ Description
Název účetní vlastnosti.
accountant string

Název účetní vlastnosti.

Jméno správce vlastnosti.
administrator string

Jméno správce vlastnosti.

ID entity kontaktu, do které dokument patří.
contactId integer

ID entity kontaktu, do které dokument patří.

Dokumenty propojené se smlouvami s podobným názvem
contractName string

Dokumenty propojené se smlouvami s podobným názvem

ID dokumentů, které se mají vrátit.
documentIds array

ID dokumentů, které se mají vrátit.

Název dokumentů, které se mají vrátit.
documentName string

Název dokumentů, které se mají vrátit.

Datum vydání dokumentu.
issuedDate string

Datum vydání dokumentu.

Dokumenty, které byly vydány před datem vydání.
maxIssuedDate string

Dokumenty, které byly vydány před datem vydání.

Dokumenty, které byly vydány po datu vydání.
minIssuedDate string

Dokumenty, které byly vydány po datu vydání.

Směr řazení Možné hodnoty: ASC, DESC
order string

Směr řazení Možné hodnoty: ASC, DESC

Číslo stránky, které se má vrátit
page integer

Číslo stránky, které se má vrátit

Id vlastnosti, do které dokument patří, je čitelné.
propertyHrId string

Id vlastnosti, do které dokument patří, je čitelné.

ID vlastnosti, do které dokument patří.
propertyId integer

ID vlastnosti, do které dokument patří.

Název vlastnosti, do které dokument patří.
propertyName string

Název vlastnosti, do které dokument patří.

Počet položek, které se mají vrátit na jedné stránce
size integer

Počet položek, které se mají vrátit na jedné stránce

Parametr řazení
sort string

Parametr řazení

ID zdrojové entity, do které dokument patří.
sourceId integer

ID zdrojové entity, do které dokument patří.

Zdrojové typy dokumentu.
sourceType array

Zdrojové typy dokumentu.

ID značek, ke které je dokument přidružený.
tagIds array

ID značek, ke které je dokument přidružený.

Podobný název značky, ke které je dokument přidružený.
tagName string

Podobný název značky, ke které je dokument přidružený.

ID entity jednotky, do které dokument patří.
unitId integer

ID entity jednotky, do které dokument patří.

Návraty

PageOfDocumentDto
PageOfDocumentDto

Získání faktur podle zadaných parametrů filtru

Načte faktury podle zadaných parametrů filtru.

Parametry

Name Klíč Vyžadováno Typ Description
Jedinečný identifikátor kontaktu protějšek
counterpartContactId integer

Jedinečný identifikátor kontaktu protějšek

Datum načtení faktur
issuedDate string

Datum načtení faktur

Směr řazení Možné hodnoty: ASC, DESC
order string

Směr řazení Možné hodnoty: ASC, DESC

Číslo stránky, které se má vrátit
page integer

Číslo stránky, které se má vrátit

Jedinečný identifikátor vlastnosti, do které faktura patří
propertyId integer

Jedinečný identifikátor vlastnosti, do které faktura patří

Počet položek, které se mají vrátit na jedné stránce
size integer

Počet položek, které se mají vrátit na jedné stránce

Parametr řazení
sort string

Parametr řazení

Stavy faktur, které se mají načíst
states array

Stavy faktur, které se mají načíst

Návraty

StránkaOfInvoiceDto
PageOfInvoiceDto

Získání faktury podle daného ID

Načte fakturu podle daného ID.

Parametry

Name Klíč Vyžadováno Typ Description
Jedinečný identifikátor faktury
invoiceId True integer

Jedinečný identifikátor faktury

Návraty

Struktura dat faktury

InvoiceDto
InvoiceDto

Získání jednotky podle daného ID

Vrácení jednotky s daným ID

Parametry

Name Klíč Vyžadováno Typ Description
Jedinečné ID jednotky
unitId True integer

Jedinečné ID jednotky

Návraty

Datová struktura jednotek.

UnitDto
UnitDto

Získání kontaktu podle daného ID

Načte kontakt podle daného ID.

Parametry

Name Klíč Vyžadováno Typ Description
Jedinečný identifikátor kontaktu
contactId True integer

Jedinečný identifikátor kontaktu

Návraty

Kontakt představuje fyzickou nebo právnickou osobu a způsob, jak je kontaktovat. Identita nebo společnost má více poštovních adres, prostřednictvím kterých může být kontaktována. Jsou reprezentované jako 2 různé kontakty.

ContactDto
ContactDto

Získání kontaktů podle zadaných parametrů filtru

Načtení kontaktů podle zadaných parametrů filtru

Parametry

Name Klíč Vyžadováno Typ Description
Seznam ID kontaktů pro filtrování kontaktů podle.
contactIds array

Seznam ID kontaktů pro filtrování kontaktů podle.

E-mailová adresa kontaktu.
email string

E-mailová adresa kontaktu.

Jakékoli jméno kontaktu. Může to být křestní jméno, příjmení nebo název společnosti.
name string

Jakékoli jméno kontaktu. Může to být křestní jméno, příjmení nebo název společnosti.

Směr řazení Možné hodnoty: ASC, DESC
order string

Směr řazení Možné hodnoty: ASC, DESC

Číslo stránky, které se má vrátit
page integer

Číslo stránky, které se má vrátit

Počet položek, které se mají vrátit na jedné stránce
size integer

Počet položek, které se mají vrátit na jedné stránce

Parametr řazení
sort string

Parametr řazení

Návraty

PageOfContactDto
PageOfContactDto

Získání kontraktu podle daného ID

Načte kontrakt podle daného ID.

Parametry

Name Klíč Vyžadováno Typ Description
Jedinečný identifikátor kontraktu
contractId True integer

Jedinečný identifikátor kontraktu

Návraty

Struktura dat kontraktu

ContractDto
ContractDto

Získání kontraktů podle zadaných parametrů filtru

Načtení kontraktů podle zadaných parametrů filtru

Parametry

Name Klíč Vyžadováno Typ Description
ID kontaktní instance, ke které je kontrakt přidružen.
contactId integer

ID kontaktní instance, ke které je kontrakt přidružen.

Seznam ID kontraktů pro filtrování kontraktů podle.
contractIds array

Seznam ID kontraktů pro filtrování kontraktů podle.

Směr řazení Možné hodnoty: ASC, DESC
order string

Směr řazení Možné hodnoty: ASC, DESC

Číslo stránky, které se má vrátit
page integer

Číslo stránky, které se má vrátit

ID instance vlastnosti, do které kontrakt patří.
propertyId integer

ID instance vlastnosti, do které kontrakt patří.

Počet položek, které se mají vrátit na jedné stránce
size integer

Počet položek, které se mají vrátit na jedné stránce

Parametr řazení
sort string

Parametr řazení

Typ smlouvy. Možnosti: VLASTNÍK | TENANT | PROPERTY_OWNER
type array

Typ smlouvy. Možnosti: VLASTNÍK | TENANT | PROPERTY_OWNER

ID instance jednotky, ke které je kontrakt přidružen.
unitId integer

ID instance jednotky, ke které je kontrakt přidružen.

Vrátí platné kontrakty k datu. Hodnota Null se interpretuje jako začátek a konec času.
validAtDate string

Vrátí platné kontrakty k datu. Hodnota Null se interpretuje jako začátek a konec času.

Návraty

PageOfContractDto
PageOfContractDto

Získání podrobností o konkrétním kódu chyby

Načte popis konkrétního kódu chyby.

Parametry

Name Klíč Vyžadováno Typ Description
value
value True string

value

Návraty

ErrorCodeDetailsDto
ErrorCodeDetailsDto

Získání vlastnosti podle daného ID

Načte vlastnost podle daného ID.

Parametry

Name Klíč Vyžadováno Typ Description
Jedinečný identifikátor vlastnosti
propertyId True integer

Jedinečný identifikátor vlastnosti

Návraty

Datová struktura vlastností

PropertyDto
PropertyDto

Získání vlastností podle zadaných parametrů filtru

Načtení vlastností podle zadaných parametrů filtru

Parametry

Name Klíč Vyžadováno Typ Description
Název vlastnosti.
name string

Název vlastnosti.

Směr řazení Možné hodnoty: ASC, DESC
order string

Směr řazení Možné hodnoty: ASC, DESC

Číslo stránky, které se má vrátit
page integer

Číslo stránky, které se má vrátit

Id vlastnosti čitelné pro člověka.
propertyHrId string

Id vlastnosti čitelné pro člověka.

Počet položek, které se mají vrátit na jedné stránce
size integer

Počet položek, které se mají vrátit na jedné stránce

Parametr řazení
sort string

Parametr řazení

Návraty

PageOfPropertyDto
PageOfPropertyDto

Získání všech jednotek podle zadaných parametrů filtru

Vrátí všechny jednotky respektující daná kritéria filtru.

Parametry

Name Klíč Vyžadováno Typ Description
Směr řazení Možné hodnoty: ASC, DESC
order string

Směr řazení Možné hodnoty: ASC, DESC

Číslo stránky, které se má vrátit
page integer

Číslo stránky, které se má vrátit

Jedinečný identifikátor vlastnosti, do které jednotka patří
propertyId integer

Jedinečný identifikátor vlastnosti, do které jednotka patří

Počet položek, které se mají vrátit na jedné stránce
size integer

Počet položek, které se mají vrátit na jedné stránce

Parametr řazení
sort string

Parametr řazení

Návraty

PageOfUnitDto
PageOfUnitDto

Získání všech předdefinovaných hodnot kódu chyby

Vrátí seznam všech předdefinovaných kódů chyb.

Návraty

Name Cesta Typ Description
array of string

Získání značek dokumentu

Standardní a doménové značky dokumentů se vrátí jako odpověď.

Parametry

Name Klíč Vyžadováno Typ Description
Hledaný řetězec použitý na název a popis
description string

Hledaný řetězec použitý na název a popis

Návraty

Čtení připojení

Čtení připojení

Parametry

Name Klíč Vyžadováno Typ Description
ID připojení
connectionIdX True integer

ID připojení

Návraty

Data popisující existující připojení

ConnectionDto
ConnectionDto

Aktivační události

Vytvoření připojení aplikace

Vytvoření připojení aplikace

Vytvoření připojení aplikace

Vytvoření připojení aplikace

Návraty

Definice

ConnectionNotificationDto

Name Cesta Typ Description
ID připojení, na které se oznámení vztahuje
connectionId integer

connectionId

typ entity
entityType string

typ entity

entityId
entityId integer

entityId

eventType
eventType string

eventType

ConnectionDto

Data popisující existující připojení

Name Cesta Typ Description
ID aplikace
appId integer

ID aplikace

Název aplikace připojení
appName string

Název aplikace připojení

Čas vytvoření entity
created string

Čas vytvoření entity

ID entity.
id integer

ID entity.

Název připojení
name string

Název připojení

Čas poslední aktualizace entity
updated string

Čas poslední aktualizace entity

Webhook připojení, které se bude volat jako post https://your.webhook.url/path/somewhere authorization: nosný token { "connectionId": 0, "entityType": "properties|contacts|invoices|etc", "entityId": 0, "eventType": "CREATE|AKTUALIZOVAT|DELETE" }'''
webhookUrl string

Webhook připojení, které se bude volat jako

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

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

ContactDetailsDto

Kontaktní údaje

Name Cesta Typ Description
Telefonní číslo kontaktu
businessPhoneNumber array of string

Telefonní číslo kontaktu

Datum narození kontaktu.
dateOfBirth string

Datum narození kontaktu.

E-mailová adresa kontaktu
email array of string

E-mailová adresa kontaktu

Faxové číslo kontaktu
fax array of string

Faxové číslo kontaktu

Číslo mobilního telefonu kontaktu
mobilePhoneNumber array of string

Číslo mobilního telefonu kontaktu

Soukromé telefonní číslo kontaktu
privatePhoneNumber array of string

Soukromé telefonní číslo kontaktu

Číslo obchodního rejstříku.
tradeRegisterNumber string

Číslo obchodního rejstříku.

DIČ kontaktu.
vatId string

DIČ kontaktu.

Webová stránka kontaktu
website array of string

Webová stránka kontaktu

ContactDto

Kontakt představuje fyzickou nebo právnickou osobu a způsob, jak je kontaktovat. Identita nebo společnost má více poštovních adres, prostřednictvím kterých může být kontaktována. Jsou reprezentované jako 2 různé kontakty.

Name Cesta Typ Description
Název města.
city string

Název města.

Název společnosti pro případ, že je kontakt společností.
companyName string

Název společnosti pro případ, že je kontakt společností.

Kód země podle normy ISO 3166-1 alfa-2.
country string

Kód země podle normy ISO 3166-1 alfa-2.

Čas vytvoření kontaktu
created string

Čas vytvoření kontaktu

ContactDetailsDto
details ContactDetailsDto

Kontaktní údaje

Jméno kontaktu pro případ, že je kontakt osoba.
firstName string

Jméno kontaktu pro případ, že je kontakt osoba.

ID instance kontaktu.
id integer

ID instance kontaktu.

Příjmení kontaktu pro případ, že je kontakt osoba.
lastName string

Příjmení kontaktu pro případ, že je kontakt osoba.

Číslo ulice.
number string

Číslo ulice.

PSČ nebo PSČ. Ujistěte se, že je určená pro každou osobu, která vyžaduje fyzický kontakt prostřednictvím e-mailového příspěvku.
postalCode string

PSČ nebo PSČ. Ujistěte se, že je určená pro každou osobu, která vyžaduje fyzický kontakt prostřednictvím e-mailového příspěvku.

Jméno příjemce kontaktu.
recipientName string

Jméno příjemce kontaktu.

Standardní vzorec slov použitých k adresování kontaktu.
salutation string

Standardní vzorec slov použitých k adresování kontaktu.

Název státu, označovaný také jako provincie, dílčí dělení nebo oblast.
state string

Název státu, označovaný také jako provincie, dílčí dělení nebo oblast.

Název ulice.
street string

Název ulice.

Pracovní pozice kontaktu.
title string

Pracovní pozice kontaktu.

Čas poslední aktualizace kontaktu
updated string

Čas poslední aktualizace kontaktu

ContactSimpleDto

Zjednodušená datová struktura kontaktů

Name Cesta Typ Description
ID instance kontaktu.
id integer

ID instance kontaktu.

Jméno kontaktu. Podrobnější informace načtou kontakt prostřednictvím ID.
name string

Jméno kontaktu. Podrobnější informace načtou kontakt prostřednictvím ID.

ContractDto

Struktura dat kontraktu

Name Cesta Typ Description
Seznam kontaktů přidružených ke smlouvě
contacts array of ContactSimpleDto

Seznam kontaktů přidružených ke smlouvě

Číslo smlouvy.
contractNumber string

Číslo smlouvy.

Čas vytvoření kontraktu
created string

Čas vytvoření kontraktu

Datum ukončení platnosti smlouvy. Hodnota Null se interpretuje jako konec času.
endDate string

Datum ukončení platnosti smlouvy. Hodnota Null se interpretuje jako konec času.

ID instance kontraktu.
id integer

ID instance kontraktu.

Popisuje, zda je tento kontrakt prázdným typem kontraktu. Odteď může být pravdivá pouze v případě, že je kontrakt typu TENANT. Volné zakázky znamená, že jednotka není pronajata.
isVacant boolean

Popisuje, zda je tento kontrakt prázdným typem kontraktu. Odteď může být pravdivá pouze v případě, že je kontrakt typu TENANT. Volné zakázky znamená, že jednotka není pronajata.

Název smlouvy, která se skládá z klíče jednotky a názvu kontaktu adresáta.
name string

Název smlouvy, která se skládá z klíče jednotky a názvu kontaktu adresáta.

ID instance vlastnosti, do které kontrakt patří.
propertyId integer

ID instance vlastnosti, do které kontrakt patří.

Datum platnosti smlouvy začíná od. Hodnota Null se interpretuje jako začátek času.
startDate string

Datum platnosti smlouvy začíná od. Hodnota Null se interpretuje jako začátek času.

Typ smlouvy. 1. VLASTNÍK - smlouva takového typu prokáže vlastnictví jednotky. 2. TENANT - smlouva takového typu je pronájem jednotky. 3. PROPERTY_OWNER - smlouva takového typu prokáže vlastnictví nemovitosti.
type string

Typ smlouvy.

  1. VLASTNÍK - smlouva takového typu prokáže vlastnictví jednotky.
  2. TENANT - smlouva takového typu je pronájem jednotky.
  3. PROPERTY_OWNER - smlouva takového typu prokáže vlastnictví nemovitosti.
ID instance jednotky, do které kontrakt patří.
unitId integer

ID instance jednotky, do které kontrakt patří.

Čas poslední aktualizace smlouvy
updated string

Čas poslední aktualizace smlouvy

DocumentDto

Struktura dat dokumentu

Name Cesta Typ Description
Celková částka, která je k dispozici v dokumentu
amount float

Celková částka, která je k dispozici v dokumentu

ID budovy, do které dokument patří.
buildingId integer

ID budovy, do které dokument patří.

ID kontaktu, ke které dokument patří.
contactId integer

ID kontaktu, ke které dokument patří.

ID smlouvy, do které dokument patří.
contractId integer

ID smlouvy, do které dokument patří.

Čas vytvoření dokumentu
created string

Čas vytvoření dokumentu

ID instance dokumentu.
id integer

ID instance dokumentu.

Datum vydání dokumentu.
issuedDate string

Datum vydání dokumentu.

Název instance dokumentu.
name string

Název instance dokumentu.

Id vlastnosti, ke které je dokument přiřazený člověkem čitelným.
propertyHrId string

Id vlastnosti, ke které je dokument přiřazený člověkem čitelným.

ID vlastnosti, do které dokument patří.
propertyId integer

ID vlastnosti, do které dokument patří.

Název vlastnosti, ke které je dokument přiřazen.
propertyName string

Název vlastnosti, ke které je dokument přiřazen.

ID zdrojové entity, do které dokument patří.
sourceId integer

ID zdrojové entity, do které dokument patří.

Typ zdroje dokumentu Společně s ID identifikuje obchodní proces se stejným názvem, ke kterému dokument pochází nebo je k němu připojen. Může mít hodnotu null.
sourceType string

Typ zdroje dokumentu Společně s ID identifikuje obchodní proces se stejným názvem, ke kterému dokument pochází nebo je k němu připojen. Může mít hodnotu null.

Stav dokumentu.
state string

Stav dokumentu.

tags
tags array of DocumentTagSimpleDto
Id čitelného člověka v jednotce, ke které je dokument přiřazen.
unitHrId string

Id čitelného člověka v jednotce, ke které je dokument přiřazen.

ID jednotky, do které dokument patří.
unitId integer

ID jednotky, do které dokument patří.

Čas poslední aktualizace dokumentu
updated string

Čas poslední aktualizace dokumentu

DocumentTagDto

Třída modelu značky dokumentu

Name Cesta Typ Description
Popis značky dokumentu
description string

Popis značky dokumentu

ID značky dokumentu.
id integer

ID značky dokumentu.

Název značky dokumentu
name string

Název značky dokumentu

DocumentTagSimpleDto

Třída modelu značky dokumentu

Name Cesta Typ Description
Jedinečný identifikátor značky dokumentu
id integer

Jedinečný identifikátor značky dokumentu

Název značky dokumentu
name string

Název značky dokumentu

ErrorCodeDetailsDto

Name Cesta Typ Description
kód
code string
popis
description string

InvoiceDto

Struktura dat faktury

Name Cesta Typ Description
Částka, která se má zaplatit na základě faktury.
amount float

Částka, která se má zaplatit na základě faktury.

ID kontaktu protistrany faktury.
counterpartContactId integer

ID kontaktu protistrany faktury.

Jméno protějšek kontaktu faktury.
counterpartContactName string

Jméno protějšek kontaktu faktury.

Čas vytvoření entity
created string

Čas vytvoření entity

ID entity.
id integer

ID entity.

Datum vystavení faktury.
issuedDate string

Datum vystavení faktury.

items
items array of InvoiceItemDto
Název faktury
name string

Název faktury

Číslo BIC bankovního účtu protějšku.
orderCounterpartBic string

Číslo BIC bankovního účtu protějšku.

IBAN bankovního účtu protějšku.
orderCounterpartIban string

IBAN bankovního účtu protějšku.

Počet dní před nebo po datu rezervace, ve kterém se bankovní objednávka zobrazí k provedení.
orderDayOffset integer

Počet dní před nebo po datu rezervace, ve kterém se bankovní objednávka zobrazí k provedení.

Jedinečný identifikátor bankovního účtu nemovitosti.
orderPropertyBankAccountId integer

Jedinečný identifikátor bankovního účtu nemovitosti.

BIC číslo bankovního účtu nemovitosti.
orderPropertyBic string

BIC číslo bankovního účtu nemovitosti.

IBAN bankovního účtu nemovitosti.
orderPropertyIban string

IBAN bankovního účtu nemovitosti.

Pravda v případě, že existuje odpovídající objednávka faktury.
orderRequired boolean

Pravda v případě, že existuje odpovídající objednávka faktury.

Příkaz vygenerované objednávky.
orderStatement string

Příkaz vygenerované objednávky.

Id vlastnosti, do které faktura patří, je čitelné.
propertyHrId string

Id vlastnosti, do které faktura patří, je čitelné.

ID vlastnosti, do které faktura patří.
propertyId integer

ID vlastnosti, do které faktura patří.

Název vlastnosti, do které faktura patří.
propertyName string

Název vlastnosti, do které faktura patří.

Stav faktury Možné hodnoty: 1. KONCEPT – vytvoření faktury, ale neúplné. 2. PŘIPRAVENO - faktura připravená k rezervaci. 3. REZERVOVÁNO - faktura rezervována. 4. NAPLÁNOVÁNO – platí pouze pro opakované faktury. 5. REVERSED – všechny rezervace vygenerované fakturou byly obráceny.
state string

Stav faktury Možné hodnoty:

  1. KONCEPT – faktura je vytvořená, ale neúplná.
  2. READY – faktura připravená k rezervaci.
  3. REZERVOVÁNO - faktura rezervována.
  4. SCHEDULED – vztahuje se pouze na opakované faktury.
  5. REVERSED – všechny rezervace vygenerované fakturou byly obráceny.
Čas poslední aktualizace entity
updated string

Čas poslední aktualizace entity

InvoiceItemDto

Name Cesta Typ Description
Kód účtu položky rezervace.
accountCode string

Kód účtu položky rezervace.

ID účtu položky rezervace.
accountId integer

ID účtu položky rezervace.

Název účtu rezervace.
accountName string

Název účtu rezervace.

Částka odpovídající objednávce.
amount float

Částka odpovídající objednávce.

Booking text of the booking item.
bookingText string

Booking text of the booking item.

Čas vytvoření položky faktury
created string

Čas vytvoření položky faktury

Jedinečný identifikátor položky rezervace.
id integer

Jedinečný identifikátor položky rezervace.

Částka relevantní pro přiznání daně z příjmu podle zákona o daních z příjmu: [Einkommenstueregesetz EStG 35a](https://www.gesetze-im-internet.de/estg/__35a.html).
laborCostAmount float

Částka relevantní pro přiznání daně z příjmu podle zákona o dani z příjmu: Einkommenstueregesetz EStG 35a.

V závislosti na vybraném typu: procenta částek budou oznámena v přílohách 35a více zpráv podle zákona o daních z příjmů: [Einkommenstueregesetz EStG 35a](https://www.gesetze-im-internet.de/estg/__35a.html). Příklad: Housemoney Settlement (Hausgeldabrechnung) nebo 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

V závislosti na vybraném typu: procenta částek budou hlášeny v přílohách 35a více zpráv podle zákona o daních z příjmů: Einkommenstueregesetz EStG 35a.

Příklad: Housemoney Settlement (Hausgeldabrechnung) nebo 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
Čas poslední aktualizace položky faktury
updated string

Čas poslední aktualizace položky faktury

Odpovídající částka dph rezervace.
vatAmount float

Odpovídající částka dph rezervace.

Odpovídající procento dph celkové částky dph.
vatPercentage float

Odpovídající procento dph celkové částky dph.

PageOfContactDto

Name Cesta Typ Description
obsah
content array of ContactDto
empty
empty boolean
první
first boolean
last
last boolean
číslo
number integer
numberOfElements
numberOfElements integer
Stránkovatelné
pageable Pageable
size
size integer
Seřadit
sort Sort
totalElements
totalElements integer
totalPages
totalPages integer

PageOfContractDto

Name Cesta Typ Description
obsah
content array of ContractDto
empty
empty boolean
první
first boolean
last
last boolean
číslo
number integer
numberOfElements
numberOfElements integer
Stránkovatelné
pageable Pageable
size
size integer
Seřadit
sort Sort
totalElements
totalElements integer
totalPages
totalPages integer

PageOfDocumentDto

Name Cesta Typ Description
obsah
content array of DocumentDto
empty
empty boolean
první
first boolean
last
last boolean
číslo
number integer
numberOfElements
numberOfElements integer
Stránkovatelné
pageable Pageable
size
size integer
Seřadit
sort Sort
totalElements
totalElements integer
totalPages
totalPages integer

StránkaOfInvoiceDto

Name Cesta Typ Description
obsah
content array of InvoiceDto
empty
empty boolean
první
first boolean
last
last boolean
číslo
number integer
numberOfElements
numberOfElements integer
Stránkovatelné
pageable Pageable
size
size integer
Seřadit
sort Sort
totalElements
totalElements integer
totalPages
totalPages integer

PageOfPropertyDto

Name Cesta Typ Description
obsah
content array of PropertyDto
empty
empty boolean
první
first boolean
last
last boolean
číslo
number integer
numberOfElements
numberOfElements integer
Stránkovatelné
pageable Pageable
size
size integer
Seřadit
sort Sort
totalElements
totalElements integer
totalPages
totalPages integer

PageOfUnitDto

Name Cesta Typ Description
obsah
content array of UnitDto
empty
empty boolean
první
first boolean
last
last boolean
číslo
number integer
numberOfElements
numberOfElements integer
Stránkovatelné
pageable Pageable
size
size integer
Seřadit
sort Sort
totalElements
totalElements integer
totalPages
totalPages integer

Stránkovatelné

Name Cesta Typ Description
posun
offset integer
pageNumber
pageNumber integer
pageSize
pageSize integer
stránkovaný
paged boolean
Seřadit
sort Sort
bez stránky
unpaged boolean

PropertyDto

Datová struktura vlastností

Name Cesta Typ Description
Čas vytvoření instance vlastnosti
created string

Čas vytvoření instance vlastnosti

ID instance vlastnosti.
id integer

ID instance vlastnosti.

Název instance vlastnosti.
name string

Název instance vlastnosti.

ID instance vlastnosti čitelné pro člověka.
propertyHrId string

ID instance vlastnosti čitelné pro člověka.

Aktuální stav vlastnosti. 1. KONCEPT - vlastnost ještě není aktivována, proto nelze vygenerovat žádné rezervace/ bankovní objednávky/ sestavy. 2. PŘIPRAVENO - vlastnost byla aktivována a lze ji použít pro bookings/ bankovní objednávky/ generování sestav. 3. ZAKÁZÁNO - vlastnost byla deaktivována a již nelze generovat rezervace/ bankovní objednávky/sestavy.
state string

Aktuální stav vlastnosti.

  1. KONCEPT - vlastnost ještě není aktivována, proto není možné vygenerovat žádné rezervace/ bankovní objednávky/sestavy.
  2. READY - vlastnost byla aktivována a lze ji použít pro bookings/ bankovní objednávky/ generování sestav.
  3. DISABLED – vlastnost byla deaktivována a již nelze generovat rezervace, bankovní objednávky a sestavy.
Typ správy vlastnosti. VLASTNÍK - Asociace vlastníka domu. RENTAL - Správa tenantů.
type string

Typ správy vlastnosti. VLASTNÍK - Asociace vlastníka domu. RENTAL - Správa tenantů.

Aktualizujte čas instance vlastnosti.
updated string

Aktualizujte čas instance vlastnosti.

Seřadit

Name Cesta Typ Description
empty
empty boolean
seřazený
sorted boolean
netříděný
unsorted boolean

UnitDto

Datová struktura jednotek.

Name Cesta Typ Description
Čas vytvoření instance jednotky
created string

Čas vytvoření instance jednotky

Podlaha je umístěna na.
floor string

Podlaha je umístěna na.

ID instance jednotky.
id integer

ID instance jednotky.

Umístění jednotky v podlaze.
position string

Umístění jednotky v podlaze.

ID instance vlastnosti, do které jednotka patří.
propertyId integer

ID instance vlastnosti, do které jednotka patří.

Účel jednotky se používá pro. APARTMENT - jednotka používaná pro obytné účely. PARKING - jednotka používaná pro parkovací účely. COMMERCIAL - jednotka používaná pro obchodní/komerční účely. OTHER - jednotka používaná pro jiné účely.
type string

Účel jednotky se používá pro. APARTMENT - jednotka používaná pro obytné účely. PARKING - jednotka používaná pro parkovací účely. COMMERCIAL - jednotka používaná pro obchodní/komerční účely. OTHER - jednotka používaná pro jiné účely.

Id instance jednotky čitelné pro člověka.
unitHrId string

Id instance jednotky čitelné pro člověka.

Pořadí definuje pořadí zobrazení jednotek v uživatelském rozhraní nebo sestavách. Uživatel ho může aktualizovat v uživatelském rozhraní.
unitRank integer

Pořadí definuje pořadí zobrazení jednotek v uživatelském rozhraní nebo sestavách. Uživatel ho může aktualizovat v uživatelském rozhraní.

Aktualizujte čas instance jednotky.
updated string

Aktualizujte čas instance jednotky.

LegacyInvoiceDto

Name Cesta Typ Description
Protějšk BIC
counterpartBic string

Protějšk BIC

Protějšek ContactID
counterpartContactId integer

Protějšek ContactID

IBAN – protějšk
counterpartIban string

IBAN – protějšk

Protějšek
counterpartName string

Protějšek

Date
created string

Date

Adresa URL faktury
documentUrl string

Adresa URL faktury

ID
id integer

ID

Datum faktury
invoiceDate string

Datum faktury

ID faktury
invoiceHrId string

ID faktury

Číslo faktury
invoiceNumber string

Číslo faktury

Cílové datum platby
paymentTargetDate string

Cílové datum platby

Typ platby
paymentType string

Typ platby

Číslo nárožní vlastnosti
propertyHrId string

Číslo nárožní vlastnosti

ID vlastnosti
propertyId integer

ID vlastnosti

Interní ID vlastnosti
propertyIdInternal string

Interní ID vlastnosti

Název vlastnosti
propertyName string

Název vlastnosti

Referenční číslo č.
refNr string

Referenční číslo č.

Stav faktury
state string

Stav faktury

Total Gross
totalGross float

Total Gross

Total Net
totalNet float

Total Net

DPH včetně DPH.
vatIncluded boolean

DPH včetně DPH.

Procento DPH
vatPercentage float

Procento DPH

soubor

Toto je základní datový typ "file".