次の方法で共有

Impower ERP (プレビュー)

プロパティ マネージャー impower.de 会計システムとの対話を許可する

このコネクタは、次の製品とリージョンで使用できます。

サービス クラス リージョン
コピロット スタジオ Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
ロジック アプリ Standard 次を除くすべての Logic Apps リージョン :
     - Azure Government リージョン
     - Azure China リージョン
     - 米国国防総省 (DoD)
Power Apps Premium 次を除くすべての Power Apps リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
Power Automate Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
お問い合わせ
名前 API サポート
URL https://impower.de
Email support+api@impower.de
コネクタ メタデータ
Publisher Impower GmbH
Website https://www.impower.de
プライバシー ポリシー https://www.impower.de/datenschutzerklaerung
カテゴリ ビジネス管理;金融

Impower コネクタを使用すると、プロパティ、単位、コントラクト、連絡先などの masterdataset にアクセスできます。 さらに、ドキュメントや請求書をアップロードすることもできます。 スケジュールに基づいてデータを読み取るか、統合されたトリガーを使用して Webhook を登録します。

[前提条件]

Impower を使用するには、次のものが必要です。

  1. 有料の Impower サブスクリプション
  2. Powerautomate Premium サブスクリプション

資格情報を取得する方法

powerautomate に接続するドメインの APIKey を取得するには、 support@impower.deに要求を記述してください。

コネクタの概要

構築を検討するシナリオ:

  1. Sharepoint/Onedrive フォルダーで変更を確認し、新しい PDF ファイルが表示される場合は、それらを impower にアップロードします
  2. 連絡先リストをチームのアドレス帳と同期する

既知の問題と制限事項

ファイルのダウンロード/アップロード

ファイルは、バイナリ形式でマルチパート フォーム データとしてアップロードされます。 ダウンロードでも同じことが行われます:ファイルは、http標準と同様に、ヘッダーに推奨されるファイル名と同じように提供されます

Ratelimiting

1 分間に 5,000 件を超える要求を行わないようお願いします。 システムがユーザーに迅速にサービスを提供できるように、API にレートリミティングを適用します

接続を作成する

コネクタでは、次の認証の種類がサポートされています。
デフォルト 接続を作成するためのパラメーター。 すべてのリージョン 共有不可

デフォルト

適用対象: すべてのリージョン

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

名前 タイプ Description 必須
API-Key securestring この API の API-Key 正しい

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

(レガシ)請求書をアップロードする

レガシ API を使用して、Pdf ファイルを Impower にアップロードします。 代わりに uploadInvoiceUsingPOST 操作を使用してください。
ドキュメント タグを取得する

標準およびドメイン固有のドキュメント タグが応答として返されます
定義済みのすべてのエラー コード値を取得する

定義済みのすべてのエラー コードの一覧を返します。
従来の請求書の詳細

レガシ API を使用して Impower から請求書の詳細を取得します。 代わりに getInvoiceByIdUsingGET を使用してください。
指定された ID で 1 つのドキュメントをダウンロードする

ドキュメントの形式は mimetype によって定義されます
指定された ID でコントラクトを取得する

指定された ID でコントラクトを取得します。
指定された ID でプロパティを取得する

指定された ID でプロパティを取得します。
指定された ID で単位を取得する

指定された ID を持つ単位を返します
指定された ID で請求書を取得する

指定された ID で請求書を取得します。
指定された ID で連絡先を取得する

指定された ID で連絡先を取得します。
指定された ID に基づいて既存のドキュメント タグを削除する

システムで生成されたタグを削除できない
指定された ID に基づいて既存のドキュメント タグを更新する

更新されたドキュメント タグが応答として返されます
指定された ID に基づいて既存のドキュメントを削除する

システムで生成されたドキュメントを削除できない
指定されたファイルに基づいて新しいドキュメントを作成する

新しく作成されたドキュメントが応答として返されます
指定されたフィルター パラメーターでコントラクトを取得する

指定されたフィルター パラメーターによってコントラクトを取得する
指定されたフィルター パラメーターでドキュメントを取得する

指定されたフィルター パラメーターを使用してドキュメントを取得する
指定されたフィルター パラメーターでプロパティを取得する

指定されたフィルター パラメーターでプロパティを取得する
指定されたフィルター パラメーターで請求書を取得する

指定されたフィルター パラメーターによって請求書を取得します
指定されたフィルター パラメーターで連絡先を取得する

指定されたフィルター パラメーターで連絡先を取得する
指定されたフィルター パラメーターによってすべての単位を取得する

指定されたフィルター条件を考慮するすべての単位を返します。
指定されたフィールドに基づいて請求書を更新する

請求書の更新
指定された要求本文に基づいて既存のドキュメントを更新する

すべての必要な情報は要求本文にあります
指定された請求書予約アイテムの予約テキストを更新する

予約テキストを更新する
接続の読み取り

接続の読み取り
接続を削除する

接続を削除する
接続を更新する

接続を更新する
新しいドキュメント タグを作成する

新しく作成されたドキュメント タグが応答として返されます
特定のエラー コードの詳細を取得する

特定のエラー コードの説明を取得します
特定のフィルター条件で複数のドキュメントをダウンロードする

ドキュメントは zip 形式で提供されます
請求書 PDF ドキュメントをアップロードする

既定では、ドキュメントは OCR 分析を行います

(レガシ)請求書をアップロードする

操作 ID:
UploadInvoice

レガシ API を使用して、Pdf ファイルを Impower にアップロードします。 代わりに uploadInvoiceUsingPOST 操作を使用してください。

パラメーター

名前 キー 必須 型 説明
アップロードする PDF ファイルを指定する
 file True file

