資訊系統
iMIS,專為協會和非營利組織構建的參與管理系統。
此連接器適用於以下產品和區域:
| 服務 | 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) |
| 連絡人 | |
|---|---|
| 名稱 | 計算機系統創新公司 |
| URL | https://csiinc.com/support |
| support@csiinc.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | 計算機系統創新公司 |
| 網站 | https://www.csiinc.com/ |
| 隱私策略 | https://www.csiinc.com/privacy |
| 類別 | 資料;銷售和客戶關係管理 |
iMIS 是世界上唯一的參與管理系統 (EMS),專為滿足您組織的獨特需求並支持您的持續績效改進而構建。 使用此連接器中可用的觸發程序和動作,將您的 iMIS 資料 (連絡人、活動、面板、IQA 等) 延伸至 Power Automate 和 Logic Apps 生態系統。
先決條件
您需要一個作用中的 iMIS 執行個體和訂閱才能使用此連接器。 如需詳細資訊,請參閱: https://csi.ms/paprerequisites
如何取得認證
您將需要一個 API 金鑰才能使用此連接器。 (注意:這與您的iMIS API憑據 不同 。有關獲取 API 密匙的說明,請參閱: https://csi.ms/paapikey
開始使用連接器
您可以按照我們的簡單指南開始使用 iMIS 和 Power Automate: https://csi.ms/pagettingstarted
成功建立連線後,請瀏覽我們的自動化構想庫,以取得您可以使用 iMIS 和 Power Automate 建置的自動化構想: http://csi.ms/paideas
已知問題與限制
如需已知限制和當前問題的完整清單,請參閱: https://csi.ms/palimitations
常見錯誤和補救措施
401 未經授權
傳回此狀態碼時,請檢查回應本文並尋找 X-CSI-Error-Msg 自訂標頭。 這將有助於診斷問題所在。
如需常見疑難排解步驟的完整清單,請參閱: https://csi.ms/palimitations
正在建立連線
連接器支援下列驗證類型:
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用:所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| CSI API 金鑰 | securestring | 請輸入您的 CSI API 金鑰,可在 CSI Cloud 儀表板中找到。 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 依順序取得活動 |
依序列 (SEQN) 值擷取單一活動記錄 |
| 刪除單一實例面板記錄 |
刪除 iMIS 中的單一例證面板記錄。 |
| 刪除多重實例面板記錄 |
刪除 iMIS 中的多重例證面板記錄。 |
| 取得單一實例面板記錄 |
在 iMIS 中取得單一實例面板記錄。 |
| 取得多執行個體面板記錄 |
在 iMIS 中取得多實例面板記錄。 |
| 取得聯絡方式 |
按其 iMIS ID 檢索單個聯繫人記錄。 |
| 取得連絡人的地址 |
擷取連絡人的地址。 |
| 取得連絡人的所有地址 |
擷取連絡人的地址清單。 |
| 取得連絡人的相片 |
透過聯絡人的 iMIS ID 擷取聯絡人的個人資料圖片。 |
| 執行 IQA |
在提供的路徑上執行 iMIS IQA。 |
| 尋找活動 |
按類型、iMIS ID 等搜尋活動 |
| 尋找聯絡人 |
根據各種條件查找 iMIS 聯繫人記錄。 大多數搜尋欄位都支援搜尋篩選器,例如 “startsWith:x” 或 “contains:x”。 如需完整清單,請參閱檔案。 |
| 尋找面板記錄 |
根據各種條件查找 iMIS 面板記錄。 大多數搜尋欄位都支援搜尋篩選器,例如 “startsWith:x” 或 “contains:x”。 如需完整清單,請參閱檔案。 |
| 建立多實例面板記錄 |
在 iMIS 中建立多實例面板記錄。 |
| 建立活動 |
在 iMIS 中建立新的活動記錄 |
| 建立組織 |
在 iMIS 中建立連絡人 (組織) 記錄。 |
| 建立聯絡人 |
在 iMIS 中建立聯絡人 (人員) 記錄。 |
| 更新單一實例面板記錄 |
更新 iMIS 中的單一實例面板記錄。 |
| 更新多實例面板記錄 |
更新 iMIS 中的多重實例面板記錄。 |
| 更新活動 |
更新 iMIS 中的活動記錄 |
| 更新組織 |
更新 iMIS 中的聯絡人 (組織) 記錄。 |
| 更新聯絡人 |
更新 iMIS 中的聯絡人 (人員) 記錄。 iMIS ID 是要求內文中必需的,並將用於尋找要更新的聯絡人。 只有具有值的欄位才會更新。 如果欄位留空,則不會更新。 |
| 更新連絡人的郵寄地址 |
在 iMIS 中更新聯絡人的郵寄地址。 |
依順序取得活動
刪除單一實例面板記錄
刪除 iMIS 中的單一例證面板記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
面板名稱
|
panelNameSingleDelete | string |
要從中刪除的面板名稱。 |
|
|
body
|
body | dynamic |
GetPanelDeleteSchema 所產生的結構描述。 |
刪除多重實例面板記錄
刪除 iMIS 中的多重例證面板記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
面板名稱
|
panelNameMultiDelete | string |
要從中刪除的面板名稱。 |
|
|
body
|
body | dynamic |
GetPanelDeleteSchema 所產生的結構描述。 |
取得單一實例面板記錄
在 iMIS 中取得單一實例面板記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
面板名稱
|
panelNameSingleGet | string |
要從中擷取的面板名稱。 |
|
|
body
|
body | dynamic |
GetPanelGetSchema 所產生的結構描述。 |
傳回
取得多執行個體面板記錄
在 iMIS 中取得多實例面板記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
面板名稱
|
panelNameMultiGet | string |
要從中擷取的面板名稱。 |
|
|
body
|
body | dynamic |
GetPanelGetSchema 所產生的結構描述。 |
傳回
取得聯絡方式
按其 iMIS ID 檢索單個聯繫人記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
iMIS ID
|
contactId | True | string |
iMIS ID |
傳回
- 身體
- ContactDTO
取得連絡人的地址
擷取連絡人的地址。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
iMIS ID
|
contactId | True | string |
用於獲取地址的 iMIS ID |
|
地址目的
|
addressPurpose | True | string |
必須是 iMIS 中定義明確的位址用途名稱 |
傳回
- 身體
- AddressDTO
取得連絡人的所有地址
擷取連絡人的地址清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
iMIS ID
|
contactId | True | string |
用於獲取地址的 iMIS ID |
傳回
取得連絡人的相片
透過聯絡人的 iMIS ID 擷取聯絡人的個人資料圖片。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
iMIS ID
|
contactId | True | string |
iMIS ID |
傳回
代表連絡人的設定檔圖片
執行 IQA
在提供的路徑上執行 iMIS IQA。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
IQA路徑
|
iqaPath | string |
要執行的 IQA 路徑。 |
|
|
body
|
body | dynamic |
Iqa 過濾器。 |
傳回
尋找活動
按類型、iMIS ID 等搜尋活動
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
活動類型
|
activityType | string |
活動類型代碼 |
|
|
iMIS ID
|
imisId | string |
The iMIS ID |
|
|
產品代碼
|
productCode | string |
產品代碼 |
|
|
類別
|
category | string |
類別 |
|
|
交易日期當日或之前
|
transactionDateBefore | date |
交易日期或之前 |
|
|
交易日期之後
|
transactionDateAfter | date |
交易日期之後 |
|
|
生效日期 當天或之前
|
effectiveDateBefore | date |
生效日期或之前 |
|
|
生效日期之後
|
effectiveDateAfter | date |
生效日期之後 |
|
|
截至日期或之前
|
thruDateBefore | date |
截至日期或之前 |
|
|
之後的日期
|
thruDateAfter | date |
之後的日期 |
|
|
排序依據:
|
sortBy | string |
要排序的屬性名稱 |
|
|
排序 遞減
|
sortDesc | boolean |
如果排序順序應該是遞減(預設為遞增) |
傳回
尋找聯絡人
根據各種條件查找 iMIS 聯繫人記錄。 大多數搜尋欄位都支援搜尋篩選器,例如 “startsWith:x” 或 “contains:x”。 如需完整清單,請參閱檔案。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
名字
|
firstName | string |
連絡人的名字 (支援篩選器) |
|
|
姓氏
|
lastName | string |
連絡人的姓氏 (支援篩選器) |
|
|
全名
|
fullName | string |
聯絡人的全名 (支援篩選器) |
|
|
主要電子郵件
|
string |
連絡人的主要電子郵件地址 (支援篩選器) |
||
|
會員類型代碼
|
memberType | string |
聯絡人的成員類型代碼 (支援篩選器) |
|
|
公司名稱
|
organization | string |
連絡人的組織名稱 (支援篩選器) |
|
|
篩選記錄類型
|
recordType | string |
篩選記錄類型 (人員、組織) |
|
|
篩選已刪除狀態
|
deleteType | string |
篩選已刪除的狀態 (標示為刪除) |
傳回
尋找面板記錄
根據各種條件查找 iMIS 面板記錄。 大多數搜尋欄位都支援搜尋篩選器,例如 “startsWith:x” 或 “contains:x”。 如需完整清單,請參閱檔案。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
面板名稱
|
panelNameFindPost | string |
要查詢的面板名稱。 |
|
|
body
|
body | dynamic |
GetPanelSchema 所產生的結構描述。 |
傳回
建立多實例面板記錄
在 iMIS 中建立多實例面板記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
面板名稱
|
panelNameMultiCreate | string |
要建立的面板名稱。 |
|
|
body
|
body | dynamic |
GetPanelCreateSchema 所產生的結構描述。 |
傳回
建立活動
在 iMIS 中建立新的活動記錄
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
行動代碼
|
actionCodes | string | ||
|
活動類型
|
activityType | True | string | |
|
總數
|
amount | double | ||
|
附件順序
|
attachSeqn | integer | ||
|
附件總計
|
attachTotal | double | ||
|
批號
|
batchNum | string | ||
|
活動代碼
|
campaignCode | string | ||
|
類別
|
category | string | ||
|
公司身份證
|
coId | string | ||
|
Description
|
description | string | ||
|
生效日期
|
effectiveDate | date | ||
|
寬限期
|
gracePeriod | integer | ||
|
iMIS ID
|
id | True | string | |
|
編輯意圖
|
intentToEdit | string | ||
|
紀念/致敬代碼
|
memTribCode | string | ||
|
會員類型
|
memberType | string | ||
|
下一個安裝日期
|
nextInstallDate | date | ||
|
備註
|
note | string | ||
|
註2
|
note2 | string | ||
|
物體
|
object | string | ||
|
組織代碼
|
orgCode | string | ||
|
原始跨性別號碼
|
originatingTransNum | integer | ||
|
其他代碼
|
otherCode | string | ||
|
其他 ID
|
otherId | string | ||
|
付款方式
|
payMethod | string | ||
|
產品代碼
|
productCode | string | ||
|
數量
|
quantity | double | ||
|
重複請求
|
recurringRequest | boolean | ||
|
律師 ID
|
solicitorId | string | ||
|
原始程式碼
|
sourceCode | string | ||
|
來源系統
|
sourceSystem | string | ||
|
狀態代碼
|
statusCode | string | ||
|
應稅價值
|
taxableValue | double | ||
|
截止日期
|
thruDate | date | ||
|
搔癢約會
|
ticklerDate | date | ||
|
交易日期
|
transactionDate | date | ||
|
UF1
|
uF1 | string |
使用者欄位 1 (字串) |
|
|
UF2
|
uF2 | string |
使用者欄位 2 (字串) |
|
|
UF3
|
uF3 | string |
使用者欄位 3 (字串) |
|
|
UF4
|
uF4 | double |
使用者欄位 4 (小數) |
|
|
UF5
|
uF5 | double |
使用者欄位 5 (十進位) |
|
|
UF6
|
uF6 | date |
使用者欄位 6 (日期) |
|
|
UF7
|
uF7 | date |
使用者欄位 7 (日期) |
|
|
單位
|
units | double |
傳回
- 身體
- ActivityDTO
建立組織
在 iMIS 中建立連絡人 (組織) 記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
organizationName | string |
此組織的名稱 |
|
|
網站 URL
|
websiteUrl | string |
此組織首頁的網站 URL |
|
|
Email
|
string |
組織的主要電子郵件地址 |
||
|
工作電話
|
workPhone | string |
組織的工作電話號碼 |
|
|
傳真
|
fax | string |
組織的傳真號碼 |
|
|
會員類型
|
memberType | string |
機構的會員類型代碼(例如「NM」或「WEB」) |
|
|
計費類別
|
billingCategory | string |
組織的帳單類別名稱 |
|
|
大調
|
majorKey | string |
組織的主要重點領域 |
|
|
地位
|
status | string |
組織的狀態代碼(例如“A”、“D”、“X”) |
|
|
加入日期
|
joinDate | date |
組織的加入日期 |
傳回
- 身體
- ContactDTO
建立聯絡人
在 iMIS 中建立聯絡人 (人員) 記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
名稱前綴
|
namePrefix | string |
聯絡人的姓名前綴(例如「太太」) |
|
|
名字
|
firstName | string |
連絡人的名字 |
|
|
非正式名稱
|
informalName | string |
連絡人的非正式名稱 (或暱稱) |
|
|
中間名
|
middleName | string |
連絡人的中間名 |
|
|
姓氏
|
lastName | string |
連絡人的姓氏 |
|
|
名稱後綴
|
nameSuffix | string |
聯絡人的姓名後尾(例如「Jr.」) |
|
|
功能標題
|
functionalTitle | string |
連絡人的功能職稱代碼值 |
|
|
上層組織 ID
|
parentOrganizationId | string |
指定要將此人員連結至的父組織的 iMIS ID |
|
|
組織名稱
|
organizationName | string |
此聯絡人所屬的組織名稱 (如果已設定上層組織 ID,則不使用) |
|
|
Email
|
string |
連絡人的主要電子郵件地址 |
||
|
工作電話
|
workPhone | string |
連絡人的工作電話號碼 |
|
|
住家電話
|
homePhone | string |
連絡人的住家電話號碼 |
|
|
行動電話
|
mobilePhone | string |
聯絡人的行動電話號碼 |
|
|
傳真
|
fax | string |
連絡人的傳真號碼 |
|
|
性別
|
gender | string |
聯絡人的性別代碼(例如「M」、「F」或任何其他定義的代碼) |
|
|
會員類型
|
memberType | string |
聯絡人的會員類型代碼(例如「NM」或「WEB」) |
|
|
計費類別
|
billingCategory | string |
連絡人的帳單類別名稱 |
|
|
大調
|
majorKey | string |
聯絡人的主要關鍵欄位 |
|
|
地位
|
status | string |
聯絡人的狀態代碼(例如「A」、「D」、「X」) |
|
|
出生日期
|
birthDate | date |
連絡人的出生日期 |
|
|
加入日期
|
joinDate | date |
連絡人的加入日期 |
傳回
- 身體
- ContactDTO
更新單一實例面板記錄
更新 iMIS 中的單一實例面板記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
面板名稱
|
panelNameSingleUpdate | string |
要更新的面板名稱。 |
|
|
body
|
body | dynamic |
GetPanelSchema 所產生的結構描述。 |
傳回
更新多實例面板記錄
更新 iMIS 中的多重實例面板記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
面板名稱
|
panelNameMultiUpdate | string |
要更新的面板名稱。 |
|
|
body
|
body | dynamic |
GetPanelUpdateSchema 所產生的結構描述。 |
傳回
更新活動
更新 iMIS 中的活動記錄
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
行動代碼
|
actionCodes | string | ||
|
活動類型
|
activityType | string | ||
|
總數
|
amount | double | ||
|
附件順序
|
attachSeqn | integer | ||
|
附件總計
|
attachTotal | double | ||
|
批號
|
batchNum | string | ||
|
活動代碼
|
campaignCode | string | ||
|
類別
|
category | string | ||
|
公司身份證
|
coId | string | ||
|
Description
|
description | string | ||
|
生效日期
|
effectiveDate | date | ||
|
寬限期
|
gracePeriod | integer | ||
|
編輯意圖
|
intentToEdit | string | ||
|
紀念/致敬代碼
|
memTribCode | string | ||
|
會員類型
|
memberType | string | ||
|
下一個安裝日期
|
nextInstallDate | date | ||
|
備註
|
note | string | ||
|
註2
|
note2 | string | ||
|
物體
|
object | string | ||
|
組織代碼
|
orgCode | string | ||
|
原始跨性別號碼
|
originatingTransNum | integer | ||
|
其他代碼
|
otherCode | string | ||
|
其他 ID
|
otherId | string | ||
|
付款方式
|
payMethod | string | ||
|
產品代碼
|
productCode | string | ||
|
數量
|
quantity | double | ||
|
重複請求
|
recurringRequest | boolean | ||
|
Sequence
|
seqn | True | integer | |
|
律師 ID
|
solicitorId | string | ||
|
原始程式碼
|
sourceCode | string | ||
|
來源系統
|
sourceSystem | string | ||
|
狀態代碼
|
statusCode | string | ||
|
應稅價值
|
taxableValue | double | ||
|
截止日期
|
thruDate | date | ||
|
搔癢約會
|
ticklerDate | date | ||
|
交易日期
|
transactionDate | date | ||
|
UF1
|
uF1 | string |
使用者欄位 1 (字串) |
|
|
UF2
|
uF2 | string |
使用者欄位 2 (字串) |
|
|
UF3
|
uF3 | string |
使用者欄位 3 (字串) |
|
|
UF4
|
uF4 | double |
使用者欄位 4 (小數) |
|
|
UF5
|
uF5 | double |
使用者欄位 5 (十進位) |
|
|
UF6
|
uF6 | date |
使用者欄位 6 (日期) |
|
|
UF7
|
uF7 | date |
使用者欄位 7 (日期) |
|
|
單位
|
units | double |
傳回
- 身體
- ActivityDTO
更新組織
更新 iMIS 中的聯絡人 (組織) 記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
iMIS ID
|
id | True | string |
iMIS ID (也稱為:聯絡人 ID、當事人 ID) |
|
組織名稱
|
organizationName | string |
此組織的名稱 |
|
|
網站 URL
|
websiteUrl | string |
此組織首頁的網站 URL |
|
|
Email
|
string |
組織的主要電子郵件地址 |
||
|
工作電話
|
workPhone | string |
組織的工作電話號碼 |
|
|
傳真
|
fax | string |
組織的傳真號碼 |
|
|
會員類型
|
memberType | string |
機構的會員類型代碼(例如「NM」或「WEB」) |
|
|
計費類別
|
billingCategory | string |
組織的帳單類別名稱 |
|
|
大調
|
majorKey | string |
組織的主要重點領域 |
|
|
地位
|
status | string |
組織的狀態代碼(例如“A”、“D”、“X”) |
傳回
- 身體
- ContactDTO
更新聯絡人
更新 iMIS 中的聯絡人 (人員) 記錄。 iMIS ID 是要求內文中必需的,並將用於尋找要更新的聯絡人。 只有具有值的欄位才會更新。 如果欄位留空,則不會更新。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
iMIS ID
|
id | True | string |
iMIS ID (也稱為:聯絡人 ID、當事人 ID) |
|
名稱前綴
|
namePrefix | string |
聯絡人的姓名前綴(例如「太太」) |
|
|
名字
|
firstName | string |
連絡人的名字 |
|
|
非正式名稱
|
informalName | string |
連絡人的非正式名稱 (或暱稱) |
|
|
中間名
|
middleName | string |
連絡人的中間名 |
|
|
姓氏
|
lastName | string |
連絡人的姓氏 |
|
|
名稱後綴
|
nameSuffix | string |
聯絡人的姓名後尾(例如「Jr.」) |
|
|
功能標題
|
functionalTitle | string |
連絡人的功能職稱代碼值 |
|
|
上層組織 ID
|
parentOrganizationId | string |
指定要將此人員連結至的父組織的 iMIS ID |
|
|
Email
|
string |
連絡人的主要電子郵件地址 |
||
|
工作電話
|
workPhone | string |
連絡人的工作電話號碼 |
|
|
住家電話
|
homePhone | string |
連絡人的住家電話號碼 |
|
|
行動電話
|
mobilePhone | string |
聯絡人的行動電話號碼 |
|
|
傳真
|
fax | string |
連絡人的傳真號碼 |
|
|
性別
|
gender | string |
聯絡人的性別代碼(例如「M」、「F」或任何其他定義的代碼) |
|
|
會員類型
|
memberType | string |
聯絡人的會員類型代碼(例如「NM」或「WEB」) |
|
|
計費類別
|
billingCategory | string |
連絡人的帳單類別名稱 |
|
|
大調
|
majorKey | string |
聯絡人的主要關鍵欄位 |
|
|
地位
|
status | string |
聯絡人的狀態代碼(例如「A」、「D」、「X」) |
傳回
- 身體
- ContactDTO
更新連絡人的郵寄地址
在 iMIS 中更新聯絡人的郵寄地址。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
iMIS ID
|
id | True | string |
要更新的地址的 iMIS ID |
|
位址 1
|
address1 | string |
地址行 1 |
|
|
位址 2
|
address2 | string |
地址行 2 |
|
|
城市名稱
|
city | string |
地址上的城市名稱 |
|
|
州/省代碼
|
stateProvinceCode | string |
州/省的縮寫代碼 |
|
|
郵遞區號
|
postalCode | string |
郵政編碼或郵遞區號 |
|
|
國碼 (地區碼)
|
countryCode | string |
縮寫國家代碼 |
|
|
電話號碼
|
phone | string |
此地址的格式化電話號碼 |
|
|
電子郵件地址
|
string |
此地址的電子郵件 |
||
|
地址 3
|
address3 | string |
地址行 3 |
|
|
傳真號碼
|
fax | string |
此地址的格式化傳真號碼 |
傳回
- 身體
- AddressDTO
觸發程序
| 新增活動時 |
新增活動時 |
| 新增訂單時 |
新增訂單時 |
新增活動時
新增訂單時
定義
活動DTO
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
行動代碼
|
actionCodes | string | |
|
活動類型
|
activityType | string | |
|
總數
|
amount | double | |
|
附件順序
|
attachSeqn | integer | |
|
附件總計
|
attachTotal | double | |
|
批號
|
batchNum | string | |
|
活動代碼
|
campaignCode | string | |
|
類別
|
category | string | |
|
公司身份證
|
coId | string | |
|
Description
|
description | string | |
|
生效日期
|
effectiveDate | date | |
|
寬限期
|
gracePeriod | integer | |
|
iMIS ID
|
id | string | |
|
編輯意圖
|
intentToEdit | string | |
|
紀念/致敬代碼
|
memTribCode | string | |
|
會員類型
|
memberType | string | |
|
下一個安裝日期
|
nextInstallDate | date | |
|
備註
|
note | string | |
|
註2
|
note2 | string | |
|
物體
|
object | string | |
|
組織代碼
|
orgCode | string | |
|
原始跨性別號碼
|
originatingTransNum | integer | |
|
其他代碼
|
otherCode | string | |
|
其他 ID
|
otherId | string | |
|
付款方式
|
payMethod | string | |
|
產品代碼
|
productCode | string | |
|
數量
|
quantity | double | |
|
重複請求
|
recurringRequest | boolean | |
|
律師 ID
|
solicitorId | string | |
|
原始程式碼
|
sourceCode | string | |
|
來源系統
|
sourceSystem | string | |
|
狀態代碼
|
statusCode | string | |
|
應稅價值
|
taxableValue | double | |
|
截止日期
|
thruDate | date | |
|
搔癢約會
|
ticklerDate | date | |
|
交易日期
|
transactionDate | date | |
|
UF1
|
uF1 | string |
使用者欄位 1 (字串) |
|
UF2
|
uF2 | string |
使用者欄位 2 (字串) |
|
UF3
|
uF3 | string |
使用者欄位 3 (字串) |
|
UF4
|
uF4 | double |
使用者欄位 4 (小數) |
|
UF5
|
uF5 | double |
使用者欄位 5 (十進位) |
|
UF6
|
uF6 | date |
使用者欄位 6 (日期) |
|
UF7
|
uF7 | date |
使用者欄位 7 (日期) |
|
單位
|
units | double | |
|
Sequence
|
seqn | integer |
活動的序列值 (主索引鍵) |
活動清單DTO
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
活動清單
|
value | array of ActivityDTO |
活動記錄清單 |
地址DTO
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
地址 ID
|
addressId | string |
此地址記錄的唯一 ID。 |
|
地址行
|
addressLines | string |
換行換行分隔地址街道線。 |
|
城市名稱
|
city | string |
地址上的城市名稱。 |
|
州/省代碼
|
stateProvinceCode | string |
州/省的縮寫代碼。 |
|
郵遞區號
|
postalCode | string |
郵政編碼或郵政編碼。 |
|
國碼 (地區碼)
|
countryCode | string |
縮寫國家代碼。 |
|
電話號碼
|
phone | string |
此地址的格式化電話號碼。 |
|
電子郵件地址
|
string |
此地址的電子郵件。 |
|
|
完整地址
|
fullAddress | string |
具有換行符的完整計算位址。 |
|
姓名和完整地址
|
nameAndFullAddress | string |
完整計算的地址,第一行有聯絡人姓名。 |
|
地址目的
|
addressPurpose | string |
地址用途(類別)名稱。 |
|
通訊偏好清單
|
communicationPreferences | array of string |
通訊喜好設定類型清單。 |
地址清單DTO
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
地址列表
|
addresses | array of AddressDTO |
指定連絡人的地址物件清單 |
聯絡方式DTO
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
聯絡人類型
|
contactType | string |
聯絡人類型(組織或個人) |
|
iMIS ID
|
id | string |
iMIS ID (也稱為:聯絡人 ID、當事人 ID) |
|
名稱
|
name | string |
計算人員的聯絡人全名或組織名稱 |
|
名稱前綴
|
namePrefix | string |
聯絡人的姓名前綴(例如「太太」) |
|
名字
|
firstName | string |
連絡人的名字 |
|
非正式名稱
|
informalName | string |
連絡人的非正式名稱 (或暱稱) |
|
中間名
|
middleName | string |
連絡人的中間名 |
|
姓氏
|
lastName | string |
連絡人的姓氏 |
|
名稱後綴
|
nameSuffix | string |
聯絡人的姓名後尾(例如「Jr.」) |
|
功能標題
|
functionalTitle | string |
連絡人的職稱,包括任何指定 |
|
是會員
|
isMember | boolean |
指定此連絡人是否為組織成員的旗標 |
|
處於活動狀態
|
isActive | boolean |
指定此聯絡人是否標示為作用中 (即未標示為刪除、已故等) 的旗標 |
|
組織名稱
|
organizationName | string |
此連絡人所屬的組織名稱 |
|
組織識別碼
|
organizationId | string |
對於人員類型,指定連結的父組織 ID |
|
Email
|
string |
連絡人的主要電子郵件地址 |
|
|
工作電話
|
workPhone | string |
連絡人的工作電話號碼 |
|
住家電話
|
homePhone | string |
連絡人的住家電話號碼 |
|
行動電話
|
mobilePhone | string |
聯絡人的行動電話號碼 |
|
傳真
|
fax | string |
連絡人的傳真號碼 |
|
性別
|
gender | string |
聯絡人的性別代碼(例如「M」、「F」或任何其他定義的代碼) |
|
會員類型
|
memberType | string |
聯絡人的會員類型代碼(例如「NM」或「WEB」) |
|
計費類別
|
billingCategory | string |
連絡人的帳單類別名稱 |
|
大調
|
majorKey | string |
聯絡人的主要關鍵欄位 |
|
地位
|
status | string |
聯絡人的狀態代碼(例如「A」、「D」、「X」) |
|
聯絡人金鑰
|
contactKey | string |
連絡人的金鑰,有時稱為「網路識別碼」(Guid) |
|
出生日期
|
birthDate | date |
連絡人的出生日期 |
|
加入日期
|
joinDate | date |
連絡人的加入日期 |
|
付費直通
|
paidThruDate | date |
聯絡人的會員資格已支付至日期(如果是會員) |
|
續訂直通
|
renewedThruDate | date |
聯絡人的續訂截止日期 |
聯絡人清單DTO
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
聯絡人清單
|
value | array of ContactDTO |
聯絡人記錄清單 |
聯絡方式圖片DTO
代表連絡人的設定檔圖片
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
iMIS ID
|
id | string |
與此圖片相關聯的 iMIS ID |
|
圖片資料
|
pictureData | byte |
圖片資料 |
命令DTO
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
收貨地址第 1 行
|
address1 | string | |
|
送貨至地址第 2 行
|
address2 | string | |
|
收貨地址第 3 行
|
address3 | string | |
|
收貨地址格式代碼
|
addressFormat | integer | |
|
餘額金額
|
balance | double | |
|
批號
|
batchNumber | string | |
|
帳單至 iMIS ID
|
billToId | string | |
|
運送到地址城市
|
city | string | |
|
公司 iMIS ID
|
companyId | string | |
|
公司會員類型
|
companyMemberType | string | |
|
公司名稱
|
company | string | |
|
公司排序代碼
|
companySort | string | |
|
寄件地址國家/地區
|
country | string | |
|
客戶參考
|
customerReference | string | |
|
送貨至電子郵件地址
|
string | ||
|
運費 1 金額
|
freight1 | double | |
|
運費 2 金額
|
freight2 | double | |
|
運送到完整地址
|
fullAddress | string | |
|
運送至全名
|
fullName | string | |
|
處理 1 筆金額
|
handling1 | double | |
|
處理 2 金額
|
handling2 | double | |
|
保留代碼
|
holdCode | string | |
|
保留評論
|
holdComment | string | |
|
被持有嗎?
|
holdFlag | boolean | |
|
發票參考編號
|
invoiceReferenceNumber | integer | |
|
運送至會員類型
|
memberType | string | |
|
訂單備註
|
notes | string | |
|
訂購日期
|
orderDate | date | |
|
訂單編號
|
orderNumber | double | |
|
訂單類型代碼
|
orderTypeCode | string | |
|
實體代碼
|
entityCode | string | |
|
薪酬類型
|
payType | string | |
|
運送到電話
|
phone | string | |
|
原始程式碼
|
sourceCode | string | |
|
運送至 iMIS ID
|
shipToId | string | |
|
訂單階段
|
stage | string | |
|
運送到州/省
|
stateProvince | string | |
|
訂單狀態
|
status | string | |
|
稅金 1 金額
|
tax1 | double | |
|
稅金 2 金額
|
tax2 | double | |
|
稅金 3 金額
|
tax3 | double | |
|
稅 1 稅率
|
taxRate1 | double | |
|
稅 2 稅率
|
taxRate2 | double | |
|
稅 3 稅率
|
taxRate3 | double | |
|
訂單標題
|
title | string | |
|
訂單總費用
|
totalCharges | double | |
|
訂單總付款
|
totalPayments | double | |
|
延期交貨總數量
|
totalQuantityBackordered | integer | |
|
訂購總數量
|
totalQuantityOrdered | integer | |
|
寄送至郵遞區號
|
zip | string | |
|
來源系統
|
sourceSystem | string | |
|
折扣代碼
|
discountCode | string | |
|
增值稅稅碼
|
vatTaxCodeFh | string | |
|
未打折總計
|
undiscountedTotal | double | |
|
條款代碼
|
termsCode | string | |
|
稅率
|
taxRateFh | double | |
|
稅務 1 作者
|
taxAuthor1 | string | |
|
稅務 2 作者
|
taxAuthor2 | string | |
|
稅務 3 作者
|
taxAuthor3 | string | |
|
免稅
|
taxExempt | string | |
|
影響庫存?
|
affectInventory | boolean | |
|
運費稅額
|
freightTax | double | |
|
處理稅額
|
handlingTax | double | |
|
發票日期
|
invoiceDate | date | |
|
發票號碼
|
invoiceNumber | integer | |
|
行總金額
|
lineTotal | double | |
|
運送方式
|
shipMethod | string | |
|
發貨文件日期
|
shipPapersDateTime | date | |
|
出貨日期
|
shippedDateTime | date | |
|
總重量
|
totalWeight | double | |
|
資料輸入者
|
enteredBy | string | |
|
輸入的日期/時間
|
enteredDateTime | date |
訂單清單DTO
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
訂單清單
|
value | array of OrderDTO |
訂單記錄清單 |