Impower ERP (預覽版)
允許物業經理與 impower.de 會計系統互動
此連接器適用於以下產品和區域:
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure Government 區域 - Azure 中國區域 - 美國國防部 (DoD) |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| Power Automate(自動化服務) | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 連絡人 | |
|---|---|
| 名稱 | API 支援 |
| URL | https://impower.de |
| support+api@impower.de |
| 連接器中繼資料 | |
|---|---|
| Publisher | 英普萊有限公司 |
| 網站 | https://www.impower.de |
| 隱私策略 | https://www.impower.de/datenschutzerklaerung |
| 類別 | 商業管理;財政 |
Impower 連接器允許您訪問主數據集,例如屬性、單位、合同和聯繫人。 此外,您可以上傳文件和發票。 人們可以按計劃讀取數據,也可以通過使用集成觸發器註冊 Webhook 來讀取數據。
先決條件
為了使用 Impower,您需要:
- 付費 Impower 訂閱
- Powerautomate Premium 訂閱
如何取得認證
若要取得網域的 APIKey 以連接 powerautomate,請在 上 support@impower.de撰寫請求。
開始使用連接器
您可以考慮建置的案例:
- 監視 Sharepoint/Onedrive 資料夾是否有變更,如果出現新的 PDF 檔案,請將其上傳至 impower
- 將連絡人清單與您的小組通訊簿同步處理
已知問題與限制
下載/上傳檔案
檔案會以二進位格式上傳為多部分表單資料。 下載也是如此:檔案按原樣提供,標頭中帶有建議的檔案名稱 - 就像在 http 標準中一樣
速率限制
請以每分鐘執行的請求不超過 5000 個為目標。 我們對API施加了速率限制,以確保系統能夠快速為使用者提供服務
正在建立連線
連接器支援下列驗證類型:
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用:所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| API-Key | securestring | 此 API 的 API-Key | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 上傳發票 PDF 文檔 |
默認情況下,文檔將通過 OCR 分析 |
| 依指定的篩選參數取得合約 |
依指定的篩選參數擷取合約 |
| 依指定的篩選參數取得屬性 |
依指定的篩選參數擷取屬性 |
| 依指定的篩選器參數取得文件 |
依指定的篩選器參數擷取文件 |
| 依指定的篩選條件下載多個文件 |
文檔採用 zip 格式 |
| 刪除連線 |
刪除連線 |
| 取得所有預先定義的錯誤碼值 |
傳回所有預先定義錯誤碼的清單 |
| 取得文件標籤 |
標準和網域特定文件標籤將作為回應傳回 |
| 取得特定錯誤碼的詳細資料 |
擷取特定錯誤碼的描述 |
| 建立新的文件標籤 |
新建立的文件標籤將作為回應傳回 |
| 更新指定發票預訂項目的預訂文本 |
更新預訂文字 |
| 更新連線 |
更新連線 |
| 根據指定的 ID 刪除現有文件 |
系統產生的文件無法刪除 |
| 根據指定的 ID 刪除現有的文件標籤 |
系統產生的標籤無法刪除 |
| 根據指定的 ID 更新現有的文件標籤 |
更新後的文件標籤將作為回應傳回 |
| 根據指定的請求內文更新現有文件 |
所有需求資訊都在請求內文中 |
| 根據提供的欄位更新發票 |
更新發票 |
| 根據給定的檔案建立新文件 |
新建立的文件將作為回應傳回 |
| 舊版發票詳細資料 |
通過舊版 API 從 Impower 獲取發票詳細信息。 請改用 getInvoiceByIdUsingGET。 |
| 讀取連線 |
讀取連線 |
| 透過指定的 ID 取得合約 |
依指定識別碼擷取合約 |
| 通過給定的 ID 下載單個文檔 |
文件的格式由 mimetype 定義 |
| 通過給定的 ID 獲取一個單位 |
傳回具有給定 ID 的單位 |
| 通過給定的 ID 獲取屬性 |
依指定的識別碼擷取屬性 |
| 通過給定的 ID 獲取發票 |
按給定 ID 檢索發票 |
| 通過給定的 ID 獲取聯繫人 |
按給定 ID 檢索聯繫人 |
| 通過給定的過濾器參數獲取所有單位 |
傳回遵循指定篩選條件的所有單位 |
| 通過給定的過濾器參數獲取發票 |
按給定的過濾器參數檢索發票 |
| 通過給定的過濾器參數獲取聯繫人 |
通過給定的過濾器參數檢索聯繫人 |
| (遺產)上傳發票 |
使用舊版 API 將 pdf 檔案上傳至 Impower。 請改用 uploadInvoiceUsingPOST 作業。 |
上傳發票 PDF 文檔
默認情況下,文檔將通過 OCR 分析
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
發票的 PDF 檔案
|
file | True | file |
發票的 PDF 檔案 |
傳回
發票資料結構。
- InvoiceDto
- InvoiceDto
依指定的篩選參數取得合約
依指定的篩選參數擷取合約
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
與合約相關聯的聯絡執行個體的 ID。
|
contactId | integer |
與合約相關聯的聯絡執行個體的 ID。 |
|
|
要篩選合約的合約識別碼清單。
|
contractIds | array |
要篩選合約的合約識別碼清單。 |
|
|
排序方向。 可能的值:ASC、DESC
|
order | string |
排序方向。 可能的值:ASC、DESC |
|
|
要傳回的頁碼
|
page | integer |
要傳回的頁碼 |
|
|
合約所屬屬性實例的識別碼。
|
propertyId | integer |
合約所屬屬性實例的識別碼。 |
|
|
單頁要退回的項目數量
|
size | integer |
單頁要退回的項目數量 |
|
|
排序參數
|
sort | string |
排序參數 |
|
|
合約類型。 選項:所有者 |租戶 |PROPERTY_OWNER
|
type | array |
合約類型。 選項:所有者 |租戶 |PROPERTY_OWNER |
|
|
與合約相關聯的單位實例的 ID。
|
unitId | integer |
與合約相關聯的單位實例的 ID。 |
|
|
在日期返回有效合約。 Null 會解譯為時間的開始/結束。
|
validAtDate | string |
在日期返回有效合約。 Null 會解譯為時間的開始/結束。 |
傳回
- PageOfContractDto
- PageOfContractDto
依指定的篩選參數取得屬性
依指定的篩選參數擷取屬性
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
屬性的名稱。
|
name | string |
屬性的名稱。 |
|
|
排序方向。 可能的值:ASC、DESC
|
order | string |
排序方向。 可能的值:ASC、DESC |
|
|
要傳回的頁碼
|
page | integer |
要傳回的頁碼 |
|
|
屬性的人類可讀 ID。
|
propertyHrId | string |
屬性的人類可讀 ID。 |
|
|
單頁要退回的項目數量
|
size | integer |
單頁要退回的項目數量 |
|
|
排序參數
|
sort | string |
排序參數 |
傳回
- PageOfPropertyDto
- PageOfPropertyDto
依指定的篩選器參數取得文件
依指定的篩選器參數擷取文件
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
財產的會計師姓名。
|
accountant | string |
財產的會計師姓名。 |
|
|
屬性的管理員名稱。
|
administrator | string |
屬性的管理員名稱。 |
|
|
文件所屬聯絡實體的識別碼。
|
contactId | integer |
文件所屬聯絡實體的識別碼。 |
|
|
與具有相似名稱的合約連結的文件。
|
contractName | string |
與具有相似名稱的合約連結的文件。 |
|
|
要退回的文件的 ID。
|
documentIds | array |
要退回的文件的 ID。 |
|
|
要退回的文件名稱。
|
documentName | string |
要退回的文件名稱。 |
|
|
文件的簽發日期。
|
issuedDate | string |
文件的簽發日期。 |
|
|
簽發日期之前的文件。
|
maxIssuedDate | string |
簽發日期之前的文件。 |
|
|
簽發日期後的文件。
|
minIssuedDate | string |
簽發日期後的文件。 |
|
|
排序方向。 可能的值:ASC、DESC
|
order | string |
排序方向。 可能的值:ASC、DESC |
|
|
要傳回的頁碼
|
page | integer |
要傳回的頁碼 |
|
|
文件所屬屬性的人類可讀識別碼。
|
propertyHrId | string |
文件所屬屬性的人類可讀識別碼。 |
|
|
文件所屬屬性的 ID。
|
propertyId | integer |
文件所屬屬性的 ID。 |
|
|
文件所屬屬性的名稱。
|
propertyName | string |
文件所屬屬性的名稱。 |
|
|
單頁要退回的項目數量
|
size | integer |
單頁要退回的項目數量 |
|
|
排序參數
|
sort | string |
排序參數 |
|
|
文件所屬來源實體的識別碼。
|
sourceId | integer |
文件所屬來源實體的識別碼。 |
|
|
文件的來源類型。
|
sourceType | array |
文件的來源類型。 |
|
|
文件相關聯的標籤 ID。
|
tagIds | array |
文件相關聯的標籤 ID。 |
|
|
文件與之關聯的標籤名稱相似。
|
tagName | string |
文件與之關聯的標籤名稱相似。 |
|
|
文件所屬單位實體的識別碼。
|
unitId | integer |
文件所屬單位實體的識別碼。 |
傳回
- PageOfDocumentD設定為
- PageOfDocumentDto
依指定的篩選條件下載多個文件
文檔採用 zip 格式
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
財產的會計師姓名。
|
accountant | string |
財產的會計師姓名。 |
|
|
屬性的管理員名稱。
|
administrator | string |
屬性的管理員名稱。 |
|
|
文件所屬聯絡實體的識別碼。
|
contactId | integer |
文件所屬聯絡實體的識別碼。 |
|
|
與具有相似名稱的合約連結的文件。
|
contractName | string |
與具有相似名稱的合約連結的文件。 |
|
|
要退回的文件的 ID。
|
documentIds | array |
要退回的文件的 ID。 |
|
|
要退回的文件名稱。
|
documentName | string |
要退回的文件名稱。 |
|
|
文件的簽發日期。
|
issuedDate | string |
文件的簽發日期。 |
|
|
簽發日期之前的文件。
|
maxIssuedDate | string |
簽發日期之前的文件。 |
|
|
簽發日期後的文件。
|
minIssuedDate | string |
簽發日期後的文件。 |
|
|
文件所屬屬性的人類可讀識別碼。
|
propertyHrId | string |
文件所屬屬性的人類可讀識別碼。 |
|
|
文件所屬屬性的 ID。
|
propertyId | integer |
文件所屬屬性的 ID。 |
|
|
文件所屬屬性的名稱。
|
propertyName | string |
文件所屬屬性的名稱。 |
|
|
文件所屬來源實體的識別碼。
|
sourceId | integer |
文件所屬來源實體的識別碼。 |
|
|
文件的來源類型。
|
sourceType | array |
文件的來源類型。 |
|
|
文件相關聯的標籤 ID。
|
tagIds | array |
文件相關聯的標籤 ID。 |
|
|
文件與之關聯的標籤名稱相似。
|
tagName | string |
文件與之關聯的標籤名稱相似。 |
|
|
文件所屬單位實體的識別碼。
|
unitId | integer |
文件所屬單位實體的識別碼。 |
傳回
- response
- file
刪除連線
刪除連線
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
線上的識別碼
|
connectionIdX | True | integer |
線上的識別碼 |
取得所有預先定義的錯誤碼值
傳回所有預先定義錯誤碼的清單
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of string |
取得文件標籤
標準和網域特定文件標籤將作為回應傳回
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
套用至名稱和說明的搜尋字串
|
description | string |
套用至名稱和說明的搜尋字串 |
傳回
- response
- array of DocumentTagDto
取得特定錯誤碼的詳細資料
擷取特定錯誤碼的描述
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
value
|
value | True | string |
value |
傳回
- ErrorCodeDetailsD設定為
- ErrorCodeDetailsDto
建立新的文件標籤
新建立的文件標籤將作為回應傳回
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
新建立的文件標籤的描述。
|
description | string |
新建立的文件標籤的描述。 |
|
|
新建立的文件標籤的名稱。
|
name | string |
新建立的文件標籤的名稱。 |
傳回
文件標籤的 Model 類別。
- DocumentTagD設定為
- DocumentTagDto
更新指定發票預訂項目的預訂文本
更新預訂文字
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
發票預訂項目的唯一 ID
|
invoiceItemId | True | integer |
發票預訂項目的唯一 ID |
|
發票項目的預約文字。
|
bookingText | string |
發票項目的預約文字。 |
傳回
- InvoiceItemD設定為
- InvoiceItemDto
更新連線
更新連線
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
線上的識別碼
|
connectionIdX | True | integer |
線上的識別碼 |
|
連線的名稱,應顯示在 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 刪除現有文件
系統產生的文件無法刪除
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
documentId
|
documentId | True | integer |
documentId |
根據指定的 ID 刪除現有的文件標籤
系統產生的標籤無法刪除
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
要刪除的文件標籤的唯一識別碼
|
tagId | True | integer |
要刪除的文件標籤的唯一識別碼 |
根據指定的 ID 更新現有的文件標籤
更新後的文件標籤將作為回應傳回
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件標籤的唯一識別碼
|
tagId | True | integer |
文件標籤的唯一識別碼 |
|
文件標籤的新描述。
|
description | string |
文件標籤的新描述。 |
|
|
文件標籤的新名稱。
|
name | string |
文件標籤的新名稱。 |
傳回
文件標籤的 Model 類別。
- DocumentTagD設定為
- DocumentTagDto
根據指定的請求內文更新現有文件
所有需求資訊都在請求內文中
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
要更新為的文件金額的新值
|
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
根據提供的欄位更新發票
更新發票
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
發票的唯一 ID
|
invoiceId | True | integer |
發票的唯一 ID |
|
發票的新開立日期。
|
issuedDate | string |
發票的新開立日期。 |
|
|
發票的新名稱。
|
name | string |
發票的新名稱。 |
傳回
發票資料結構。
- InvoiceDto
- InvoiceDto
根據給定的檔案建立新文件
新建立的文件將作為回應傳回
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
要上傳的 PDF 文件
|
file | True | file |
要上傳的 PDF 文件 |
傳回
文件資料結構。
- DocumentDto
- DocumentDto
舊版發票詳細資料
通過舊版 API 從 Impower 獲取發票詳細信息。 請改用 getInvoiceByIdUsingGET。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
發票識別碼
|
invoiceId | True | integer |
指定發票 ID 以取得詳細資料 |
傳回
- LegacyInvoiceD設定為
- LegacyInvoiceDto
讀取連線
讀取連線
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
連線的 ID
|
connectionIdX | True | integer |
連線的 ID |
傳回
描述現有連線的資料
- ConnectionDto
- ConnectionDto
透過指定的 ID 取得合約
依指定識別碼擷取合約
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
合約的唯一識別碼
|
contractId | True | integer |
合約的唯一識別碼 |
傳回
合約資料結構。
- ContractDto
- ContractDto
通過給定的 ID 下載單個文檔
文件的格式由 mimetype 定義
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件的唯一識別碼
|
documentId | True | integer |
文件的唯一識別碼 |
傳回
- response
- file
通過給定的 ID 獲取一個單位
傳回具有給定 ID 的單位
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
單位的唯一 ID
|
unitId | True | integer |
單位的唯一 ID |
傳回
單位資料結構。
- UnitDto
- UnitDto
通過給定的 ID 獲取屬性
依指定的識別碼擷取屬性
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
屬性的唯一識別碼
|
propertyId | True | integer |
屬性的唯一識別碼 |
傳回
屬性資料結構。
- PropertyDto
- PropertyDto
通過給定的 ID 獲取發票
按給定 ID 檢索發票
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
發票的唯一識別碼
|
invoiceId | True | integer |
發票的唯一識別碼 |
傳回
發票資料結構。
- InvoiceDto
- InvoiceDto
通過給定的 ID 獲取聯繫人
按給定 ID 檢索聯繫人
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
聯絡人的唯一識別碼
|
contactId | True | integer |
聯絡人的唯一識別碼 |
傳回
聯絡人代表自然人或法人實體,以及聯絡方式。 身分/公司應有多個郵寄地址,可透過這些地址與其聯繫。 這些表示為 2 個不同的聯絡人。
- 聯絡方式
- ContactDto
通過給定的過濾器參數獲取所有單位
傳回遵循指定篩選條件的所有單位
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
排序方向。 可能的值:ASC、DESC
|
order | string |
排序方向。 可能的值:ASC、DESC |
|
|
要傳回的頁碼
|
page | integer |
要傳回的頁碼 |
|
|
單位所屬屬性的唯一識別碼
|
propertyId | integer |
單位所屬屬性的唯一識別碼 |
|
|
單頁要退回的項目數量
|
size | integer |
單頁要退回的項目數量 |
|
|
排序參數
|
sort | string |
排序參數 |
傳回
- PageOfUnitDto
- PageOfUnitDto
通過給定的過濾器參數獲取發票
按給定的過濾器參數檢索發票
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
對應聯絡人的唯一識別碼
|
counterpartContactId | integer |
對應聯絡人的唯一識別碼 |
|
|
要擷取的發票日期
|
issuedDate | string |
要擷取的發票日期 |
|
|
排序方向。 可能的值:ASC、DESC
|
order | string |
排序方向。 可能的值:ASC、DESC |
|
|
要傳回的頁碼
|
page | integer |
要傳回的頁碼 |
|
|
發票所屬屬性的唯一識別碼
|
propertyId | integer |
發票所屬屬性的唯一識別碼 |
|
|
單頁要退回的項目數量
|
size | integer |
單頁要退回的項目數量 |
|
|
排序參數
|
sort | string |
排序參數 |
|
|
要擷取的發票狀態
|
states | array |
要擷取的發票狀態 |
傳回
- PageOfInvoiceD為
- PageOfInvoiceDto
通過給定的過濾器參數獲取聯繫人
通過給定的過濾器參數檢索聯繫人
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
要篩選聯絡人的聯絡人 ID 清單。
|
contactIds | array |
要篩選聯絡人的聯絡人 ID 清單。 |
|
|
聯繫人的電子郵件位址。
|
string |
聯繫人的電子郵件位址。 |
||
|
連絡人的任何名稱。 可能是名字、姓氏或公司名稱。
|
name | string |
連絡人的任何名稱。 可能是名字、姓氏或公司名稱。 |
|
|
排序方向。 可能的值:ASC、DESC
|
order | string |
排序方向。 可能的值:ASC、DESC |
|
|
要傳回的頁碼
|
page | integer |
要傳回的頁碼 |
|
|
單頁要退回的項目數量
|
size | integer |
單頁要退回的項目數量 |
|
|
排序參數
|
sort | string |
排序參數 |
傳回
- PageOfContactDto
- PageOfContactDto
(遺產)上傳發票
使用舊版 API 將 pdf 檔案上傳至 Impower。 請改用 uploadInvoiceUsingPOST 作業。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
指定要上傳的 pdf 檔案
|
file | True | file |
指定要上傳的 pdf 檔案 |
傳回
- LegacyInvoiceD設定為
- LegacyInvoiceDto
觸發程序
| 建立應用程式連線 |
建立應用程式連線 |
建立應用程式連線
定義
ConnectionNotificationD設定為
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
通知套用的連線識別碼
|
connectionId | integer |
connectionId |
|
實體類型
|
entityType | string |
實體類型 |
|
entityId
|
entityId | integer |
entityId |
|
eventType
|
eventType | string |
eventType |
ConnectionDto
描述現有連線的資料
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
應用程式的標識碼
|
appId | integer |
應用程式的標識碼 |
|
連線應用程式的名稱
|
appName | string |
連線應用程式的名稱 |
|
實體的建立時間。
|
created | string |
實體的建立時間。 |
|
實體的 ID。
|
id | integer |
實體的 ID。 |
|
連接的名稱
|
name | string |
連接的名稱 |
|
實體的上次更新時間。
|
updated | string |
實體的上次更新時間。 |
|
將呼叫的連線的 Webhook,例如 ''' POST https://your.webhook.url/path/somewhere 授權:持有者 TOKEN
{ “connectionId”: 0, “entityType”: “properties|contacts|invoices|etc.”, “entityId”: 0, “eventType”: “CREATE|更新|刪除“ }'''
|
webhookUrl | string |
將呼叫的連線的Webhook,例如
|
聯絡方式Dto
聯絡方式
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
聯絡人的商業電話號碼
|
businessPhoneNumber | array of string |
聯絡人的商業電話號碼 |
|
聯絡人的出生日期。
|
dateOfBirth | string |
聯絡人的出生日期。 |
|
聯絡人的電子郵件地址
|
array of string |
聯絡人的電子郵件地址 |
|
|
聯絡人的傳真號碼
|
fax | array of string |
聯絡人的傳真號碼 |
|
聯絡人之手機號碼
|
mobilePhoneNumber | array of string |
聯絡人之手機號碼 |
|
聯絡人的私人電話號碼
|
privatePhoneNumber | array of string |
聯絡人的私人電話號碼 |
|
貿易登記號碼。
|
tradeRegisterNumber | string |
貿易登記號碼。 |
|
聯絡人的增值稅 ID。
|
vatId | string |
聯絡人的增值稅 ID。 |
|
聯絡人網站
|
website | array of string |
聯絡人網站 |
聯絡方式
聯絡人代表自然人或法人實體,以及聯絡方式。 身分/公司應有多個郵寄地址,可透過這些地址與其聯繫。 這些表示為 2 個不同的聯絡人。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
城市名稱。
|
city | string |
城市名稱。 |
|
公司名稱,如果聯絡人是公司。
|
companyName | string |
公司名稱,如果聯絡人是公司。 |
|
國家代碼符合 ISO 3166-1 alpha-2 標準。
|
country | string |
國家代碼符合 ISO 3166-1 alpha-2 標準。 |
|
聯絡人的建立時間。
|
created | string |
聯絡人的建立時間。 |
|
聯絡方式Dto
|
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 |
聯絡人的最後更新時間。 |
聯絡方式SimpleDto
聯繫簡化的數據結構。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
聯絡執行個體的 ID。
|
id | integer |
聯絡執行個體的 ID。 |
|
連絡人的名稱。 如需更多詳細資訊,請透過 ID 載入聯絡人。
|
name | string |
連絡人的名稱。 如需更多詳細資訊,請透過 ID 載入聯絡人。 |
ContractDto
合約資料結構。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
與合約相關聯的連絡人清單。
|
contacts | array of ContactSimpleDto |
與合約相關聯的連絡人清單。 |
|
合約編號。
|
contractNumber | string |
合約編號。 |
|
合約的建立時間。
|
created | string |
合約的建立時間。 |
|
合約有效期結束之日。 Null 會解譯為時間結束。
|
endDate | string |
合約有效期結束之日。 Null 會解譯為時間結束。 |
|
合約執行個體的識別碼。
|
id | integer |
合約執行個體的識別碼。 |
|
描述此合約是否為空置類型合約。 截至目前,只有在合約類型為 TENANT 的情況下才成立。 空置合約意味著該單位不出租。
|
isVacant | boolean |
描述此合約是否為空置類型合約。 截至目前,只有在合約類型為 TENANT 的情況下才成立。 空置合約意味著該單位不出租。 |
|
合約名稱,由單位金鑰和郵件聯絡人名稱組成。
|
name | string |
合約名稱,由單位金鑰和郵件聯絡人名稱組成。 |
|
合約所屬屬性實例的識別碼。
|
propertyId | integer |
合約所屬屬性實例的識別碼。 |
|
合同有效期開始日期。 Null 會解譯為時間的開始。
|
startDate | string |
合同有效期開始日期。 Null 會解譯為時間的開始。 |
|
合約類型。
1. 業主 - 此類合同證明單位的所有權。
2. 租戶 - 此類合同是租賃該單位。
3. PROPERTY_OWNER - 此類合同證明財產的所有權。
|
type | string |
合約類型。
|
|
合約所屬單位實例的識別碼。
|
unitId | integer |
合約所屬單位實例的識別碼。 |
|
合約的最後更新時間。
|
updated | string |
合約的最後更新時間。 |
DocumentDto
文件資料結構。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
文件上存在的總金額。
|
amount | float |
文件上存在的總金額。 |
|
文件所屬建築物的 ID。
|
buildingId | integer |
文件所屬建築物的 ID。 |
|
文件所屬聯絡人的 ID。
|
contactId | integer |
文件所屬聯絡人的 ID。 |
|
文件所屬合約的 ID。
|
contractId | integer |
文件所屬合約的 ID。 |
|
文件的建立時間。
|
created | string |
文件的建立時間。 |
|
文件執行個體的識別碼。
|
id | integer |
文件執行個體的識別碼。 |
|
文件的簽發日期。
|
issuedDate | string |
文件的簽發日期。 |
|
文件實例的名稱。
|
name | string |
文件實例的名稱。 |
|
文件指派至之屬性的人類可讀識別碼。
|
propertyHrId | string |
文件指派至之屬性的人類可讀識別碼。 |
|
文件所屬屬性的 ID。
|
propertyId | integer |
文件所屬屬性的 ID。 |
|
文件指派至的屬性名稱。
|
propertyName | string |
文件指派至的屬性名稱。 |
|
文件所屬來源實體的識別碼。
|
sourceId | integer |
文件所屬來源實體的識別碼。 |
|
文件的來源類型。
與 id 一起標識文檔來源/附加的同名業務流程。
它可能是空值。
|
sourceType | string |
文件的來源類型。 與 id 一起標識文檔來源/附加的同名業務流程。 它可能是空值。 |
|
文件的狀態。
|
state | string |
文件的狀態。 |
|
tags
|
tags | array of DocumentTagSimpleDto | |
|
文件指派給單位的人類可讀 ID。
|
unitHrId | string |
文件指派給單位的人類可讀 ID。 |
|
文件所屬單位的 ID。
|
unitId | integer |
文件所屬單位的 ID。 |
|
文件的最後更新時間。
|
updated | string |
文件的最後更新時間。 |
DocumentTagD設定為
文件標籤的 Model 類別。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
文件標籤的描述。
|
description | string |
文件標籤的描述。 |
|
文件標籤的 ID。
|
id | integer |
文件標籤的 ID。 |
|
文件標籤的名稱。
|
name | string |
文件標籤的名稱。 |
DocumentTagSimpleD設定為
文件標籤的 Model 類別。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
文件標籤的唯一識別碼。
|
id | integer |
文件標籤的唯一識別碼。 |
|
文件標籤的名稱。
|
name | string |
文件標籤的名稱。 |
ErrorCodeDetailsD設定為
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
字碼
|
code | string | |
|
描述
|
description | string |
InvoiceDto
發票資料結構。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
根據發票支付的金額。
|
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 |
產生訂單的報表。 |
|
發票所屬屬性的人類可讀識別碼。
|
propertyHrId | string |
發票所屬屬性的人類可讀識別碼。 |
|
發票所屬屬性的識別碼。
|
propertyId | integer |
發票所屬屬性的識別碼。 |
|
發票所屬屬性的名稱。
|
propertyName | string |
發票所屬屬性的名稱。 |
|
發票的狀態。 可能的值:1. DRAFT - 已建立發票,但不完整。
2. READY - 發票準備就緒。
3. 已預訂 - 已預訂的發票。
4. SCHEDULED - 僅適用於定期發票。
5. 撤銷 - 發票產生的所有預訂均已撤銷。
|
state | string |
發票的狀態。 可能的值:
|
|
實體的上次更新時間。
|
updated | string |
實體的上次更新時間。 |
InvoiceItemD設定為
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
預訂項目的帳戶代碼。
|
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) 或營運成本報告 (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) 或營運成本報告 (Nebenkostenabrechnung)。
|
|
發票項目的上次更新時間。
|
updated | string |
發票項目的上次更新時間。 |
|
預訂項目的相應增值稅金額。
|
vatAmount | float |
預訂項目的相應增值稅金額。 |
|
對應的增值稅佔總金額的增值稅百分比。
|
vatPercentage | float |
對應的增值稅佔總金額的增值稅百分比。 |
PageOfContactDto
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
內容
|
content | array of ContactDto | |
|
empty
|
empty | boolean | |
|
先
|
first | boolean | |
|
last
|
last | boolean | |
|
數字
|
number | integer | |
|
元素數
|
numberOfElements | integer | |
|
可分頁
|
pageable | Pageable | |
|
size
|
size | integer | |
|
排序
|
sort | Sort | |
|
總元素
|
totalElements | integer | |
|
總頁數
|
totalPages | integer |
PageOfContractDto
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
內容
|
content | array of ContractDto | |
|
empty
|
empty | boolean | |
|
先
|
first | boolean | |
|
last
|
last | boolean | |
|
數字
|
number | integer | |
|
元素數
|
numberOfElements | integer | |
|
可分頁
|
pageable | Pageable | |
|
size
|
size | integer | |
|
排序
|
sort | Sort | |
|
總元素
|
totalElements | integer | |
|
總頁數
|
totalPages | integer |
PageOfDocumentD設定為
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
內容
|
content | array of DocumentDto | |
|
empty
|
empty | boolean | |
|
先
|
first | boolean | |
|
last
|
last | boolean | |
|
數字
|
number | integer | |
|
元素數
|
numberOfElements | integer | |
|
可分頁
|
pageable | Pageable | |
|
size
|
size | integer | |
|
排序
|
sort | Sort | |
|
總元素
|
totalElements | integer | |
|
總頁數
|
totalPages | integer |
PageOfInvoiceD為
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
內容
|
content | array of InvoiceDto | |
|
empty
|
empty | boolean | |
|
先
|
first | boolean | |
|
last
|
last | boolean | |
|
數字
|
number | integer | |
|
元素數
|
numberOfElements | integer | |
|
可分頁
|
pageable | Pageable | |
|
size
|
size | integer | |
|
排序
|
sort | Sort | |
|
總元素
|
totalElements | integer | |
|
總頁數
|
totalPages | integer |
PageOfPropertyDto
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
內容
|
content | array of PropertyDto | |
|
empty
|
empty | boolean | |
|
先
|
first | boolean | |
|
last
|
last | boolean | |
|
數字
|
number | integer | |
|
元素數
|
numberOfElements | integer | |
|
可分頁
|
pageable | Pageable | |
|
size
|
size | integer | |
|
排序
|
sort | Sort | |
|
總元素
|
totalElements | integer | |
|
總頁數
|
totalPages | integer |
PageOfUnitDto
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
內容
|
content | array of UnitDto | |
|
empty
|
empty | boolean | |
|
先
|
first | boolean | |
|
last
|
last | boolean | |
|
數字
|
number | integer | |
|
元素數
|
numberOfElements | integer | |
|
可分頁
|
pageable | Pageable | |
|
size
|
size | integer | |
|
排序
|
sort | Sort | |
|
總元素
|
totalElements | integer | |
|
總頁數
|
totalPages | integer |
可分頁
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
位移
|
offset | integer | |
|
頁號
|
pageNumber | integer | |
|
pageSize
|
pageSize | integer | |
|
分頁
|
paged | boolean | |
|
排序
|
sort | Sort | |
|
未分頁
|
unpaged | boolean |
PropertyDto
屬性資料結構。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
屬性實例的建立時間。
|
created | string |
屬性實例的建立時間。 |
|
屬性實例的 ID。
|
id | integer |
屬性實例的 ID。 |
|
屬性實例的名稱。
|
name | string |
屬性實例的名稱。 |
|
屬性執行個體的人類可讀識別碼。
|
propertyHrId | string |
屬性執行個體的人類可讀識別碼。 |
|
屬性的當前狀態。
1. DRAFT - 物業尚未激活,因此無法生成預訂/銀行訂單/報告。
2. READY - 物業已激活,可用於預訂/銀行訂單/報告生成。
3. DISABLED - 住宿已停用,無法再產生預訂/銀行訂單/報告。
|
state | string |
屬性的當前狀態。
|
|
屬性的管理類型。 OWNER - 房主協會。 租賃 - 租戶管理。
|
type | string |
屬性的管理類型。 OWNER - 房主協會。 租賃 - 租戶管理。 |
|
更新屬性例證的時間。
|
updated | string |
更新屬性例證的時間。 |
排序
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
empty
|
empty | boolean | |
|
排序
|
sorted | boolean | |
|
未排序
|
unsorted | boolean |
UnitDto
單位資料結構。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
單位實例的建立時間。
|
created | string |
單位實例的建立時間。 |
|
單位所在的樓層。
|
floor | string |
單位所在的樓層。 |
|
單位實例的 ID。
|
id | integer |
單位實例的 ID。 |
|
單位在樓層內的位置。
|
position | string |
單位在樓層內的位置。 |
|
單位所屬屬性實例的 ID。
|
propertyId | integer |
單位所屬屬性實例的 ID。 |
|
該裝置的用途。公寓 - 用於住宅目的的單元。 PARKING - 用於停車目的的單元。 商業 - 用於商業/商業目的的單位。 OTHER - 用於其他目的的單位。
|
type | string |
該裝置的用途。公寓 - 用於住宅目的的單元。 PARKING - 用於停車目的的單元。 商業 - 用於商業/商業目的的單位。 OTHER - 用於其他目的的單位。 |
|
單位執行個體的人類可讀識別碼。
|
unitHrId | string |
單位執行個體的人類可讀識別碼。 |
|
排名定義單位在 UI/報表上的顯示順序。 使用者可以在 UI 中更新它。
|
unitRank | integer |
排名定義單位在 UI/報表上的顯示順序。 使用者可以在 UI 中更新它。 |
|
更新單位實例的時間。
|
updated | string |
更新單位實例的時間。 |
LegacyInvoiceD設定為
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
BIC 對應物
|
counterpartBic | string |
BIC 對應物 |
|
ContactID 對應項
|
counterpartContactId | integer |
ContactID 對應項 |
|
IBAN 對應物
|
counterpartIban | string |
IBAN 對應物 |
|
副本
|
counterpartName | string |
副本 |
|
Date
|
created | string |
Date |
|
發票網址
|
documentUrl | string |
發票網址 |
|
ID
|
id | integer |
ID |
|
發票日期
|
invoiceDate | string |
發票日期 |
|
發票識別碼
|
invoiceHrId | string |
發票識別碼 |
|
發票號碼
|
invoiceNumber | string |
發票號碼 |
|
付款目標日期
|
paymentTargetDate | string |
付款目標日期 |
|
付款類型
|
paymentType | string |
付款類型 |
|
物業NR
|
propertyHrId | string |
物業NR |
|
屬性 ID
|
propertyId | integer |
屬性 ID |
|
內容內部 ID
|
propertyIdInternal | string |
內容內部 ID |
|
屬性名稱
|
propertyName | string |
屬性名稱 |
|
參考編號
|
refNr | string |
參考編號 |
|
發票狀態
|
state | string |
發票狀態 |
|
總總額
|
totalGross | float |
總總額 |
|
總淨額
|
totalNet | float |
總淨額 |
|
含增值稅。
|
vatIncluded | boolean |
含增值稅。 |
|
增值稅百分比
|
vatPercentage | float |
增值稅百分比 |
檔案
這是基本資料類型「檔案」。