アップロードする PDF ファイルを指定する

戻り値

LegacyInvoiceDto
LegacyInvoiceDto

ドキュメント タグを取得する

操作 ID:
getDocumentTagsUsingGET

標準およびドメイン固有のドキュメント タグが応答として返されます

パラメーター

名前 キー 必須 型 説明
名前と説明に適用される検索文字列
 description string

名前と説明に適用される検索文字列

戻り値

response
array of DocumentTagDto

定義済みのすべてのエラー コード値を取得する

操作 ID:
errorCodesUsingGET

定義済みのすべてのエラー コードの一覧を返します。

戻り値

名前 パス 型 説明
array of string

従来の請求書の詳細

操作 ID:
GetInvoice

レガシ API を使用して Impower から請求書の詳細を取得します。 代わりに getInvoiceByIdUsingGET を使用してください。

パラメーター

名前 キー 必須 型 説明
請求書 ID
 invoiceId True integer

詳細の請求書 ID を指定する

戻り値

LegacyInvoiceDto
LegacyInvoiceDto

指定された ID で 1 つのドキュメントをダウンロードする

操作 ID:
downloadUsingGET

ドキュメントの形式は mimetype によって定義されます

パラメーター

名前 キー 必須 型 説明
ドキュメントの一意識別子
 documentId True integer

ドキュメントの一意識別子

戻り値

response
file

指定された ID でコントラクトを取得する

操作 ID:
getContractByIdUsingGET

指定された ID でコントラクトを取得します。

パラメーター

名前 キー 必須 型 説明
コントラクトの一意識別子
 contractId True integer

コントラクトの一意識別子

戻り値

コントラクト データ構造。

ContractDto
ContractDto

指定された ID でプロパティを取得する

操作 ID:
getPropertyByIdUsingGET

指定された ID でプロパティを取得します。

パラメーター

名前 キー 必須 型 説明
プロパティの一意識別子
 propertyId True integer

プロパティの一意識別子

戻り値

プロパティ データ構造。

PropertyDto
PropertyDto

指定された ID で単位を取得する

操作 ID:
getUnitByIdUsingGET

指定された ID を持つ単位を返します

パラメーター

名前 キー 必須 型 説明
ユニットの一意の ID
 unitId True integer

ユニットの一意の ID

戻り値

単位データ構造。

UnitDto
UnitDto

指定された ID で請求書を取得する

操作 ID:
getInvoiceByIdUsingGET

指定された ID で請求書を取得します。

パラメーター

名前 キー 必須 型 説明
請求書の一意識別子
 invoiceId True integer

請求書の一意識別子

戻り値

請求書データ構造。

InvoiceDto
InvoiceDto

指定された ID で連絡先を取得する

操作 ID:
getContactByIdUsingGET

指定された ID で連絡先を取得します。

パラメーター

名前 キー 必須 型 説明
連絡先の一意識別子
 contactId True integer

連絡先の一意識別子

戻り値

連絡先は、自然人または法人を表し、連絡方法を表します。 ID/会社は、複数の住所を持ち、その住所を通じて連絡を取る必要があります。 これらは 2 つの異なる連絡先として表されます。

ContactDto
ContactDto

指定された ID に基づいて既存のドキュメント タグを削除する

操作 ID:
deleteDocumentTagUsingDELETE

システムで生成されたタグを削除できない

パラメーター

名前 キー 必須 型 説明
削除するドキュメント タグの一意識別子
 tagId True integer

削除するドキュメント タグの一意識別子

指定された ID に基づいて既存のドキュメント タグを更新する

操作 ID:
updateDocumentTagUsingPUT

更新されたドキュメント タグが応答として返されます

パラメーター

名前 キー 必須 型 説明
ドキュメント タグの一意識別子
 tagId True integer

ドキュメント タグの一意識別子
ドキュメント タグの新しい説明。
 description string

ドキュメント タグの新しい説明。
ドキュメント タグの新しい名前。
 name string

ドキュメント タグの新しい名前。

戻り値

ドキュメント タグの Model クラス。

DocumentTagDto
DocumentTagDto

指定された ID に基づいて既存のドキュメントを削除する

操作 ID:
deleteDocumentUsingDELETE

システムで生成されたドキュメントを削除できない

パラメーター

名前 キー 必須 型 説明
documentId
 documentId True integer

documentId

指定されたファイルに基づいて新しいドキュメントを作成する

操作 ID:
createDocumentByUploadUsingPOST

新しく作成されたドキュメントが応答として返されます

パラメーター

名前 キー 必須 型 説明
アップロードする PDF ファイル
 file True file

アップロードする PDF ファイル

戻り値

ドキュメント データ構造。

DocumentDto
DocumentDto

指定されたフィルター パラメーターでコントラクトを取得する

操作 ID:
getContractsByFilterUsingGET

指定されたフィルター パラメーターによってコントラクトを取得する

パラメーター

名前 キー 必須 型 説明
コントラクトが関連付けられている連絡先インスタンスの ID。
 contactId integer

コントラクトが関連付けられている連絡先インスタンスの ID。
コントラクトをフィルター処理するコントラクト ID の一覧。
 contractIds array

コントラクトをフィルター処理するコントラクト ID の一覧。
並べ替えの方向。 指定できる値: ASC、DESC
 order string

並べ替えの方向。 指定できる値: ASC、DESC
返されるページ番号
 page integer

返されるページ番号
コントラクトが属するプロパティ インスタンスの ID。
 propertyId integer

コントラクトが属するプロパティ インスタンスの ID。
1 ページで返されるアイテムの数
 size integer

1 ページで返されるアイテムの数
並べ替えパラメーター
 sort string

