Impower ERP (プレビュー)
不動産管理者向け会計システム impower.de との連動が可能です
このコネクタは、次の製品および地域で利用可能です:
サービス | クラス | 地域 |
---|---|---|
Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
お問い合わせ先 | |
---|---|
件名 | Api サポート |
[URL] | https://impower.de |
メール | support+api@impower.de |
Connector Metadata | |
---|---|
発行者 | Impower GmbH |
Web サイト | https://www.impower.de |
プライバシー ポリシー | https://www.impower.de/datenschutzerklaerung |
カテゴリー | ビジネス管理;財務 |
Impower コネクタを使用すると、プロパティ、ユニット、契約、連絡先などのマスターデータセットにアクセスできます。 さらに、書類や請求書をアップロードすることもできます。 スケジュールに基づいて、または統合されたトリガーを使用して Webhook を登録することによって、データを読み取ることができます。
前提条件
Impower を使用するには、以下が必要です:
- 有料の Impower サブスクリプション
- Powerautomate Premium サブスクリプション
資格情報の入手方法
powerautomate に接続するドメインの APIKey を取得するには、support@impower.de にリクエストを書いてください。
コネクタの使用を開始する
構築を検討できるシナリオは次のとおりです。
- Sharepoint/Onedrive フォルダーの変更を監視し、新しい PDF ファイルが表示された場合は、impower にアップロードします
- 連絡先リストをチームのアドレス帳と同期する
既知の問題と制限事項
ファイルのダウンロード/アップロード
このファイルはバイナリ形式のマルチパート フォーム データとしてアップロードされます。 ダウンロードについても同様です。ファイルは、http 標準と同様に、ヘッダーに推奨されるファイル名を付けてそのまま提供されます
レート制限
1 分あたり 5000 リクエストを超えないようにしてください。 システムがユーザーに迅速にサービスを提供できるように、API にレート制限を課しています
接続を作成する
このコネクタは、次の認証タイプをサポートしています:
既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 Power App が別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
件名 | タイプ | Description | Required |
---|---|---|---|
API キー | securestring | この API の API キー | True |
調整制限
名前 | 呼び出し | 更新期間 |
---|---|---|
接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
(レガシ) 請求書のアップロード |
レガシ API を使用して PDF ファイルを Impower にアップロードします。 代わりに uploadInvoiceUsingPOST 操作を使用してください。 |
つながりの削除 |
つながりの削除 |
ドキュメント タグの取得 |
標準とドメイン固有のドキュメント タグがレスポンスとして返されます |
レガシー請求書の詳細 |
レガシー API 経由で Impower から請求書の詳細を取得します。 代わりに getInvoiceByIdUsingGET を使用してください。 |
与えられた id に基づいて既存のドキュメント タグを削除する |
システムで生成されたタグは削除できません |
与えられた id に基づいて既存のドキュメント タグを更新する |
更新されたドキュメント タグがレスポンスとして返されます |
与えられた id に基づいて既存のドキュメントを削除する |
システムで生成されたドキュメントは削除できません |
与えられたファイルに基づいて新しいドキュメントを作成します |
新しく作成されたドキュメントがレスポンスとして返されます |
与えられたフィルター パラメーターでドキュメントを取得します |
与えられたフィルター パラメーターでドキュメントを取得する |
与えられたフィルター パラメーターでプロパティを取得します |
与えられたフィルター パラメーターでプロパティを取得する |
与えられたフィルター パラメーターで請求書を取得する |
与えられたフィルター パラメーターで請求書を取得する |
与えられたフィルター パラメーターで連絡先を取得する |
与えられたフィルター パラメーターで連絡先を取得する |
与えられたフィルター パラメーターで連絡先を取得する |
与えられたフィルター パラメーターで連絡先を取得する |
与えられた要求本文に基づいて既存のドキュメント タグを更新する |
必要な情報はすべて要求本文にあります |
定義済みのエラーコード値をすべて取得する |
定義済みのすべてのエラーコードのリストを返します |
指定された ID で単一のドキュメントをダウンロードする |
文書のフォーマットは MIME タイプによって定義されます |
指定されたフィルター パラメーターですべてのユニットを取得します |
指定されたフィルター条件を満たすすべてのユニットを返します |
指定されたフィルター条件で複数のドキュメントをダウンロードする |
ドキュメントは ZIP 形式で提供されます |
指定された請求書予約品目の予約テキストを更新する |
予約テキストの更新 |
指定した id でプロパティを取得する |
指定した id でプロパティを取得する |
指定した id でユニットを取得する |
指定された ID を持つユニットを返す |
指定した id で請求書を取得する |
指定した ID で請求書を取得する |
指定した id で連絡先を取得する |
指定した id で連絡先を検索する |
指定した id で連絡先を取得する |
指定した id で連絡先を検索する |
接続を更新する |
接続を更新する |
接続を読み取る |
接続を読み取る |
提供されたフィールドに基づいて請求書を更新する |
請求書の更新 |
新しいドキュメント タグを作成する |
新しく作成されたドキュメント タグがレスポンスとして返されます |
特定のエラーコードの詳細の取得 |
特定のエラーコードの説明を取得します |
請求書 PDF ドキュメントのアップロード |
規定では、文書は OCR 分析にかけられます |
(レガシ) 請求書のアップロード
レガシ API を使用して PDF ファイルを Impower にアップロードします。 代わりに uploadInvoiceUsingPOST 操作を使用してください。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
アップロードする PDF ファイルを指定する
|
file | True | file |
アップロードする PDF ファイルを指定する |
戻り値
- LegacyInvoiceDto
- LegacyInvoiceDto
つながりの削除
つながりの削除
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
接続の ID
|
connectionIdX | True | integer |
接続の ID |
ドキュメント タグの取得
標準とドメイン固有のドキュメント タグがレスポンスとして返されます
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
名前と説明に適用される検索文字列
|
description | string |
名前と説明に適用される検索文字列 |
戻り値
レガシー請求書の詳細
レガシー API 経由で Impower から請求書の詳細を取得します。 代わりに getInvoiceByIdUsingGET を使用してください。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Invoice ID
|
invoiceId | True | integer |
詳細の請求書 ID を指定する |
戻り値
- LegacyInvoiceDto
- LegacyInvoiceDto
与えられた id に基づいて既存のドキュメント タグを削除する
システムで生成されたタグは削除できません
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
削除するドキュメント タグの一意な識別子
|
tagId | True | integer |
削除するドキュメント タグの一意な識別子 |
与えられた id に基づいて既存のドキュメント タグを更新する
更新されたドキュメント タグがレスポンスとして返されます
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ドキュメント タグの一意の識別子
|
tagId | True | integer |
ドキュメント タグの一意の識別子 |
ドキュメント タグの新しい説明です。
|
description | string |
ドキュメント タグの新しい説明です。 |
|
ドキュメント タグの新しい名前です。
|
name | string |
ドキュメント タグの新しい名前です。 |
戻り値
ドキュメント タグのモデル クラスです。
- DocumentTagDto
- DocumentTagDto
与えられた id に基づいて既存のドキュメントを削除する
システムで生成されたドキュメントは削除できません
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
documentId
|
documentId | True | integer |
documentId |
与えられたファイルに基づいて新しいドキュメントを作成します
新しく作成されたドキュメントがレスポンスとして返されます
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
アップロードする PDF ファイル
|
file | True | file |
アップロードする PDF ファイル |
戻り値
ドキュメント データーの構造。
- DocumentDto
- DocumentDto
与えられたフィルター パラメーターでドキュメントを取得します
与えられたフィルター パラメーターでドキュメントを取得する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロパティの担当者名
|
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 |
ドキュメントが属するプロパティの名前。 |
|
単一のページで返される項目の数
|
size | integer |
単一のページで返される項目の数 |
|
パラメーターの並べ替え
|
sort | string |
パラメーターの並べ替え |
|
ドキュメントが属するソース エンティティの ID。
|
sourceId | integer |
ドキュメントが属するソース エンティティの ID。 |
|
ドキュメントのソースの種類。
|
sourceType | array |
ドキュメントのソースの種類。 |
|
ドキュメントが関連付けられているタグの ID。
|
tagIds | array |
ドキュメントが関連付けられているタグの ID。 |
|
ドキュメントが関連付けられているタグの類似名。
|
tagName | string |
ドキュメントが関連付けられているタグの類似名。 |
|
ドキュメントが属するユニット エンティティの ID。
|
unitId | integer |
ドキュメントが属するユニット エンティティの ID。 |
戻り値
- PageOfDocumentDto
- PageOfDocumentDto
与えられたフィルター パラメーターでプロパティを取得します
与えられたフィルター パラメーターでプロパティを取得する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロパティの名前。
|
name | string |
プロパティの名前。 |
|
並べ替え方向。 有効な値: ASC、DESC
|
order | string |
並べ替え方向。 有効な値: ASC、DESC |
|
返されるページ番号
|
page | integer |
返されるページ番号 |
|
プロパティの読み取り可能な ID です。
|
propertyHrId | string |
プロパティの読み取り可能な ID です。 |
|
単一のページで返される項目の数
|
size | integer |
単一のページで返される項目の数 |
|
パラメーターの並べ替え
|
sort | string |
パラメーターの並べ替え |
戻り値
- PageOfPropertyDto
- PageOfPropertyDto
与えられたフィルター パラメーターで請求書を取得する
与えられたフィルター パラメーターで請求書を取得する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
取引先担当者の一意識別子
|
counterpartContactId | integer |
取引先担当者の一意識別子 |
|
検索する請求書の日付
|
issuedDate | string |
検索する請求書の日付 |
|
並べ替え方向。 有効な値: ASC、DESC
|
order | string |
並べ替え方向。 有効な値: ASC、DESC |
|
返されるページ番号
|
page | integer |
返されるページ番号 |
|
請求書が属するプロパティの一意識別子
|
propertyId | integer |
請求書が属するプロパティの一意識別子 |
|
単一のページで返される項目の数
|
size | integer |
単一のページで返される項目の数 |
|
パラメーターの並べ替え
|
sort | string |
パラメーターの並べ替え |
|
検索される請求書の状態
|
states | array |
検索される請求書の状態 |
戻り値
- PageOfInvoiceDto
- PageOfInvoiceDto
与えられたフィルター パラメーターで連絡先を取得する
与えられたフィルター パラメーターで連絡先を取得する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
連絡先をフィルターするための連絡先 ID のリスト。
|
contactIds | array |
連絡先をフィルターするための連絡先 ID のリスト。 |
|
取引先担当者のメール アドレスです。
|
string |
取引先担当者のメール アドレスです。 |
||
連絡先の名前です。 名、姓、または会社名である可能性があります。
|
name | string |
連絡先の名前です。 名、姓、または会社名である可能性があります。 |
|
並べ替え方向。 有効な値: ASC、DESC
|
order | string |
並べ替え方向。 有効な値: ASC、DESC |
|
返されるページ番号
|
page | integer |
返されるページ番号 |
|
単一のページで返される項目の数
|
size | integer |
単一のページで返される項目の数 |
|
パラメーターの並べ替え
|
sort | string |
パラメーターの並べ替え |
戻り値
- PageOfContactDto
- PageOfContactDto
与えられたフィルター パラメーターで連絡先を取得する
与えられたフィルター パラメーターで連絡先を取得する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
契約が関連付けられている連絡先の ID。
|
contactId | integer |
契約が関連付けられている連絡先の ID。 |
|
連絡先をフィルターする連絡先 ID のリストです。
|
contractIds | array |
連絡先をフィルターする連絡先 ID のリストです。 |
|
並べ替え方向。 有効な値: ASC、DESC
|
order | string |
並べ替え方向。 有効な値: ASC、DESC |
|
返されるページ番号
|
page | integer |
返されるページ番号 |
|
契約が属するプロパティ インスタンスの ID です。
|
propertyId | integer |
契約が属するプロパティ インスタンスの ID です。 |
|
単一のページで返される項目の数
|
size | integer |
単一のページで返される項目の数 |
|
パラメーターの並べ替え
|
sort | string |
パラメーターの並べ替え |
|
契約の種類です。 オプション: OWNER | TENANT | PROPERTY_OWNER
|
type | array |
契約の種類です。 オプション: OWNER | TENANT | PROPERTY_OWNER |
|
契約が関連付けられているユニット インスタンスの ID です。
|
unitId | integer |
契約が関連付けられているユニット インスタンスの ID です。 |
|
日付時点で有効な契約書を返します。 Null は時間の開始/終了として解釈されます。
|
validAtDate | string |
日付時点で有効な契約書を返します。 Null は時間の開始/終了として解釈されます。 |
戻り値
- PageOfContractDto
- PageOfContractDto
与えられた要求本文に基づいて既存のドキュメント タグを更新する
必要な情報はすべて要求本文にあります
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
更新するドキュメント金額の新しい値
|
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 |
ドキュメントを割り当てる新しいユニット |
戻り値
定義済みのエラーコード値をすべて取得する
定義済みのすべてのエラーコードのリストを返します
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
|
array of string |
指定された ID で単一のドキュメントをダウンロードする
文書のフォーマットは MIME タイプによって定義されます
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ドキュメントの一意の識別子
|
documentId | True | integer |
ドキュメントの一意の識別子 |
戻り値
- 返答
- file
指定されたフィルター パラメーターですべてのユニットを取得します
指定されたフィルター条件を満たすすべてのユニットを返します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
並べ替え方向。 有効な値: ASC、DESC
|
order | string |
並べ替え方向。 有効な値: ASC、DESC |
|
返されるページ番号
|
page | integer |
返されるページ番号 |
|
ユニットが属するプロパティの一意の識別子
|
propertyId | integer |
ユニットが属するプロパティの一意の識別子 |
|
単一のページで返される項目の数
|
size | integer |
単一のページで返される項目の数 |
|
パラメーターの並べ替え
|
sort | string |
パラメーターの並べ替え |
戻り値
- PageOfUnitDto
- PageOfUnitDto
指定されたフィルター条件で複数のドキュメントをダウンロードする
ドキュメントは 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。 |
戻り値
- 返答
- file
指定された請求書予約品目の予約テキストを更新する
予約テキストの更新
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
請求書予約品目の一意の ID
|
invoiceItemId | True | integer |
請求書予約品目の一意の ID |
請求書の品目の予約テキストです。
|
bookingText | string |
請求書の品目の予約テキストです。 |
戻り値
- InvoiceItemDto
- InvoiceItemDto
指定した id でプロパティを取得する
指定した id でプロパティを取得する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロパティの一意識別子
|
propertyId | True | integer |
プロパティの一意識別子 |
戻り値
プロパティのデータ構造。
- PropertyDto
- PropertyDto
指定した id でユニットを取得する
指定された ID を持つユニットを返す
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ユニットの固有の ID
|
unitId | True | integer |
ユニットの固有の ID |
戻り値
ユニット データ構造。
- UnitDto
- UnitDto
指定した id で請求書を取得する
指定した ID で請求書を取得する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
請求書を表す一意識別子
|
invoiceId | True | integer |
請求書を表す一意識別子 |
戻り値
請求書のデータ構造。
- InvoiceDto
- InvoiceDto
指定した id で連絡先を取得する
指定した id で連絡先を検索する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
連絡先を表す一意の識別子
|
contactId | True | integer |
連絡先を表す一意の識別子 |
戻り値
連絡先は、自然人または法人を表し、その連絡方法を示します。 個人または企業は、連絡を取るために複数の郵便住所を持つ必要がありますか? これらは 2 つの異なる連絡先として表されます。
- ContactDto
- ContactDto
指定した id で連絡先を取得する
指定した id で連絡先を検索する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
契約を表す一意識別子
|
contractId | True | integer |
契約を表す一意識別子 |
戻り値
契約のデータ構造。
- ContractDto
- ContractDto
接続を更新する
接続を更新する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
接続の 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
|
connectionIdX | True | integer |
接続の ID |
戻り値
既存の接続を記述するデータ
- ConnectionDto
- ConnectionDto
提供されたフィールドに基づいて請求書を更新する
請求書の更新
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
請求書を表す一意の識別子
|
invoiceId | True | integer |
請求書を表す一意の識別子 |
請求書の新しい発行日です。
|
issuedDate | string |
請求書の新しい発行日です。 |
|
請求書の新しい名前です。
|
name | string |
請求書の新しい名前です。 |
戻り値
請求書のデータ構造。
- InvoiceDto
- InvoiceDto
新しいドキュメント タグを作成する
新しく作成されたドキュメント タグがレスポンスとして返されます
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
新しく作成されたドキュメント タグの説明です。
|
description | string |
新しく作成されたドキュメント タグの説明です。 |
|
新しく作成されたドキュメント タグの名前です。
|
name | string |
新しく作成されたドキュメント タグの名前です。 |
戻り値
ドキュメント タグのモデル クラスです。
- DocumentTagDto
- DocumentTagDto
特定のエラーコードの詳細の取得
特定のエラーコードの説明を取得します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
価値
|
value | True | string |
価値 |
戻り値
- ErrorCodeDetailsDto
- ErrorCodeDetailsDto
請求書 PDF ドキュメントのアップロード
規定では、文書は OCR 分析にかけられます
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
請求書の PDF ファイル
|
file | True | file |
請求書の PDF ファイル |
戻り値
請求書のデータ構造。
- InvoiceDto
- InvoiceDto
トリガー
アプリケーション接続の作成 |
アプリケーション接続の作成 |
アプリケーション接続の作成
定義
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 |
エンティティの最終更新日時です。 |
次のように呼び出される接続の Webhook
```
POST https://your.webhook.url/path/somewhere
Authorization: Bearer TOKEN
{
"connectionId": 0,
"entityType": "properties|contacts|invoices|etc.",
"entityId": 0,
"eventType": "CREATE|UPDATE|DELETE"
}```
|
webhookUrl | string |
次のように呼び出される接続の Webhook
|
ContactDetailsDto
取引先担当者の詳細
名前 | パス | 型 | 説明 |
---|---|---|---|
取引先企業の電話番号
|
businessPhoneNumber | array of string |
取引先企業の電話番号 |
取引先担当者の生年月日です。
|
dateOfBirth | string |
取引先担当者の生年月日です。 |
取引先担当者の電子メール アドレス
|
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
連絡先は、自然人または法人を表し、その連絡方法を示します。 個人または企業は、連絡を取るために複数の郵便住所を持つ必要がありますか? これらは 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 |
番地。 |
郵便番号です。 e-post で物理的な書簡の取引先担当者が必要な場合は、必ず指定してください。
|
postalCode | string |
郵便番号です。 e-post で物理的な書簡の取引先担当者が必要な場合は、必ず指定してください。 |
受信者の氏名です。
|
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. プロパティ所有者 - このタイプの契約は、プロパティの所有権を証明します。
|
type | string |
契約の種類です。
|
契約が属するユニット インスタンスの 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
ドキュメント タグのモデル クラスです。
名前 | パス | 型 | 説明 |
---|---|---|---|
ドキュメントの説明タグです。
|
description | string |
ドキュメントの説明タグです。 |
ドキュメント タグの ID です。
|
id | integer |
ドキュメント タグの ID です。 |
ドキュメント タグの名前です。
|
name | string |
ドキュメント タグの名前です。 |
DocumentTagSimpleDto
ドキュメント タグのモデル クラスです。
名前 | パス | 型 | 説明 |
---|---|---|---|
ドキュメント タグの一意識別子です。
|
id | integer |
ドキュメント タグの一意識別子です。 |
ドキュメント タグの名前です。
|
name | string |
ドキュメント タグの名前です。 |
ErrorCodeDetailsDto
名前 | パス | 型 | 説明 |
---|---|---|---|
code
|
code | string | |
プロパティ
|
description | string |
InvoiceDto
請求書のデータ構造。
名前 | パス | 型 | 説明 |
---|---|---|---|
請求書に基づく支払金額です。
|
amount | float |
請求書に基づく支払金額です。 |
請求書の先方担当者の ID です。
|
counterpartContactId | integer |
請求書の先方担当者の ID です。 |
請求書の先方担当者の名前です。
|
counterpartContactName | string |
請求書の先方担当者の名前です。 |
エンティティの作成時間です。
|
created | string |
エンティティの作成時間です。 |
エンティティの ID。
|
id | integer |
エンティティの ID。 |
請求書の発行日です。
|
issuedDate | string |
請求書の発行日です。 |
アイテム
|
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. スケジュール済み - 定期的な請求書にのみ適用されます。
5. 取り消し済み - 請求書によって生成されたすべての予約が取り消されました。
|
state | string |
請求書の状態です。 有効な値:
|
エンティティの最終更新日時です。
|
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)。
例: 住宅資金決済 (Hausgeldabrechnung) または Opscost レポート (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。 例: 住宅資金決済 (Hausgeldabrechnung) または Opscost レポート (Nebenkostenabrechnung)。
|
請求書品目の最終更新時刻です。
|
updated | string |
請求書品目の最終更新時刻です。 |
予約品目に対応する付加価値税額です。
|
vatAmount | float |
予約品目に対応する付加価値税額です。 |
合計金額に対する付加価値税の割合です。
|
vatPercentage | float |
合計金額に対する付加価値税の割合です。 |
PageOfContactDto
名前 | パス | 型 | 説明 |
---|---|---|---|
コンテント
|
content | array of ContactDto | |
空
|
empty | boolean | |
first
|
first | boolean | |
最後
|
last | boolean | |
number
|
number | integer | |
numberOfElements
|
numberOfElements | integer | |
Pageable
|
pageable | Pageable | |
size
|
size | integer | |
並び替え
|
sort | Sort | |
totalElements
|
totalElements | integer | |
totalPages
|
totalPages | integer |
PageOfContractDto
名前 | パス | 型 | 説明 |
---|---|---|---|
コンテント
|
content | array of ContractDto | |
空
|
empty | boolean | |
first
|
first | boolean | |
最後
|
last | boolean | |
number
|
number | integer | |
numberOfElements
|
numberOfElements | integer | |
Pageable
|
pageable | Pageable | |
size
|
size | integer | |
並び替え
|
sort | Sort | |
totalElements
|
totalElements | integer | |
totalPages
|
totalPages | integer |
PageOfDocumentDto
名前 | パス | 型 | 説明 |
---|---|---|---|
コンテント
|
content | array of DocumentDto | |
空
|
empty | boolean | |
first
|
first | boolean | |
最後
|
last | boolean | |
number
|
number | integer | |
numberOfElements
|
numberOfElements | integer | |
Pageable
|
pageable | Pageable | |
size
|
size | integer | |
並び替え
|
sort | Sort | |
totalElements
|
totalElements | integer | |
totalPages
|
totalPages | integer |
PageOfInvoiceDto
名前 | パス | 型 | 説明 |
---|---|---|---|
コンテント
|
content | array of InvoiceDto | |
空
|
empty | boolean | |
first
|
first | boolean | |
最後
|
last | boolean | |
number
|
number | integer | |
numberOfElements
|
numberOfElements | integer | |
Pageable
|
pageable | Pageable | |
size
|
size | integer | |
並び替え
|
sort | Sort | |
totalElements
|
totalElements | integer | |
totalPages
|
totalPages | integer |
PageOfPropertyDto
名前 | パス | 型 | 説明 |
---|---|---|---|
コンテント
|
content | array of PropertyDto | |
空
|
empty | boolean | |
first
|
first | boolean | |
最後
|
last | boolean | |
number
|
number | integer | |
numberOfElements
|
numberOfElements | integer | |
Pageable
|
pageable | Pageable | |
size
|
size | integer | |
並び替え
|
sort | Sort | |
totalElements
|
totalElements | integer | |
totalPages
|
totalPages | integer |
PageOfUnitDto
名前 | パス | 型 | 説明 |
---|---|---|---|
コンテント
|
content | array of UnitDto | |
空
|
empty | boolean | |
first
|
first | boolean | |
最後
|
last | boolean | |
number
|
number | integer | |
numberOfElements
|
numberOfElements | integer | |
Pageable
|
pageable | Pageable | |
size
|
size | integer | |
並び替え
|
sort | Sort | |
totalElements
|
totalElements | integer | |
totalPages
|
totalPages | integer |
Pageable
名前 | パス | 型 | 説明 |
---|---|---|---|
offset
|
offset | integer | |
pageNumber
|
pageNumber | integer | |
pageSize
|
pageSize | integer | |
paged
|
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 |
プロパティの現在の状態です。
|
プロパティの管理タイプです。 所有者 - 住宅所有者協会。 レンタル - テナント管理。
|
type | string |
プロパティの管理タイプです。 所有者 - 住宅所有者協会。 レンタル - テナント管理。 |
プロパティ インスタンスの更新時刻です。
|
updated | string |
プロパティ インスタンスの更新時刻です。 |
並び替え
名前 | パス | 型 | 説明 |
---|---|---|---|
空
|
empty | boolean | |
並べ替え済み
|
sorted | boolean | |
並べ替えられていない
|
unsorted | boolean |
UnitDto
ユニット データ構造。
名前 | パス | 型 | 説明 |
---|---|---|---|
ユニット インスタンスの作成時刻です。
|
created | string |
ユニット インスタンスの作成時刻です。 |
ユニットが設置されている階数です。
|
floor | string |
ユニットが設置されている階数です。 |
ユニット インスタンスの ID です。
|
id | integer |
ユニット インスタンスの ID です。 |
フロア内のユニットの位置です。
|
position | string |
フロア内のユニットの位置です。 |
ユニットが属するプロパティのインスタンス ID です。
|
propertyId | integer |
ユニットが属するプロパティのインスタンス ID です。 |
ユニットの使用目的がアパートメントである - 居住目的で使用されるユニットです。 駐車 - 駐車目的で使用されるユニットです。 商用 - ビジネス/商業目的で使用されるユニットです。 その他 - その他の目的で使用されるユニットです。
|
type | string |
ユニットの使用目的がアパートメントである - 居住目的で使用されるユニットです。 駐車 - 駐車目的で使用されるユニットです。 商用 - ビジネス/商業目的で使用されるユニットです。 その他 - その他の目的で使用されるユニットです。 |
ユニット インスタンスの読み取り可能な 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 |
請求書の日付 |
Invoice ID
|
invoiceHrId | string |
Invoice ID |
Invoice Number
|
invoiceNumber | string |
Invoice Number |
支払の目標の期限
|
paymentTargetDate | string |
支払の目標の期限 |
支払いタイプ
|
paymentType | string |
支払いタイプ |
プロパティ NR
|
propertyHrId | string |
プロパティ NR |
プロパティ ID
|
propertyId | integer |
プロパティ ID |
プロパティ 内部 ID
|
propertyIdInternal | string |
プロパティ 内部 ID |
プロパティ名
|
propertyName | string |
プロパティ名 |
参照 Nr
|
refNr | string |
参照 Nr |
請求書の状態
|
state | string |
請求書の状態 |
総合計
|
totalGross | float |
総合計 |
総正価
|
totalNet | float |
総正価 |
VAT 含める
|
vatIncluded | boolean |
VAT 含める |
VAT 税率
|
vatPercentage | float |
VAT 税率 |
file
これは基本的なデータ型 'ファイル' です。