並べ替えパラメーター
コントラクトの型。 オプション: OWNER |TENANT |PROPERTY_OWNER
 type array

コントラクトの型。 オプション: OWNER |TENANT |PROPERTY_OWNER
コントラクトが関連付けられているユニット インスタンスの ID。
 unitId integer

コントラクトが関連付けられているユニット インスタンスの ID。
有効なコントラクトを日付で返します。 Null は、開始時刻/終了時刻として解釈されます。
 validAtDate string

有効なコントラクトを日付で返します。 Null は、開始時刻/終了時刻として解釈されます。

戻り値

PageOfContractDto
PageOfContractDto

指定されたフィルター パラメーターでドキュメントを取得する

操作 ID:
getDocumentsByFilterUsingGET

指定されたフィルター パラメーターを使用してドキュメントを取得する

パラメーター

名前 キー 必須 型 説明
プロパティの会計士名。
 accountant string

プロパティの会計士名。
プロパティの管理者名。
 administrator string

プロパティの管理者名。
ドキュメントが属する連絡先エンティティの ID。
 contactId integer

ドキュメントが属する連絡先エンティティの ID。
類似した名前のコントラクトにリンクされているドキュメント。
 contractName string

類似した名前のコントラクトにリンクされているドキュメント。
返されるドキュメントの ID。
 documentIds array

返されるドキュメントの ID。
返されるドキュメントの名前。
 documentName string

返されるドキュメントの名前。
ドキュメントの発行日。
 issuedDate string

ドキュメントの発行日。
発行日より前の日付のドキュメント。
 maxIssuedDate string

発行日より前の日付のドキュメント。
発行日の後のドキュメント。
 minIssuedDate string

発行日の後のドキュメント。
並べ替えの方向。 指定できる値: ASC、DESC
 order string

並べ替えの方向。 指定できる値: ASC、DESC
返されるページ番号
 page integer

返されるページ番号
ドキュメントが属するプロパティの人間が判読できる ID。
 propertyHrId string

ドキュメントが属するプロパティの人間が判読できる ID。
ドキュメントが属するプロパティの ID。
 propertyId integer

ドキュメントが属するプロパティの ID。
ドキュメントが属するプロパティの名前。
 propertyName string

ドキュメントが属するプロパティの名前。
1 ページで返されるアイテムの数
 size integer

1 ページで返されるアイテムの数
並べ替えパラメーター
 sort string

並べ替えパラメーター
ドキュメントが属するソース エンティティの ID。
 sourceId integer

ドキュメントが属するソース エンティティの ID。
ドキュメントのソースの種類。
 sourceType array

ドキュメントのソースの種類。
ドキュメントが関連付けられているタグの ID。
 tagIds array

ドキュメントが関連付けられているタグの ID。
ドキュメントが関連付けるタグの同様の名前。
 tagName string

ドキュメントが関連付けるタグの同様の名前。
ドキュメントが属する単位エンティティの ID。
 unitId integer

ドキュメントが属する単位エンティティの ID。

戻り値

PageOfDocumentDto
PageOfDocumentDto

指定されたフィルター パラメーターでプロパティを取得する

操作 ID:
getPropertiesByFilterUsingGET

指定されたフィルター パラメーターでプロパティを取得する

パラメーター

名前 キー 必須 型 説明
プロパティの名前。
 name string

プロパティの名前。
並べ替えの方向。 指定できる値: ASC、DESC
 order string

並べ替えの方向。 指定できる値: ASC、DESC
返されるページ番号
 page integer

返されるページ番号
プロパティの人間が判読できる ID。
 propertyHrId string

プロパティの人間が判読できる ID。
1 ページで返されるアイテムの数
 size integer

1 ページで返されるアイテムの数
並べ替えパラメーター
 sort string

並べ替えパラメーター

戻り値

PageOfPropertyDto
PageOfPropertyDto

指定されたフィルター パラメーターで請求書を取得する

操作 ID:
getInvoicesByFilterUsingGET

指定されたフィルター パラメーターによって請求書を取得します

パラメーター

名前 キー 必須 型 説明
対応する連絡先の一意識別子
 counterpartContactId integer

対応する連絡先の一意識別子
取得する請求書の日付
 issuedDate string

取得する請求書の日付
並べ替えの方向。 指定できる値: ASC、DESC
 order string

並べ替えの方向。 指定できる値: ASC、DESC
返されるページ番号
 page integer

返されるページ番号
請求書が属するプロパティの一意識別子
 propertyId integer

請求書が属するプロパティの一意識別子
1 ページで返されるアイテムの数
 size integer

1 ページで返されるアイテムの数
並べ替えパラメーター
 sort string

並べ替えパラメーター
取得する請求書の状態
 states array

取得する請求書の状態

戻り値

PageOfInvoiceDto
PageOfInvoiceDto

指定されたフィルター パラメーターで連絡先を取得する

操作 ID:
getContactsByFilterUsingGET

指定されたフィルター パラメーターで連絡先を取得する

パラメーター

名前 キー 必須 型 説明
連絡先をフィルター処理する連絡先 ID の一覧。
 contactIds array

連絡先をフィルター処理する連絡先 ID の一覧。
連絡先のメール アドレス。
 email string

連絡先のメール アドレス。
連絡先の任意の名前。 名、姓、または会社名を指定できます。
 name string

連絡先の任意の名前。 名、姓、または会社名を指定できます。
並べ替えの方向。 指定できる値: ASC、DESC
 order string

並べ替えの方向。 指定できる値: ASC、DESC
返されるページ番号
 page integer

返されるページ番号
1 ページで返されるアイテムの数
 size integer

1 ページで返されるアイテムの数
並べ替えパラメーター
 sort string

並べ替えパラメーター

戻り値

PageOfContactDto
PageOfContactDto

指定されたフィルター パラメーターによってすべての単位を取得する

操作 ID:
getUnitsByFilterUsingGET

指定されたフィルター条件を考慮するすべての単位を返します。

パラメーター

名前 キー 必須 型 説明
並べ替えの方向。 指定できる値: ASC、DESC
 order string

並べ替えの方向。 指定できる値: ASC、DESC
返されるページ番号
 page integer

返されるページ番号
ユニットが属するプロパティの一意識別子
 propertyId integer

ユニットが属するプロパティの一意識別子
1 ページで返されるアイテムの数
 size integer

1 ページで返されるアイテムの数
並べ替えパラメーター
 sort string

並べ替えパラメーター

戻り値

PageOfUnitDto
PageOfUnitDto

指定されたフィールドに基づいて請求書を更新する

操作 ID:
updateInvoiceUsingPUT

請求書の更新

パラメーター

名前 キー 必須 型 説明
請求書の一意の ID
 invoiceId True integer

請求書の一意の ID
請求書の新しい発行日。
 issuedDate string

請求書の新しい発行日。
請求書の新しい名前。
 name string

請求書の新しい名前。

戻り値

請求書データ構造。

InvoiceDto
InvoiceDto

指定された要求本文に基づいて既存のドキュメントを更新する

操作 ID:
updateDocumentsUsingPUT

すべての必要な情報は要求本文にあります

パラメーター

名前 キー 必須 型 説明
更新するドキュメントの金額の新しい値
 amount float

更新するドキュメントの金額の新しい値
割り当てるドキュメントをビルドする新しい建物。
 buildingId integer

割り当てるドキュメントをビルドする新しい建物。
割り当てるドキュメントの新しい連絡先
 contactId integer

割り当てるドキュメントの新しい連絡先
割り当てるドキュメントの新しいコントラクト
 contractId integer

割り当てるドキュメントの新しいコントラクト
更新するドキュメントの一意識別子
 id True integer

更新するドキュメントの一意識別子
ドキュメントの発行日を更新する新しい日付
 issuedDate string

ドキュメントの発行日を更新する新しい日付
更新するドキュメント名の新しい値
 name string

更新するドキュメント名の新しい値
割り当てるドキュメントの新しいプロパティ
 propertyId integer

割り当てるドキュメントの新しいプロパティ
割り当てるドキュメントの新しいソース プロセス ID
 sourceId integer

割り当てるドキュメントの新しいソース プロセス ID
ドキュメントに割り当てられるタグの識別子
 tagIds array of integer

ドキュメントに割り当てられるタグの識別子
割り当てるドキュメントの新しい単位
 unitId integer

割り当てるドキュメントの新しい単位

戻り値

response
array of DocumentDto

指定された請求書予約アイテムの予約テキストを更新する

操作 ID:
updateInvoiceItemUsingPUT

予約テキストを更新する

パラメーター

名前 キー 必須 型 説明
請求書予約アイテムの一意の ID
 invoiceItemId True integer

請求書予約アイテムの一意の ID
請求書アイテムの予約テキスト。
 bookingText string

請求書アイテムの予約テキスト。

戻り値

InvoiceItemDto
InvoiceItemDto

接続の読み取り

操作 ID:
getConnectionUsingGET

接続の読み取り

パラメーター

名前 キー 必須 型 説明
接続の ID
 connectionIdX True integer

接続の ID

戻り値

既存の接続を記述するデータ

ConnectionDto
ConnectionDto

接続を削除する

操作 ID:
deleteConnectionUsingDELETE

接続を削除する

パラメーター

名前 キー 必須 型 説明
接続の ID
 connectionIdX True integer

接続の ID

接続を更新する

操作 ID:
updateConnectionUsingPUT

接続を更新する

パラメーター

名前 キー 必須 型 説明
接続の ID
 connectionIdX True integer

接続の ID
UI に表示される接続の名前。 指定しない場合は、既定でアプリケーションの名前が使用されます
name string

UI に表示される接続の名前。 指定しない場合は、既定でアプリケーションの名前が使用されます
URL は、検証できる承認トークンと、次の本文で呼び出されます: {"connectionId":123,"entityType":"properties","entityId":123,"eventType": "UPDATE"}
 webhookUrl string

URL は、検証できる承認トークンと、次の本文で呼び出されます: {"connectionId":123,"entityType":"properties","entityId":123,"eventType": "UPDATE"}

戻り値

既存の接続を記述するデータ

ConnectionDto
ConnectionDto

新しいドキュメント タグを作成する

操作 ID:
createDocumentTagUsingPOST

新しく作成されたドキュメント タグが応答として返されます

パラメーター

名前 キー 必須 型 説明
新しく作成されたドキュメント タグの説明。
 description string

新しく作成されたドキュメント タグの説明。
新しく作成されたドキュメント タグの名前。
 name string

新しく作成されたドキュメント タグの名前。

戻り値

ドキュメント タグの Model クラス。

DocumentTagDto
DocumentTagDto

特定のエラー コードの詳細を取得する

操作 ID:
errorCodeUsingGET

特定のエラー コードの説明を取得します

パラメーター

名前 キー 必須 型 説明
value
 value True string

value

戻り値

ErrorCodeDetailsDto
ErrorCodeDetailsDto

特定のフィルター条件で複数のドキュメントをダウンロードする

操作 ID:
downloadDocumentsByFilterUsingGET

ドキュメントは zip 形式で提供されます

パラメーター

名前 キー 必須 型 説明
プロパティの会計士名。
 accountant string

プロパティの会計士名。
プロパティの管理者名。
 administrator string

プロパティの管理者名。
ドキュメントが属する連絡先エンティティの ID。
 contactId integer

ドキュメントが属する連絡先エンティティの ID。
類似した名前のコントラクトにリンクされているドキュメント。
 contractName string

類似した名前のコントラクトにリンクされているドキュメント。
返されるドキュメントの ID。
 documentIds array

返されるドキュメントの ID。
返されるドキュメントの名前。
 documentName string

返されるドキュメントの名前。
ドキュメントの発行日。
 issuedDate string

ドキュメントの発行日。
発行日より前の日付のドキュメント。
 maxIssuedDate string

発行日より前の日付のドキュメント。
発行日の後のドキュメント。
 minIssuedDate string

発行日の後のドキュメント。
ドキュメントが属するプロパティの人間が判読できる ID。
 propertyHrId string

ドキュメントが属するプロパティの人間が判読できる ID。
ドキュメントが属するプロパティの ID。
 propertyId integer

ドキュメントが属するプロパティの ID。
ドキュメントが属するプロパティの名前。
 propertyName string

ドキュメントが属するプロパティの名前。
ドキュメントが属するソース エンティティの ID。
 sourceId integer

ドキュメントが属するソース エンティティの ID。
ドキュメントのソースの種類。
 sourceType array

ドキュメントのソースの種類。
ドキュメントが関連付けられているタグの ID。
 tagIds array

ドキュメントが関連付けられているタグの ID。
ドキュメントが関連付けるタグの同様の名前。
 tagName string

ドキュメントが関連付けるタグの同様の名前。
ドキュメントが属する単位エンティティの ID。
 unitId integer

ドキュメントが属する単位エンティティの ID。

戻り値

response
file

請求書 PDF ドキュメントをアップロードする

操作 ID:
uploadInvoiceUsingPOST

既定では、ドキュメントは OCR 分析を行います

パラメーター

名前 キー 必須 型 説明
請求書の PDF ファイル
 file True file

請求書の PDF ファイル

戻り値

請求書データ構造。

InvoiceDto
InvoiceDto

トリガー

アプリケーション接続を作成する

アプリケーション接続を作成する

アプリケーション接続を作成する

操作 ID:
createConnectionUsingPOST

アプリケーション接続を作成する

戻り値

Body
ConnectionNotificationDto

定義

ConnectionNotificationDto

名前 パス 型 説明
通知が適用される接続の ID
 connectionId integer

connectionId
entityType
 entityType string

entityType
entityId
 entityId integer

entityId
eventType
 eventType string

eventType

ConnectionDto

既存の接続を記述するデータ

名前 パス 型 説明
アプリケーションの ID
 appId integer

アプリケーションの ID
接続のアプリケーションの名前
 appName string

接続のアプリケーションの名前
エンティティの作成時刻。
 created string

エンティティの作成時刻。
エンティティの ID。
 id integer

エンティティの ID。
接続の名前
 name string

接続の名前
エンティティの最終更新時刻。
 updated string

エンティティの最終更新時刻。
''' POST https://your.webhook.url/path/somewhere Authorization: Bearer TOKEN のように呼び出される接続の Webhook { "connectionId": 0, "entityType": "properties|contacts|invoices|etc.", "entityId": 0, "eventType": "CREATE|UPDATE|DELETE" }''''
 webhookUrl string

次のように呼び出される接続の Webhook

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

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

ContactDetailsDto

連絡先の詳細

名前 パス 型 説明
連絡先の勤務先電話番号
 businessPhoneNumber array of string

連絡先の勤務先電話番号
連絡先の生年月日。
 dateOfBirth string

連絡先の生年月日。
連絡先のメール アドレス
 email array of string

連絡先のメール アドレス
連絡先の FAX 番号
 fax array of string

連絡先の FAX 番号
連絡先の携帯電話番号
 mobilePhoneNumber array of string

連絡先の携帯電話番号
連絡先のプライベート電話番号
 privatePhoneNumber array of string

連絡先のプライベート電話番号
取引レジスタ番号。
 tradeRegisterNumber string

取引レジスタ番号。
連絡先の VAT ID。
 vatId string

連絡先の VAT ID。
連絡先の Web サイト
 website array of string

連絡先の Web サイト

ContactDto

連絡先は、自然人または法人を表し、連絡方法を表します。 ID/会社は、複数の住所を持ち、その住所を通じて連絡を取る必要があります。 これらは 2 つの異なる連絡先として表されます。

名前 パス 型 説明
市区町村の名前。
 city string

市区町村の名前。
連絡先が会社の場合は、会社の名前。
 companyName string

連絡先が会社の場合は、会社の名前。
ISO 3166-1 alpha-2 標準に従った国コード。
 country string

ISO 3166-1 alpha-2 標準に従った国コード。
連絡先の作成時刻。
 created string

連絡先の作成時刻。
ContactDetailsDto
 details ContactDetailsDto

連絡先の詳細
連絡先が人の場合は、連絡先の名。
 firstName string

連絡先が人の場合は、連絡先の名。
連絡先インスタンスの ID。
 id integer

連絡先インスタンスの ID。
連絡先が人物の場合は、連絡先の姓。
 lastName string

連絡先が人物の場合は、連絡先の姓。
番地。
 number string

番地。
郵便番号。 電子ポスト経由で物理的な手紙の連絡先を必要とするすべての人に対して指定されていることを確認します。
 postalCode string

郵便番号。 電子ポスト経由で物理的な手紙の連絡先を必要とするすべての人に対して指定されていることを確認します。
連絡先の受信者名。
 recipientName string

連絡先の受信者名。
連絡先に対処するために使用される単語の標準的な数式。
 salutation string

連絡先に対処するために使用される単語の標準的な数式。
州名。都道府県、下位区分、または地域とも呼ばれます。
 state string

州名。都道府県、下位区分、または地域とも呼ばれます。
通りの名前。
 street string

通りの名前。
連絡先の役職。
 title string

連絡先の役職。
連絡先の最終更新時刻。
 updated string

連絡先の最終更新時刻。

ContactSimpleDto

連絡先の簡略化されたデータ構造。

名前 パス 型 説明
連絡先インスタンスの ID。
 id integer

連絡先インスタンスの ID。
連絡先の名前。 詳細については、ID 経由で連絡先を読み込みます。
 name string

連絡先の名前。 詳細については、ID 経由で連絡先を読み込みます。

ContractDto

コントラクト データ構造。

名前 パス 型 説明
コントラクトに関連付けられている連絡先の一覧。
 contacts array of ContactSimpleDto

コントラクトに関連付けられている連絡先の一覧。
コントラクトの番号。
 contractNumber string

コントラクトの番号。
コントラクトの作成時刻。
 created string

コントラクトの作成時刻。
契約の有効期間が終了する日付。 Null は時間の終わりとして解釈されます。
 endDate string

契約の有効期間が終了する日付。 Null は時間の終わりとして解釈されます。
コントラクト インスタンスの ID。
 id integer

コントラクト インスタンスの ID。
このコントラクトが空いている型コントラクトであるかどうかを示します。 現時点では、コントラクトが TENANT 型の場合にのみ true にすることができます。 空き契約とは、ユニットが貸し出されていないことを意味します。
isVacant boolean

このコントラクトが空いている型コントラクトであるかどうかを示します。 現時点では、コントラクトが TENANT 型の場合にのみ true にすることができます。 空き契約とは、ユニットが貸し出されていないことを意味します。
単位キーと郵送先の名前で構成されるコントラクトの名前。
 name string

単位キーと郵送先の名前で構成されるコントラクトの名前。
コントラクトが属するプロパティ インスタンスの ID。
 propertyId integer

コントラクトが属するプロパティ インスタンスの ID。
契約の有効期間の開始日。 Null は時間の始まりとして解釈されます。
 startDate string

契約の有効期間の開始日。 Null は時間の始まりとして解釈されます。
コントラクトの型。 1. 所有者 - そのようなタイプの契約は、ユニットの所有権を証明します。 2. テナント - そのようなタイプの契約はユニットを借りている。 3. PROPERTY_OWNER - そのようなタイプの契約は、プロパティの所有権を証明します。
 type string

コントラクトの型。

  1. OWNER - このような型のコントラクトは、ユニットの所有権を証明します。
  2. TENANT - そのようなタイプの契約がユニットを借りている。
  3. PROPERTY_OWNER - このような型のコントラクトは、プロパティの所有権を証明します。
コントラクトが属するユニット インスタンスの ID。
 unitId integer

コントラクトが属するユニット インスタンスの ID。
コントラクトの最終更新時刻。
 updated string

コントラクトの最終更新時刻。

DocumentDto

ドキュメント データ構造。

名前 パス 型 説明
ドキュメントに存在する合計金額。
 amount float

ドキュメントに存在する合計金額。
ドキュメントが属する建物の ID。
 buildingId integer

ドキュメントが属する建物の ID。
ドキュメントが属している連絡先の ID。
 contactId integer

ドキュメントが属している連絡先の ID。
ドキュメントが属するコントラクトの ID。
 contractId integer

ドキュメントが属するコントラクトの ID。
ドキュメントの作成時刻。
 created string

ドキュメントの作成時刻。
ドキュメント インスタンスの ID。
 id integer

ドキュメント インスタンスの ID。
ドキュメントの発行日。
 issuedDate string

ドキュメントの発行日。
ドキュメント インスタンスの名前。
 name string

ドキュメント インスタンスの名前。
ドキュメントが割り当てられているプロパティの人間が判読できる ID。
 propertyHrId string

ドキュメントが割り当てられているプロパティの人間が判読できる ID。
ドキュメントが属するプロパティの ID。
 propertyId integer

ドキュメントが属するプロパティの ID。
ドキュメントが割り当てられているプロパティの名前。
 propertyName string

ドキュメントが割り当てられているプロパティの名前。
ドキュメントが属するソース エンティティの ID。
 sourceId integer

ドキュメントが属するソース エンティティの ID。
ドキュメントのソースの種類。 ID と共に、ドキュメントの発信元または添付元の同じ名前のビジネス プロセスを識別します。 null である可能性があります。
 sourceType string

ドキュメントのソースの種類。 ID と共に、ドキュメントの発信元または添付元の同じ名前のビジネス プロセスを識別します。 null である可能性があります。
ドキュメントの状態。
 state string

ドキュメントの状態。
tags
 tags array of DocumentTagSimpleDto
ドキュメントが割り当てられているユニットの人間が判読できる ID。
 unitHrId string

ドキュメントが割り当てられているユニットの人間が判読できる ID。
ドキュメントが属する単位の ID。
 unitId integer

ドキュメントが属する単位の ID。
ドキュメントの最終更新時刻。
 updated string

ドキュメントの最終更新時刻。

DocumentTagDto

ドキュメント タグの Model クラス。

名前 パス 型 説明
ドキュメント タグの説明。
 description string

ドキュメント タグの説明。
ドキュメント タグの ID。
 id integer

ドキュメント タグの ID。
ドキュメント タグの名前。
 name string

ドキュメント タグの名前。

DocumentTagSimpleDto

ドキュメント タグの Model クラス。

名前 パス 型 説明
ドキュメント タグの一意識別子。
 id integer

ドキュメント タグの一意識別子。
ドキュメント タグの名前。
 name string

ドキュメント タグの名前。

ErrorCodeDetailsDto

名前 パス 型 説明
コード
 code string
説明
 description string

InvoiceDto

請求書データ構造。

名前 パス 型 説明
請求書に従って支払われる金額。
 amount float

請求書に従って支払われる金額。
請求書の対応する連絡先の ID。
 counterpartContactId integer

請求書の対応する連絡先の ID。
請求書の対応する連絡先の名前。
 counterpartContactName string

請求書の対応する連絡先の名前。
エンティティの作成時刻。
 created string

エンティティの作成時刻。
エンティティの ID。
 id integer

エンティティの ID。
請求書の発行日。
 issuedDate string

請求書の発行日。
items
 items array of InvoiceItemDto
請求書の名前。
 name string

請求書の名前。
対応する銀行口座の BIC 番号。
 orderCounterpartBic string

対応する銀行口座の BIC 番号。
対応する銀行口座の IBAN。
 orderCounterpartIban string

対応する銀行口座の IBAN。
銀行注文が実行のために表示される予約日の前または後の日数。
 orderDayOffset integer

銀行注文が実行のために表示される予約日の前または後の日数。
プロパティの銀行口座の一意識別子。
 orderPropertyBankAccountId integer

プロパティの銀行口座の一意識別子。
プロパティの銀行口座の BIC 番号。
 orderPropertyBic string

プロパティの銀行口座の BIC 番号。
不動産銀行口座の IBAN。
 orderPropertyIban string

不動産銀行口座の IBAN。
True の場合は、請求書の対応する順序があります。
 orderRequired boolean

True の場合は、請求書の対応する順序があります。
生成された順序のステートメント。
 orderStatement string

生成された順序のステートメント。
請求書が属するプロパティの人間が判読できる ID。
 propertyHrId string

請求書が属するプロパティの人間が判読できる ID。
請求書が属するプロパティの ID。
 propertyId integer

請求書が属するプロパティの ID。
請求書が属するプロパティの名前。
 propertyName string

請求書が属するプロパティの名前。
請求書の状態。 使用可能な値: 1. 下書き - 請求書が作成されましたが、不完全です。 2. 準備完了 - 請求書を予約する準備ができました。 3. 予約済み - 請求書が予約済み。 4. SCHEDULED - 定期的な請求書にのみ適用されます。 5. 逆引き - 請求書によって生成されたすべての予約が取り消されました。
 state string

請求書の状態。 使用可能な値:

  1. 下書き - 請求書が作成されましたが、不完全です。
  2. 準備完了 - 請求書を予約する準備ができました。
  3. 予約済み - 請求書が予約されました。
  4. SCHEDULED - 定期的な請求書にのみ適用されます。
  5. REVERSED - 請求書によって生成されたすべての予約が取り消されました。
エンティティの最終更新時刻。
 updated string

エンティティの最終更新時刻。

InvoiceItemDto

名前 パス 型 説明
予約アイテムのアカウント コード。
 accountCode string

予約アイテムのアカウント コード。
予約アイテムのアカウント ID。
 accountId integer

予約アイテムのアカウント ID。
予約アイテムのアカウント名。
 accountName string

予約アイテムのアカウント名。
予約明細に対応する金額。
 amount float

予約明細に対応する金額。
予約アイテムの予約テキスト。
 bookingText string

予約アイテムの予約テキスト。
請求書明細の作成時刻。
 created string

請求書明細の作成時刻。
予約アイテムの一意識別子。
 id integer

予約アイテムの一意識別子。
売上税法に基づいた売上税申告に関連する金額: [Einkommenstueregesetz EStG 35a](https://www.gesetze-im-internet.de/estg/__35a.html).
 laborCostAmount float

売上税法に従った売上税申告に関連する金額: Einkommenstueregesetz EStG 35a。
選択した種類に応じて:金額のパーセンテージは、売上税法に従って複数の報告書の35a付属書に報告されます: [Einkommenstueregesetz EStG 35a](https://www.gesetze-im-internet.de/estg/__35a.html). 例: Housemoney Settlement (Hausgeldabrechnung) または 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

選択した種類に応じて:金額のパーセンテージは、所得税法に従って複数の報告書の35a付属書に報告されます: Einkommenstueregesetz EStG 35a.

例: Housemoney Settlement (Hausgeldabrechnung) または 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
請求書アイテムの最終更新時刻。
 updated string

請求書アイテムの最終更新時刻。
予約アイテムの対応する VAT 金額。
 vatAmount float

予約アイテムの対応する VAT 金額。
合計金額の VAT 金額の対応する VAT の割合。
 vatPercentage float

合計金額の VAT 金額の対応する VAT の割合。

PageOfContactDto

名前 パス 型 説明
コンテンツ
 content array of ContactDto
empty
 empty boolean
first
 first boolean
last
 last boolean
数値
 number integer
numberOfElements
 numberOfElements integer
ページング可能
 pageable Pageable
size
 size integer
ソート
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

PageOfContractDto

名前 パス 型 説明
コンテンツ
 content array of ContractDto
empty
 empty boolean
first
 first boolean
last
 last boolean
数値
 number integer
numberOfElements
 numberOfElements integer
ページング可能
 pageable Pageable
size
 size integer
ソート
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

PageOfDocumentDto

名前 パス 型 説明
コンテンツ
 content array of DocumentDto
empty
 empty boolean
first
 first boolean
last
 last boolean
数値
 number integer
numberOfElements
 numberOfElements integer
ページング可能
 pageable Pageable
size
 size integer
ソート
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

PageOfInvoiceDto

名前 パス 型 説明
コンテンツ
 content array of InvoiceDto
empty
 empty boolean
first
 first boolean
last
 last boolean
数値
 number integer
numberOfElements
 numberOfElements integer
ページング可能
 pageable Pageable
size
 size integer
ソート
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

PageOfPropertyDto

名前 パス 型 説明
コンテンツ
 content array of PropertyDto
empty
 empty boolean
first
 first boolean
last
 last boolean
数値
 number integer
numberOfElements
 numberOfElements integer
ページング可能
 pageable Pageable
size
 size integer
ソート
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

PageOfUnitDto

名前 パス 型 説明
コンテンツ
 content array of UnitDto
empty
 empty boolean
first
 first boolean
last
 last boolean
数値
 number integer
numberOfElements
 numberOfElements integer
ページング可能
 pageable Pageable
size
 size integer
ソート
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

ページング可能

名前 パス 型 説明
オフセット
 offset integer
pageNumber
 pageNumber integer
pageSize
 pageSize integer
ページ
 paged boolean
ソート
 sort Sort
unpaged
 unpaged boolean

PropertyDto

プロパティ データ構造。

名前 パス 型 説明
プロパティ インスタンスの作成時刻。
 created string

プロパティ インスタンスの作成時刻。
プロパティ インスタンスの ID。
 id integer

プロパティ インスタンスの ID。
プロパティ インスタンスの名前。
 name string

プロパティ インスタンスの名前。
プロパティ インスタンスの人間が判読できる ID。
 propertyHrId string

プロパティ インスタンスの人間が判読できる ID。
プロパティの現在の状態。 1. 下書き - プロパティはまだアクティブ化されていないため、予約/銀行注文/レポートを生成できません。 2. 準備完了 - プロパティがアクティブ化されており、予約/銀行注文/レポートの生成に使用できます。 3. 無効 - プロパティが非アクティブ化され、予約/銀行注文/レポートを生成できなくなりました。
state string

プロパティの現在の状態。

  1. DRAFT - プロパティはまだアクティブ化されていないため、予約/銀行注文/レポートを生成できません。
  2. READY - プロパティがアクティブ化されており、予約/銀行注文/レポートの生成に使用できます。
  3. DISABLED - プロパティが非アクティブ化され、予約/銀行注文/レポートを生成できなくなりました。
プロパティの管理の種類。 OWNER - Home Owner Association。 RENTAL - テナント管理。
 type string

プロパティの管理の種類。 OWNER - Home Owner Association。 RENTAL - テナント管理。
プロパティ インスタンスの更新時刻。
 updated string

プロパティ インスタンスの更新時刻。

ソート

名前 パス 型 説明
empty
 empty boolean
ソート
 sorted boolean
未整理
 unsorted boolean

UnitDto

単位データ構造。

名前 パス 型 説明
ユニット インスタンスの作成時間。
 created string

ユニット インスタンスの作成時間。
ユニットが配置されている床。
 floor string

ユニットが配置されている床。
ユニット インスタンスの ID。
 id integer

ユニット インスタンスの ID。
床の内部の単位の位置。
 position string

床の内部の単位の位置。
ユニットが属するプロパティ インスタンスの ID。
 propertyId integer

ユニットが属するプロパティ インスタンスの ID。
単位が使用される目的。アパートメント - 住宅目的で使用されるユニット。 駐車場 - 駐車目的で使用されるユニット。 商用 - ビジネス/商業目的で使用される単位。 OTHER - 他の目的で使用される単位。
 type string

単位が使用される目的。アパートメント - 住宅目的で使用されるユニット。 駐車場 - 駐車目的で使用されるユニット。 商用 - ビジネス/商業目的で使用される単位。 OTHER - 他の目的で使用される単位。
ユニット インスタンスの人間が判読できる ID。
 unitHrId string

ユニット インスタンスの人間が判読できる ID。
ランクは、UI/レポートでの単位の表示順序を定義します。 ユーザーは UI で更新できます。
 unitRank integer

ランクは、UI/レポートでの単位の表示順序を定義します。 ユーザーは UI で更新できます。
ユニット インスタンスの更新時刻。
 updated string

ユニット インスタンスの更新時刻。

LegacyInvoiceDto

名前 パス 型 説明
対応する BIC
 counterpartBic string

対応する BIC
ContactID に対応する
 counterpartContactId integer

ContactID に対応する
IBAN に対応する
 counterpartIban string

IBAN に対応する
対応
 counterpartName string

対応
日付
 created string

日付
請求書の URL
 documentUrl string

請求書の URL
ID
 id integer

ID
請求書の日付
 invoiceDate string

請求書の日付
請求書 ID
 invoiceHrId string

請求書 ID
請求書番号
 invoiceNumber string

請求書番号
支払い対象日
 paymentTargetDate string

支払い対象日
支払いの種類
 paymentType string

支払いの種類
プロパティ NR
 propertyHrId string

プロパティ NR
プロパティ ID
 propertyId integer

プロパティ ID
プロパティの内部 ID
 propertyIdInternal string

プロパティの内部 ID
プロパティ名
 propertyName string

プロパティ名
Reference Nr
 refNr string

Reference Nr
請求書の状態
 state string

請求書の状態
Total Gross
 totalGross float

Total Gross
Total Net
 totalNet float

Total Net
VAT を含む。
 vatIncluded boolean

VAT を含む。
VAT の割合
 vatPercentage float

VAT の割合

ファイル

これは基本的なデータ型 'file' です。