GoFileRoom

GoFileRoom 是一種基於雲的文件管理和工作流程解決方案。使用 GoFileRoom 連接器，您可以執行文件、使用者管理和 FirmFlow 動作。

此連接器適用於以下產品和區域：

服務	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）

連絡人
名稱	GoFileRoom 支持
URL	https://tax.thomsonreuters.com/us/en/cs-professional-suite/support/contact
Email	CS.Support@ThomsonReuters.com

連接器中繼資料
Publisher	湯森路透
網站	https://www.gofileroom.com/
隱私策略	https://www.thomsonreuters.com/en/privacy-statement.html
類別	資料;企業管理

GoFileRoom 連接器為 Thomson Reuters 客戶提供了一種簡單的方法來利用 GoFileRoom 和 FirmFlow 的 API。用戶可以創建與用戶管理、文檔或 FirmFlow 相關的自動化和集成。

先決條件

使用者必須擁有 GoFileRoom API 金鑰才能使用連接器。

如何取得憑證？

API 金鑰可以透過在註冊 https://developerportal.thomsonreuters.com/帳戶來取得。此外，您還需要擁有一個有效的 GoFileRoom 帳戶。如果您對 GoFileRoom 感興趣，請在此處聯繫我們： https://tax.thomsonreuters.com/us/en/cs-professional-suite/gofileroom#contact

正在建立連線

連接器支援下列驗證類型：


預設值	建立連線的參數。	所有區域	不可共享

預設

適用：所有地區

建立連線的參數。

這不是可共用的連線。如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。

名稱	類型	Description	為必填項目
X-TR-API-APP-ID	securestring	此 API 的 X-TR-API-APP-ID	對

節流限制

名稱	呼叫	續約期間
每個連線的 API 呼叫	100	60 秒

動作

依可交付成果取得 FirmFlow 資料	依可傳送項目資料取得追蹤報告
依工作流程追蹤報告	依工作流程追蹤報告
修改使用者	修改使用者權限
修改群組	修改群組權限
刪除主要交付項目	刪除主要交付項目
刪除使用者	從系統中刪除 GoFileRoom 和 ClientFlow 使用者
刪除工作流程	刪除工作流程
刪除文件	刪除文件
取得 LookupList 值	從 LookupList 擷取值
取得上傳位置	擷取使用者的上傳位置
取得主交付成果	取得主交付成果
取得使用者文件安全性	擷取使用者每次登入的檔案安全性
取得使用者權限	取得使用者的權限
取得子索引	根據清單識別碼取得子索引值清單，該清單識別碼會在選取父清單值時提供。
取得密碼原則	擷取公司的密碼原則
取得抽取器索引	擷取為抽屜設定的文件索引清單
取得授權	擷取授權計數
取得文件	下載文件
取得文件歷史記錄	取得文件的歷程記錄
取得文件狀態	取得文件狀態
取得文件索引	擷取文件的索引
取得索引值清單	取得清單類型索引的所有專案
取得索引的動態規則	取得針對指定索引設定的動態規則清單
取得群組	擷取可用於使用者和群組管理的群組
取得群組文件安全性	擷取群組檔案安全性
取得群組權限	取得群組的權限
合併 PDF 的	將 PDF 檔案合併在一起
建立使用者	將 GoFileRoom 和 ClientFlow 使用者建立到系統中
建立工作流程	建立工作流程
建立文件	建立具有索引的文件記錄
建立群組	建立權限群組
按交付項目 V2 跟踪報告	DeliverableV2 的追蹤報告
文件搜尋	將使用者有權存取的所有文件載入指定的抽屜中。
文件重新索引	重新索引文件
新增主要交付項目	新增主要交付項目
獲取報告列表	擷取可用於使用者管理的報告
獲取抽屜	擷取登入使用者可存取的抽屜
獲取用戶	擷取登入使用者的 GFR 使用者
獲取用戶信息	獲取 GFR 用戶信息
獲取用戶信息 V2	取得使用者資訊
登出	登出應用程式
登錄	將使用者登入應用程式
發佈文件狀態	從 ClientFlow 發佈或取消發佈文件。
稅務排序文件	Taxsort PDF 文件
索引查閱清單尋找	此方法設計用於自動完成欄位。
編輯主要交付項目	編輯主要交付項目
編輯工作流程	編輯工作流程
複製文件	複製文件
設定使用者文件安全性	指派使用者檔案安全性許可權
設定使用者權限	將權限指派給使用者
設定群組文件安全性	將檔案安全性指派給群組
設定群組權限	將權限指派給群組
路由工作流程 V2	路由工作流程 V2
驗證權杖	驗證權杖狀態
驗證索引	檢查提供的索引是否有效。

依可交付成果取得 FirmFlow 資料

作業識別碼：: GetFirmFlowDeliverableReport

依可傳送項目資料取得追蹤報告

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
有責任的	Accountable	string	輸入責任值
指派日期	AssignedOn	string	輸入指派日期
AssignedTo	AssignedTo	string	輸入 [指派給] 值
指派歷程記錄	AssignmentHistory	string	輸入作業歷史記錄
完成者	CompletedBy	string	輸入 [完成者] 值
CompletedOn	CompletedOn	string	輸入完成日期
目前到期日期	CurrentDueDate	string	輸入當前到期日
當前步驟	CurrentStep	string	進入目前步驟
日期延長	DateExtended	string	輸入延期日期
天步	DaysAtStep	string	輸入 Days At Step
路由之間的天數	DaysBetweenRoutings	string	輸入路由之間的天數
抽屜識別碼	DrawerId	string	輸入抽屜 ID
參與類型	EngagementType	string	輸入參與類型
InProcess僅限	InProcessOnly	string	僅輸入處理中值
Indexes	Indexes	array of string	Indexes
資訊欄位	InformationFields	array of string	資訊欄位
原始到期日期	OriginalDueDate	string	輸入原始截止日期
圖片	PIC	string	進入PIC
頁碼	PageNumber	string	輸入頁碼
Priority	Priority	string	輸入優先權
接收自	ReceivedFrom	string	輸入 [接收自] 值
接收日期	ReceivedOn	string	輸入接收日期
負責	Responsible	string	輸入負責值
路由詳細資料	RoutingDetails	string	輸入路由詳細資料
森頓	SentOn	string	輸入傳送日期
傳送至	SentTo	string	輸入 [傳送至] 值
ServiceType	ServiceType	string	輸入服務類型
地位	Status	string	輸入狀態
總天數在步長	TotalDaysAtStep	string	輸入步進總天數
總天數處理中	TotalDaysInProcess	string	輸入處理中總天數
Workflow	Workflow	string	輸入工作流程名稱
工作流程說明	WorkflowDescription	string	輸入工作流程說明

傳回

名稱	路徑	類型	Description
firmFlowReport回應	firmFlowReportResponse	array of object	firmFlowReport回應
有責任的	firmFlowReportResponse.accountable	string	責任價值
assignedOn	firmFlowReportResponse.assignedOn	string	已指派日期
assignedTo	firmFlowReportResponse.assignedTo	string	指派給值
assignedToYes或No	firmFlowReportResponse.assignedToYesOrNo	string	是否指派了工作流程
指派歷程記錄	firmFlowReportResponse.assignmentHistory	string	指派歷程記錄值
客戶名稱	firmFlowReportResponse.clientName	string	client Name 值
客戶編號	firmFlowReportResponse.clientNumber	string	客戶編號值
完成者	firmFlowReportResponse.completedBy	string	依值完成
completedOn	firmFlowReportResponse.completedOn	string	完成日期
當前到期日期	firmFlowReportResponse.currentDueDate	string	目前到期日
currentStep	firmFlowReportResponse.currentStep	string	目前的 Step 值
日期延長	firmFlowReportResponse.dateExtended	string	日期延長
天在步驟	firmFlowReportResponse.daysAtStep	string	工作流程天數 At Step
daysBetween路由	firmFlowReportResponse.daysBetweenRoutings	string	路由之間的工作流程天數
交付項目	firmFlowReportResponse.deliverables	string	交付項目價值
drawerId	firmFlowReportResponse.drawerId	string	抽屜 ID 值
電子檔案是或否	firmFlowReportResponse.eFileYesOrNo	string	是要電子歸檔的交付物
參與類型	firmFlowReportResponse.engagementType	string	參與類型值
extendedYes或No	firmFlowReportResponse.extendedYesOrNo	string	可交付成果是否已延長
資訊欄位	firmFlowReportResponse.informationFields	array of object	資訊欄位
名稱	firmFlowReportResponse.informationFields.name	string	名稱
value	firmFlowReportResponse.informationFields.value	string	value
原始到期日期	firmFlowReportResponse.originalDueDate	string	原始截止日期
periodEnd	firmFlowReportResponse.periodEnd	string	期間工作流程結束
圖片	firmFlowReportResponse.pic	string	工作流程圖片
pic是或否	firmFlowReportResponse.picYesOrNo	string	圖片已分配嗎
priority	firmFlowReportResponse.priority	string	優先級值
進展	firmFlowReportResponse.progress	string	進度值
receivedFrom	firmFlowReportResponse.receivedFrom	string	收到 From 值
receivedOn	firmFlowReportResponse.receivedOn	string	收到日期
負責	firmFlowReportResponse.responsible	string	負責任的價值觀
responsibleUser或群組	firmFlowReportResponse.responsibleUserOrGroups	array of	responsibleUser或群組
路由附註	firmFlowReportResponse.routingNotes	string	路由工作流程註釋
路由摘要	firmFlowReportResponse.routingSummary	array of	路由摘要
發送在	firmFlowReportResponse.sentOn	string	已發送日期
發送至	firmFlowReportResponse.sentTo	string	已傳送至值
服務類型	firmFlowReportResponse.serviceType	string	服務工作流程類型
狀態	firmFlowReportResponse.status	string	工作流程狀態
totalDaysAtStep	firmFlowReportResponse.totalDaysAtStep	string	工作流程總計 Days At Step
totalDaysInProcess	firmFlowReportResponse.totalDaysInProcess	string	工作流程總處理天數
工作流程	firmFlowReportResponse.workflow	string	工作流程類型
工作流程說明	firmFlowReportResponse.workflowDescription	string	工作流程說明
年	firmFlowReportResponse.year	string	工作流程年份
getFirmFlowException	getFirmFlowException	string	取得 FirmFlow 例外狀況
頁號	pageNumber	string	頁面請求數量
pageSize	pageSize	integer	頁面請求大小
總頁數	totalPages	integer	請求總頁數
總記錄	totalRecords	integer	請求記錄總數

依工作流程追蹤報告

作業識別碼：: TrackingReportByWorkflow

依工作流程追蹤報告

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
抽屜 ID	DrawerId	string	抽屜 ID
服務類型	ServiceType	string	服務類型
參與類型	EngagementType	string	參與類型
Workflow	Workflow	string	Workflow
目前步驟	CurrentStep	string	目前步驟
圖片	PIC	string	圖片
指派至	AssignedTo	string	指派至
指派日期	AssignedOn	string	指派日期
工作流程說明	WorkflowDescription	string	工作流程說明
僅限進行中	InProcessOnly	string	僅限進行中
地位	Status	string	地位
Priority	Priority	string	Priority
負責	Responsible	string	負責
作業歷史	AssignmentHistory	string	作業歷史
收件者	ReceivedFrom	string	收件者
收稿日期	ReceivedOn	string	收稿日期
發送至	SentTo	string	發送至
發送時間	SentOn	string	發送時間
完成者	CompletedBy	string	完成者
完成日期	CompletedOn	string	完成日期
當前到期日	CurrentDueDate	string	當前到期日
步調天數	DaysAtStep	string	步調天數
步進總天數	TotalDaysAtStep	string	步進總天數
路由之間的天數	DaysBetweenRoutings	string	路由之間的天數
處理中總天數	TotalDaysInProcess	string	處理中總天數
有責任的	Accountable	string	有責任的
路由詳細資料	RoutingDetails	string	路由詳細資料
上次更新	LastUpdated	string	上次更新
資訊欄位	InformationFields	array of string	資訊欄位
Indexes	Indexes	array of string	Indexes
頁碼	PageNumber	string	頁碼

傳回

名稱	路徑	類型	Description
記錄總數	totalRecords	integer	記錄總數
頁碼	pageNumber	string	頁碼
頁面大小	pageSize	integer	頁面大小
總頁數	totalPages	integer	總頁數
firmFlowReport回應	firmFlowReportResponse	array of object	firmFlowReport回應
客戶名稱	firmFlowReportResponse.clientName	string	客戶名稱
客戶編號	firmFlowReportResponse.clientNumber	string	客戶編號
抽屜 ID	firmFlowReportResponse.drawerId	string	抽屜 ID
服務類型	firmFlowReportResponse.serviceType	string	服務類型
參與類型	firmFlowReportResponse.engagementType	string	參與類型
Workflow	firmFlowReportResponse.workflow	string	Workflow
目前步驟	firmFlowReportResponse.currentStep	string	目前步驟
圖片	firmFlowReportResponse.pic	string	圖片
指派至	firmFlowReportResponse.assignedTo	string	指派至
指派日期	firmFlowReportResponse.assignedOn	string	指派日期
年	firmFlowReportResponse.year	string	年
期末	firmFlowReportResponse.periodEnd	string	期末
工作流程說明	firmFlowReportResponse.workflowDescription	string	工作流程說明
Progress	firmFlowReportResponse.progress	string	Progress
地位	firmFlowReportResponse.status	string	地位
Priority	firmFlowReportResponse.priority	string	Priority
電子申報是或否	firmFlowReportResponse.eFileYesOrNo	string	電子申報是或否
擴展是或否	firmFlowReportResponse.extendedYesOrNo	string	擴展是或否
收稿日期	firmFlowReportResponse.receivedOn	string	收稿日期
完成日期	firmFlowReportResponse.completedOn	string	完成日期
發送時間	firmFlowReportResponse.sentOn	string	發送時間
交付項目	firmFlowReportResponse.deliverables	string	交付項目
負責	firmFlowReportResponse.responsible	string	負責
作業歷史	firmFlowReportResponse.assignmentHistory	string	作業歷史
收件者	firmFlowReportResponse.receivedFrom	string	收件者
發送至	firmFlowReportResponse.sentTo	string	發送至
完成者	firmFlowReportResponse.completedBy	string	完成者
有責任的	firmFlowReportResponse.accountable	string	有責任的
當前到期日	firmFlowReportResponse.currentDueDate	string	當前到期日
原定截止日期	firmFlowReportResponse.originalDueDate	string	原定截止日期
路由註釋	firmFlowReportResponse.routingNotes	string	路由註釋
PIC 是或否	firmFlowReportResponse.picYesOrNo	string	PIC 是或否
指派給是或否	firmFlowReportResponse.assignedToYesOrNo	string	指派給是或否
延長日期	firmFlowReportResponse.dateExtended	string	延長日期
步調天數	firmFlowReportResponse.daysAtStep	string	步調天數
步進總天數	firmFlowReportResponse.totalDaysAtStep	string	步進總天數
路由之間的天數	firmFlowReportResponse.daysBetweenRoutings	string	路由之間的天數
處理中總天數	firmFlowReportResponse.totalDaysInProcess	string	處理中總天數
資料夾 ID	firmFlowReportResponse.folderID	string	資料夾 ID
備案編號	firmFlowReportResponse.filingID	string	備案編號
工作流程上次更新時間	firmFlowReportResponse.workflowLastUpdated	string	工作流程上次更新時間
資訊欄位	firmFlowReportResponse.informationFields	array of object	資訊欄位
名稱	firmFlowReportResponse.informationFields.name	string	名稱
value	firmFlowReportResponse.informationFields.value	string	value
路由摘要	firmFlowReportResponse.routingSummary	array of	路由摘要
responsibleUser或群組	firmFlowReportResponse.responsibleUserOrGroups	array of	responsibleUser或群組
取得 FirmFlow 例外狀況	getFirmFlowException	string	取得 FirmFlow 例外狀況

修改使用者

作業識別碼：: ModifyUser

修改使用者權限

參數

名稱	機碼	類型	Description
用戶類型	userType	string	輸入使用者類型
代幣	X-Authorization	string	權杖驗證
帳戶到期日期	AccountExpiresDate	string	帳戶到期日期
已停用註解	DisabledComments	string	輸入評論
全名	FullName	string	輸入全名
Groups	Groups	array of string	Groups
IsAccount到期	IsAccountExpires	string	指定 true 或 false
是前進流動	IsAdvanceFlow	string	指定 true 或 false
IsAllowAccessToReports	IsAllowAccessToReports	string	指定 true 或 false
是允許離線	IsAllowOffline	string	指定 true 或 false
IsChangeNext登入	IsChangeNextLogin	string	指定 true 或 false
已停用	IsDisabled	string	指定 true 或 false
是堅流	IsFirmFlow	string	指定 true 或 false
IsFirmFlowNotificationGroup	IsFirmFlowNotificationGroup	string	指定 true 或 false
IsFirmFlowNotificationUser	IsFirmFlowNotificationUser	string	指定 true 或 false
伊斯姆法	IsMfa	string	指定 true 或 false
IsUser管理	IsUserAdministration	string	指定 true 或 false
IsWorkflowManager使用者	IsWorkflowManagerUser	string	指定 true 或 false
授權類型	LicenseType	string	輸入授權類型
登入名稱	LoginName	string	輸入登入名稱
經理電子郵件	ManagerEmail	string	輸入經理電子郵件
密碼	Password	string	輸入密碼
Allow	Allow	array of string	Allow
Deny	Deny	array of string	Deny
IsAllowAll	IsAllowAll	string	指定 true 或 false
是拒絕全部	IsDenyAll	string	指定 true 或 false
ReportType	ReportType	string	指定 true 或 false
上傳位置	UploadLocation	string	輸入上傳位置

傳回

名稱	路徑	類型	Description
是修改的	isModified	boolean	使用者是否被修改
mfa例外狀況	mfaException	string	mfa 例外狀況
修改使用者例外狀況	modifyUserException	string	修改使用者例外狀況
userId	userId	string	user Id 值

修改群組

作業識別碼：: ModifyGroup

修改群組權限

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
AccessToApproveDocsOnly	AccessToApproveDocsOnly	string	指定 true 或 false
AllowAccessToReports	AllowAccessToReports	string	指定 true 或 false
評論	Comments	string	輸入評論
啟用Mfa	EnableMfa	string	指定 true 或 false
強制執行 MfaForUsers	EnforceMfaForUsers	string	指定 true 或 false
FirmFlowRouting通知	FirmFlowRoutingNotification	string	指定 true 或 false
FullAccessToDocTracking	FullAccessToDocTracking	string	指定 true 或 false
GroupName	GroupName	string	輸入群組名稱
Mfa必填	MfaRequired	string	指定 true 或 false
PermissonToApproveDocs	PermissonToApproveDocs	string	指定 true 或 false
重新命名群組	RenameGroup	string	輸入新的群組名稱
Allow	Allow	array of string	Allow
Deny	Deny	array of string	Deny
IsAllowAll	IsAllowAll	string	指定 true 或 false
是拒絕全部	IsDenyAll	string	指定 true 或 false
ReportType	ReportType	string	指定 true 或 false
上傳位置	UploadLocation	string	輸入上傳位置
使用者	Users	array of string	使用者

傳回

名稱	路徑	類型	Description
groupId	groupId	string	群組識別碼值
是修改的	isModified	boolean	該組是否被修改
mfa例外狀況	mfaException	string	mfa 例外狀況
修改群組異常	modifyGroupException	string	修改群組異常

刪除主要交付項目

作業識別碼：: DeleteMasterDeliverable

刪除主要交付項目

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
服務類型	ServiceType	string	服務類型
抽屜名稱	DrawerName	string	抽屜名稱
交付項目名稱	DeliverableNames	array of string	交付項目名稱

傳回

名稱	路徑	類型	Description
		array of object
刪除狀態	isDeleted	boolean	刪除狀態
回應訊息	responseMessage	string	回應訊息

刪除使用者

作業識別碼：: DeleteUser

從系統中刪除 GoFileRoom 和 ClientFlow 使用者

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
登入 ID	LoginId	string	輸入使用者的登入ID
用戶類型	UserType	string	輸入使用者類型

傳回

名稱	路徑	類型	Description
deleteUserException	deleteUserException	string	刪除使用者例外狀況
已刪除	isDeleted	boolean	登錄名是否被刪除
登入 ID	loginId	string	登入 ID 值

刪除工作流程

作業識別碼：: DeleteWorkflows

刪除工作流程

參數

名稱	機碼	必要	類型	Description
代幣	X-Authorization		string	權杖驗證
歸檔標識符	filingId		array of integer	歸檔標識符

傳回

名稱	路徑	類型	Description
已刪除狀態	isDeleted	boolean	已刪除狀態
備案編號	filingId	string	備案編號

刪除文件

作業識別碼：: DocumentDelete

刪除文件

參數

名稱	機碼	必要	類型	Description
DocumentId	documentId	True	string	輸入文件 ID
代幣	X-Authorization		string	權杖驗證

傳回

名稱	路徑	類型	Description
		array of object
刪除文件例外狀況	deleteDocumentException	string	刪除文件例外狀況
documentId	documentId	string	文件識別碼值
已刪除	isDeleted	boolean	文件是否已刪除

取得 LookupList 值

作業識別碼：: GetLookupList

從 LookupList 擷取值

參數

名稱	機碼	必要	類型	Description
抽屜 ID。範例用戶端抽屜：「0000000001」	drawerId	True	string	輸入抽屜 ID
代幣	X-Authorization		string	權杖驗證

傳回

名稱	路徑	類型	Description
		array of object
客戶名稱	clientName	string	client Name 值
客戶編號	clientNumber	string	用戶端號碼值

取得上傳位置

作業識別碼：: GetUploadLocation

擷取使用者的上傳位置

參數

名稱	機碼	必要	類型	Description
代幣	X-Authorization		string	權杖驗證

傳回

名稱	路徑	類型	Description
上傳位置	uploadLocations	array of object	上傳位置
locationName	uploadLocations.locationName	string	location 名稱值
位置路徑	uploadLocations.locationPath	string	location 路徑值
上傳位置例外狀況	uploadLocationsException	string	上傳位置例外

取得主交付成果

作業識別碼：: GetMasterDeliverable

取得主交付成果

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
頁碼	PageNumber	integer	頁碼
頁面大小	pageSize	integer	頁面大小
服務類型	ServiceType	string	服務類型
抽屜名稱	DrawerName	string	抽屜名稱

傳回

名稱	路徑	類型	Description
交付項目清單	deliverableList	array of object	交付項目清單
交付項目名稱	deliverableList.deliverableName	string	交付項目名稱
延伸模組類型	deliverableList.extensionType	string	延伸模組類型
到期日	deliverableList.dueDate	string	到期日
第一次擴展	deliverableList.firstExtension	string	第一次擴展
第二次擴展	deliverableList.secondExtension	string	第二次擴展
第三次延期	deliverableList.thirdExtension	string	第三次延期
Extension	deliverableList.extension	string	Extension
行動	deliverableList.action	string	行動
義務標識符	deliverableList.obligationId	string	義務標識符
公司管理選項	deliverableList.firmManagedOption	string	公司管理選項
記錄總數	totalRecords	string	記錄總數
回應訊息	responseMessage	string	回應訊息

取得使用者文件安全性

作業識別碼：: GetUserDocumentSecurity

擷取使用者每次登入的檔案安全性

參數

名稱	機碼	必要	類型	Description
登入 ID	loginId	True	string	輸入登入 ID
內閣名稱	cabinetName	True	string	輸入機櫃名稱
抽屜名稱	drawerName	True	string	輸入抽屜名稱
代幣	X-Authorization		string	權杖驗證

傳回

名稱	路徑	類型	Description
內閣名稱	cabinetName	string	內閣名稱
文件安全	documentSecurity	string	document 安全性值
抽屜名稱	drawerName	string	抽屜名稱值
getUserDocSecurityException	getUserDocSecurityException	string	使用者檔案安全性例外狀況
登入 ID	loginId	string	登入 ID 值

取得使用者權限

作業識別碼：: GetUserPermission

取得使用者的權限

參數

名稱	機碼	必要	類型	Description
登錄	login	True	string	進入登錄
代幣	X-Authorization		string	權杖驗證

傳回

名稱	路徑	類型	Description
cabinet	cabinet	string	機櫃名稱值
新增	cabinetPermission.add	boolean	增加價值
刪除	cabinetPermission.delete	boolean	刪除值
否認	cabinetPermission.deny	boolean	拒絕值
編輯	cabinetPermission.edit	boolean	編輯值
䶳	cabinetPermission.lookUp	boolean	lookUp 值
讀取	cabinetPermission.read	boolean	讀取值
抽屜權限	drawerPermissions	array of object	抽屜權限
抽屜	drawerPermissions.drawer	string	抽屜名稱值
新增	drawerPermissions.permission.add	boolean	增加價值
刪除	drawerPermissions.permission.delete	boolean	刪除值
否認	drawerPermissions.permission.deny	boolean	拒絕值
編輯	drawerPermissions.permission.edit	boolean	編輯值
䶳	drawerPermissions.permission.lookUp	boolean	lookUp 值
讀取	drawerPermissions.permission.read	boolean	讀取值
getUserPermissionException	getUserPermissionException	string	使用者權限例外
登入 ID	loginId	string	登入 ID 值

取得子索引

作業識別碼：: GetChildIndexes

根據清單識別碼取得子索引值清單，該清單識別碼會在選取父清單值時提供。

參數

名稱	機碼	必要	類型	Description
索引標識符	indexId	True	string	輸入索引 ID
清單標識碼	listId	True	string	輸入清單 ID
代幣	X-Authorization		string	權杖驗證

傳回

名稱	路徑	類型	Description
		array of object
childIndexId	childIndexId	string	子索引識別碼值
childListId	childListId	integer	子清單識別碼值
有孩子	hasChildren	boolean	索引是否有子索引
listEntryId	listEntryId	integer	list 項目標識碼值
listId	listId	integer	list Id 值
value	value	string	value

取得密碼原則

作業識別碼：: GetPasswordPolicy

擷取公司的密碼原則

參數

名稱	機碼	必要	類型	Description
代幣	X-Authorization		string	權杖驗證

傳回

名稱	路徑	類型	Description
clientId	passwordPolicy.clientId	string	用戶端識別碼值
forbidden_pwd_words	passwordPolicy.forbidden_pwd_words	array of string	forbidden_pwd_words
lockout_threshold	passwordPolicy.lockout_threshold	integer	鎖定臨界值
max_length	passwordPolicy.max_length	integer	密碼長度上限
max_login_similarity	passwordPolicy.max_login_similarity	string	最大登入相似性
max_pwd_age	passwordPolicy.max_pwd_age	integer	密碼的最大 PWD 存量
max_repeat_chars	passwordPolicy.max_repeat_chars	string	密碼中的最大重複字元
max_sequential_chars	passwordPolicy.max_sequential_chars	string	順序字元數上限
藝術碩士	passwordPolicy.mfa	integer	MFA 值
min_length	passwordPolicy.min_length	integer	密碼長度下限
pwd_req_alpha	passwordPolicy.pwd_req_alpha	integer	Alpha 密碼要求
pwd_req_lower	passwordPolicy.pwd_req_lower	integer	較低的密碼要求
pwd_req_number	passwordPolicy.pwd_req_number	integer	密碼號碼要求
pwd_req_symbol	passwordPolicy.pwd_req_symbol	integer	符號密碼要求
pwd_req_upper	passwordPolicy.pwd_req_upper	integer	密碼上限要求
passwordPolicyException	passwordPolicyException	string	passwordPolicyException

取得抽取器索引

作業識別碼：: GetDrawerIndexes

擷取為抽屜設定的文件索引清單

參數

名稱	機碼	必要	類型	Description
抽屜識別碼	drawerId	True	string	輸入抽屜 ID
代幣	X-Authorization		string	權杖驗證

傳回

名稱	路徑	類型	Description
		array of object
childIndexId	childIndexId	string	子索引識別碼值
索引標識	indexId	string	索引識別碼值
IndexName	indexName	string	索引名稱值
索引類型	indexType	string	索引類型值
length	length	integer	抽屜索引長度
listId	listId	integer	list Id 值
lookupAutoUpdate	lookupAutoUpdate	boolean	查找自動更新
required	required	boolean	索引是否必填

取得授權

作業識別碼：: GetLicenses

擷取授權計數

參數

名稱	機碼	必要	類型	Description
授權類型	license		string	輸入授權類型
代幣	X-Authorization		string	權杖驗證

傳回

名稱	路徑	類型	Description
assignedLicenses	assignedLicenses	string	指派的授權計數
getLicenseException	getLicenseException	string	取得授權例外
使用權	license	string	授權名稱
訊息	message	string	訊息
總授權	totalLicenses	string	授權總數

取得文件

作業識別碼：: GetDocument

下載文件

參數

名稱	機碼	必要	類型	Description
DocumentId	documentId	True	string	輸入文件 ID
代幣	X-Authorization		string	權杖驗證

取得文件歷史記錄

作業識別碼：: GetDocumentHistory

取得文件的歷程記錄

參數

名稱	機碼	必要	類型	Description
DocumentId	documentId	True	string	輸入文件 ID
代幣	X-Authorization		string	權杖驗證

傳回

名稱	路徑	類型	Description
文件稽核	documentAudit	array of	文件稽核
documentHistoryException	documentHistoryException	string	文件歷程記錄例外狀況
documentId	documentId	string	文件識別碼值
合併文件歷史	mergeDocHistory	array of	合併文件歷史

取得文件狀態

作業識別碼：: GetDocumentStatus

取得文件狀態

參數

名稱	機碼	必要	類型	Description
代幣	X-Authorization		string	權杖驗證
body	body		array of string

傳回

名稱	路徑	類型	Description
		array of object
documentId	documentId	string	文件識別碼值
documentStatusException	documentStatusException	string	文件狀態異常
drawerId	drawerId	string	抽屜 ID 值
檔案大小	fileSize	string	檔案大小值
isArchived	isArchived	boolean	是文件已存檔
是簽出	isCheckedOut	boolean	是已出庫的文件
是否已加密	isEncrypted	boolean	文件是否已加密
已歸檔	isFiled	boolean	是文件已歸檔
isInRedaction佇列	isInRedactionQueue	boolean	是密文佇列中的文件
isInTaxsort佇列	isInTaxsortQueue	boolean	是 Taxsort 佇列中的文件
已鎖定	isLocked	boolean	文件是否已鎖定
isOffice文件	isOfficeDocument	boolean	文件是 Office 文件嗎
是已發布	isPublished	boolean	是該文件已發布
正在進行合併	isUndergoingMerging	boolean	是正在合併的文件
localFile	localFile	string	文件是本機檔案嗎
不編輯	noEdit	boolean	沒有編輯值
pages	pages	integer	文件中的頁面
審查	reviewed	boolean	已審核狀態
稅項排序	taxSort	boolean	是文件稅已排序
型別	type	string	檔案類型
版本	version	integer	文件版本

取得文件索引

作業識別碼：: GetDocumentIndexes

擷取文件的索引

參數

名稱	機碼	必要	類型	Description
DocumentId	documentId	True	string	輸入文件 ID
代幣	X-Authorization		string	權杖驗證

傳回

名稱	路徑	類型	Description
		array of object
索引標識	indexId	string	索引識別碼值
索引值	indexValue	string	索引值

取得索引值清單

作業識別碼：: GetListTypeIndexData

取得清單類型索引的所有專案

參數

名稱	機碼	必要	類型	Description
索引標識符	indexId	True	string	輸入索引 ID
代幣	X-Authorization		string	權杖驗證

傳回

名稱	路徑	類型	Description
		array of object
childIndexId	childIndexId	string	子索引識別碼值
childListId	childListId	integer	子清單識別碼值
有孩子	hasChildren	boolean	索引是否有子索引
listEntryId	listEntryId	integer	list 項目標識碼值
listId	listId	integer	list Id 值
value	value	string	value

取得索引的動態規則

作業識別碼：: GetDynamicRulesForIndex

取得針對指定索引設定的動態規則清單

參數

名稱	機碼	必要	類型	Description
索引標識符	indexId	True	string	輸入索引 ID
代幣	X-Authorization		string	權杖驗證

傳回

名稱	路徑	類型	Description
		array of object
condition	condition	string	條件值
dependentIndexId	dependentIndexId	string	相依索引識別碼值
dynamicRuleId	dynamicRuleId	string	動態規則識別碼值
value	value	string	value

取得群組

作業識別碼：: GetGroups

擷取可用於使用者和群組管理的群組

參數

名稱	機碼	必要	類型	Description
代幣	X-Authorization		string	權杖驗證

傳回

名稱	路徑	類型	Description
		array of object
識別碼	id	string	群組 ID 值
藝術碩士	mfa	integer	MFA 值
mfa必填	mfaRequired	integer	mfa 必要值
名稱	name	string	群組名稱值

取得群組文件安全性

作業識別碼：: GetGroupDocumentSecurity

擷取群組檔案安全性

參數

名稱	機碼	必要	類型	Description
GroupName	groupName	True	string	輸入群組名稱
內閣名稱	cabinetName	True	string	輸入機櫃名稱
抽屜名稱	drawerName	True	string	輸入抽屜名稱
代幣	X-Authorization		string	權杖驗證

傳回

名稱	路徑	類型	Description
群組名稱	groupName	string	群組名稱
內閣名稱	cabinetName	string	內閣名稱
抽屜名稱	drawerName	string	抽屜名稱
文件安全	documentSecurity	array of object	文件安全
索引名稱	documentSecurity.indexName	string	索引名稱
文件安全性類型	documentSecurity.docSecurityType	string	文件安全性類型
values	documentSecurity.values	array of string	values
群組文件安全性例外狀況	getGroupDocSecurityException	string	群組文件安全性例外狀況

取得群組權限

作業識別碼：: GetGroupPermissions

取得群組的權限

參數

名稱	機碼	必要	類型	Description
GroupName	groupName		string	輸入群組名稱
代幣	X-Authorization		string	權杖驗證

傳回

名稱	路徑	類型	Description
cabinet	cabinet	string	內閣名稱
新增	cabinetPermissions.add	boolean	新增權限
刪除	cabinetPermissions.delete	boolean	刪除權限
否認	cabinetPermissions.deny	boolean	拒絕權限
編輯	cabinetPermissions.edit	boolean	編輯權限
䶳	cabinetPermissions.lookUp	boolean	查詢權限
讀取	cabinetPermissions.read	boolean	讀取權限
抽屜權限	drawerPermissions	array of object	抽屜權限
抽屜	drawerPermissions.drawer	string	抽屜名稱
新增	drawerPermissions.permission.add	boolean	新增權限
刪除	drawerPermissions.permission.delete	boolean	刪除權限
否認	drawerPermissions.permission.deny	boolean	拒絕權限
編輯	drawerPermissions.permission.edit	boolean	編輯權限
䶳	drawerPermissions.permission.lookUp	boolean	查詢權限
讀取	drawerPermissions.permission.read	boolean	讀取權限
groupName	groupName	string	群組名稱
groupPermissionException	groupPermissionException	string	群組權限例外

合併 PDF 的

作業識別碼：: MergePDF

將 PDF 檔案合併在一起

參數

名稱	機碼	必要	類型	Description
代幣	X-Authorization		string	權杖驗證
body	body		array of string

傳回

response: string

建立使用者

作業識別碼：: CreateUsers

將 GoFileRoom 和 ClientFlow 使用者建立到系統中

參數

名稱	機碼	類型	Description
用戶類型	userType	string	輸入使用者類型
代幣	X-Authorization	string	權杖驗證
帳戶到期日期	AccountExpiresDate	string	輸入帳戶到期日
已停用註解	DisabledComments	string	輸入已停用的註解
全名	FullName	string	使用者全名
Groups	Groups	array of string	Groups
IsAccount到期	IsAccountExpires	string	指定 true 或 false
是前進流動	IsAdvanceFlow	string	指定 true 或 false
IsAllowAccessToReports	IsAllowAccessToReports	string	指定 true 或 false
是允許離線	IsAllowOffline	string	指定 true 或 false
已停用	IsDisabled	string	指定 true 或 false
是堅流	IsFirmFlow	string	指定 true 或 false
IsFirmFlowNotificationGroup	IsFirmFlowNotificationGroup	string	指定 true 或 false
IsFirmFlowNotificationUser	IsFirmFlowNotificationUser	string	指定 true 或 false
伊斯姆法	IsMfa	string	指定 true 或 false
IsUser管理	IsUserAdministration	string	指定 true 或 false
IsWorkflowManager使用者	IsWorkflowManagerUser	string	指定 true 或 false
授權類型	LicenseType	string	輸入授權類型
登入名稱	LoginName	string	輸入登入名稱
經理電子郵件	ManagerEmail	string	輸入經理電子郵件
密碼	Password	string	輸入密碼
Allow	Allow	array of string	Allow
Deny	Deny	array of string	Deny
IsAllowAll	IsAllowAll	string	指定 true 或 false
是拒絕全部	IsDenyAll	string	指定 true 或 false
ReportType	ReportType	string	指定 true 或 false
上傳位置	UploadLocation	string	輸入上傳位置

傳回

名稱	路徑	類型	Description
createUserException	createUserException	string	create 使用者例外狀況
是創建的	isCreated	boolean	使用者是否已建立
mfa例外狀況	mfaException	string	mfa 例外狀況
userId	userId	string	user Id 值

建立工作流程

作業識別碼：: CreateWorkflow

建立工作流程

參數

名稱	機碼	必要	類型	Description
代幣	X-Authorization		string	權杖驗證
抽屜名稱	Drawer		string	抽屜名稱
服務類型	ServiceType		string	服務類型
資料夾識別碼	folderId		string	資料夾識別碼
客戶名稱	ClientName		string	客戶名稱
客戶編號	ClientNumber		string	客戶編號
參與類型	EngagementType		string	參與類型
圖片	PIC		string	圖片
年	Year		string	年
期末	PeriodEnd		string	期末
工作流程名稱	workflowName		string	工作流程名稱
Description	description	True	string	Description
狀態名稱	statusName		string	狀態名稱
可交付的動作	action		string	可交付的動作
當前到期日	currentduedate		string	當前到期日
原定截止日期	originalduedate		string	原定截止日期
可交付成果表單	form		string	可交付成果表單
送貨方式	Delivery		string	送貨方式
目的地	Destination		string	目的地
來源文件	sourceDocument		string	來源文件
附註動作	action		string	附註動作
註解類型	noteType		string	註解類型
附註訊息	note		string	附註訊息
資訊欄位名稱	name		string	資訊欄位名稱
資訊欄位值	value		string	資訊欄位值
負責領域	ResponsibleField		string	負責領域
負責欄位值	value		string	負責欄位值

傳回

名稱	路徑	類型	Description
備案編號	filingId	integer	備案編號
錯誤註解	errorComment	string	錯誤註解
地位	status	boolean	地位
errorMessage	errorMessage	array of string	errorMessage

建立文件

作業識別碼：: CreateDocument

建立具有索引的文件記錄

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
抽屜識別碼	DrawerId	string	輸入抽屜 ID
索引標識符	IndexId	string	輸入索引識別碼
索引值	IndexValue	string	輸入索引值

傳回

名稱	路徑	類型	Description
documentId	documentCreate.documentId	string	文件識別碼值
errorMessage	documentCreate.errorMessage	string	錯誤訊息
errorMessage	indexValidation.errorMessage	string	錯誤訊息
錯誤	indexValidation.errors	array of	錯誤
是有效	indexValidation.isValid	boolean	文件有效嗎

建立群組

作業識別碼：: CreateGroup

建立權限群組

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
AccessToApproveDocsOnly	AccessToApproveDocsOnly	string	指定 true 或 false
AllowAccessToReports	AllowAccessToReports	string	指定 true 或 false
評論	Comments	string	輸入評論
啟用Mfa	EnableMfa	string	指定 true 或 false
強制執行 MfaForUsers	EnforceMfaForUsers	string	指定 true 或 false
FirmFlowRouting通知	FirmFlowRoutingNotification	string	指定 true 或 false
FullAccessToDocTracking	FullAccessToDocTracking	string	指定 true 或 false
GroupName	GroupName	string	輸入群組名稱
Mfa必填	MfaRequired	string	指定 true 或 false
PermissonToApproveDocs	PermissonToApproveDocs	string	指定 true 或 false
Allow	Allow	array of string	Allow
Deny	Deny	array of string	Deny
IsAllowAll	IsAllowAll	string	指定 true 或 false
是拒絕全部	IsDenyAll	string	指定 true 或 false
ReportType	ReportType	string	指定 true 或 false
上傳位置	UploadLocation	string	輸入上傳位置
使用者	Users	array of string	使用者

傳回

名稱	路徑	類型	Description
createGroup例外狀況	createGroupException	string	建立群組例外狀況
groupId	groupId	string	群組識別碼值
是創建的	isCreated	boolean	該群組是否已建立
mfa例外狀況	mfaException	string	MFA 狀態

按交付項目 V2 跟踪報告

作業識別碼：: TrackingReportByDeliverableV2

DeliverableV2 的追蹤報告

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
抽屜 ID	DrawerId	string	抽屜 ID
服務類型	ServiceType	string	服務類型
參與類型	EngagementType	string	參與類型
Workflow	Workflow	string	Workflow
目前步驟	CurrentStep	string	目前步驟
圖片	PIC	string	圖片
指派至	AssignedTo	string	指派至
指派日期	AssignedOn	string	指派日期
工作流程說明	WorkflowDescription	string	工作流程說明
僅限進行中	InProcessOnly	string	僅限進行中
地位	Status	string	地位
Priority	Priority	string	Priority
收稿日期	ReceivedOn	string	收稿日期
完成日期	CompletedOn	string	完成日期
發送時間	SentOn	string	發送時間
負責	Responsible	string	負責
作業歷史	AssignmentHistory	string	作業歷史
收件者	ReceivedFrom	string	收件者
發送至	SentTo	string	發送至
完成者	CompletedBy	string	完成者
有責任的	Accountable	string	有責任的
當前到期日	CurrentDueDate	string	當前到期日
原定截止日期	OriginalDueDate	string	原定截止日期
延長日期	DateExtended	string	延長日期
步調天數	DaysAtStep	string	步調天數
步進總天數	TotalDaysAtStep	string	步進總天數
路由之間的天數	DaysBetweenRoutings	string	路由之間的天數
處理中總天數	TotalDaysInProcess	string	處理中總天數
路由詳細資料	RoutingDetails	string	路由詳細資料
上次更新	LastUpdated	string	上次更新
資訊欄位	InformationFields	array of string	資訊欄位
Indexes	Indexes	array of string	Indexes
頁碼	PageNumber	string	頁碼

傳回

名稱	路徑	類型	Description
記錄總數	totalRecords	integer	記錄總數
頁碼	pageNumber	string	頁碼
頁面大小	pageSize	integer	頁面大小
總頁數	totalPages	integer	總頁數
firmFlowReport回應	firmFlowReportResponse	array of object	firmFlowReport回應
客戶名稱	firmFlowReportResponse.clientName	string	客戶名稱
客戶編號	firmFlowReportResponse.clientNumber	string	客戶編號
抽屜 ID	firmFlowReportResponse.drawerId	string	抽屜 ID
服務類型	firmFlowReportResponse.serviceType	string	服務類型
參與類型	firmFlowReportResponse.engagementType	string	參與類型
Workflow	firmFlowReportResponse.workflow	string	Workflow
目前步驟	firmFlowReportResponse.currentStep	string	目前步驟
圖片	firmFlowReportResponse.pic	string	圖片
指派至	firmFlowReportResponse.assignedTo	string	指派至
指派日期	firmFlowReportResponse.assignedOn	string	指派日期
年	firmFlowReportResponse.year	string	年
期末	firmFlowReportResponse.periodEnd	string	期末
工作流程說明	firmFlowReportResponse.workflowDescription	string	工作流程說明
Progress	firmFlowReportResponse.progress	string	Progress
地位	firmFlowReportResponse.status	string	地位
Priority	firmFlowReportResponse.priority	string	Priority
電子申報是或否	firmFlowReportResponse.eFileYesOrNo	string	電子申報是或否
擴展是或否	firmFlowReportResponse.extendedYesOrNo	string	擴展是或否
收稿日期	firmFlowReportResponse.receivedOn	string	收稿日期
完成日期	firmFlowReportResponse.completedOn	string	完成日期
發送時間	firmFlowReportResponse.sentOn	string	發送時間
交付項目	firmFlowReportResponse.deliverables	string	交付項目
負責	firmFlowReportResponse.responsible	string	負責
作業歷史	firmFlowReportResponse.assignmentHistory	string	作業歷史
收件者	firmFlowReportResponse.receivedFrom	string	收件者
發送至	firmFlowReportResponse.sentTo	string	發送至
完成者	firmFlowReportResponse.completedBy	string	完成者
有責任的	firmFlowReportResponse.accountable	string	有責任的
當前到期日	firmFlowReportResponse.currentDueDate	string	當前到期日
原定截止日期	firmFlowReportResponse.originalDueDate	string	原定截止日期
路由註釋	firmFlowReportResponse.routingNotes	string	路由註釋
PIC 是或否	firmFlowReportResponse.picYesOrNo	string	PIC 是或否
指派給是或否	firmFlowReportResponse.assignedToYesOrNo	string	指派給是或否
延長日期	firmFlowReportResponse.dateExtended	string	延長日期
步調天數	firmFlowReportResponse.daysAtStep	string	步調天數
步進總天數	firmFlowReportResponse.totalDaysAtStep	string	步進總天數
路由之間的天數	firmFlowReportResponse.daysBetweenRoutings	string	路由之間的天數
處理中總天數	firmFlowReportResponse.totalDaysInProcess	string	處理中總天數
資料夾 ID	firmFlowReportResponse.folderID	string	資料夾 ID
備案編號	firmFlowReportResponse.filingID	string	備案編號
先前備案 ID	firmFlowReportResponse.priorFilingID	string	先前備案 ID
上次更新	firmFlowReportResponse.lastUpdated	string	上次更新
資訊欄位	firmFlowReportResponse.informationFields	array of object	資訊欄位
名稱	firmFlowReportResponse.informationFields.name	string	名稱
value	firmFlowReportResponse.informationFields.value	string	value
路由摘要	firmFlowReportResponse.routingSummary	array of	路由摘要
responsibleUser或群組	firmFlowReportResponse.responsibleUserOrGroups	array of	responsibleUser或群組
取得 FirmFlow 例外狀況	getFirmFlowException	string	取得 FirmFlow 例外狀況

文件搜尋

作業識別碼：: DocumentSearch

將使用者有權存取的所有文件載入指定的抽屜中。

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
抽屜識別碼	DrawerId	string	輸入抽屜 ID
索引標識符	IndexId	string	輸入索引識別碼
索引值	IndexValue	string	輸入索引值
列數	NumberOfRows	integer	輸入列數
頁碼	PageNumber	integer	輸入頁碼
排序欄位	SortField	string	輸入排序欄位
SortOrder	SortOrder	string	輸入排序順序

傳回

名稱	路徑	類型	Description
文件標識符	documentIds	array of string	文件標識符
文件搜尋計數	documentSearchCount	integer	文件搜尋計數

文件重新索引

作業識別碼：: DocumentReindex

重新索引文件

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
文件標識符	DocumentIds	array of string	文件標識符
索引標識符	IndexId	string	輸入索引識別碼
索引值	IndexValue	string	輸入索引值

傳回

名稱	路徑	類型	Description
		array of object
documentId	documentId	string	文件識別碼值
isReIndexed	isReIndexed	boolean	是文件重新索引
reIndexDocumentException	reIndexDocumentException	string	reIndex 文件異常

新增主要交付項目

作業識別碼：: AddMasterDeliverable

新增主要交付項目

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
交付項目名稱	deliverableName	string	交付項目名稱
到期日	dueDate	string	到期日
第一次擴展	firstExtension	string	第一次擴展
第二次擴展	secondExtension	string	第二次擴展
第三次延期	thirdExtension	string	第三次延期
日曆或財政	calenderOrFiscal	string	日曆或財政
Extension	extension	integer	Extension
服務類型	ServiceType	string	服務類型
抽屜名稱	DrawerName	string	抽屜名稱

傳回

名稱	路徑	類型	Description
已儲存	isSaved	boolean	已儲存
回應訊息	responseMessage	string	回應訊息

獲取報告列表

作業識別碼：: GetListOfReports

擷取可用於使用者管理的報告

參數

名稱	機碼	必要	類型	Description
代幣	X-Authorization		string	權杖驗證

傳回

名稱	路徑	類型	Description
reports	reports	array of object	reports
報告名稱	reports.reportName	array of string	報告名稱
報告類型	reports.reportType	string	報表類型值
reportsException	reportsException	string	reports 例外狀況值

獲取抽屜

作業識別碼：: GetDrawers

擷取登入使用者可存取的抽屜

參數

名稱	機碼	必要	類型	Description
代幣	X-Authorization		string	權杖驗證

傳回

名稱	路徑	類型	Description
		array of object
drawerID	drawerID	string	抽屜 ID 值
抽屜名稱	drawerName	string	抽屜名稱值
新增	permissions.add	boolean	增加價值
刪除	permissions.delete	boolean	刪除值
編輯	permissions.edit	boolean	編輯值
查找管理	permissions.lookupManagement	boolean	lookupManagement 值
檢視表	permissions.view	boolean	查看價值

獲取用戶

作業識別碼：: GetUsers

擷取登入使用者的 GFR 使用者

參數

名稱	機碼	必要	類型	Description
用戶類型	userType		string	輸入使用者類型
代幣	X-Authorization		string	權杖驗證

傳回

名稱	路徑	類型	Description
		array of object
是活躍的	isActive	boolean	使用者是否作用中
登入 ID	loginId	string	登入 ID 值

獲取用戶信息

作業識別碼：: GetUserInfo

獲取 GFR 用戶信息

參數

名稱	機碼	必要	類型	Description
代幣	X-Authorization		string	權杖驗證
登入名稱	LoginName	True	string	輸入登錄名稱
用戶類型	UserType	True	string	選取 [使用者類型]

傳回

名稱	路徑	類型	Description
創建日期	createDate	string	創建日期
由...創建	createdBy	string	由...創建
說明	description	string	說明
停用	disabled	integer	停用
disabledBy管理員	disabledByAdmin	boolean	disabledBy管理員
電子郵件通知	emailNotify	boolean	電子郵件通知
電子郵件通知事件管理群組	emailNotifyEventMgmtGroups	boolean	電子郵件通知事件管理群組
電子郵件通知事件管理使用者	emailNotifyEventMgmtUsers	boolean	電子郵件通知事件管理使用者
電子郵件通知群組	emailNotifyGroup	boolean	電子郵件通知群組
強制密碼變更	forcePasswordChange	boolean	強制密碼變更
全名	fullName	string	全名
hasDrawerSetupRights	hasDrawerSetupRights	string	hasDrawerSetupRights
isAdmin	isAdmin	integer	isAdmin
isManager	isManager	integer	isManager
licenseType	licenseType	string	licenseType
位置標識碼	locationID	string	位置標識碼
登入ID	loginID	string	登入ID
managerFullName	managerFullName	string	managerFullName
managerId	managerId	string	managerId
managerLoginId	managerLoginId	string	managerLoginId
oberon用戶	oberonUser	integer	oberon用戶
離線	offline	boolean	離線
密碼變更日期	passwordChangeDate	string	密碼變更日期
passwordChangeInterval	passwordChangeInterval	integer	passwordChangeInterval
passwordExpireDate	passwordExpireDate	string	passwordExpireDate
reports	reports	boolean	reports
特徵標記	signature	string	特徵標記
系統管理員	systemAdmin	boolean	系統管理員
稅務流程	taxFlow	boolean	稅務流程
使用者管理	userAdministration	integer	使用者管理
使用者識別碼	userID	string	使用者識別碼
workflowManager使用者	workflowManagerUser	boolean	workflowManager使用者

獲取用戶信息 V2

作業識別碼：: GetUserInfoV2

取得使用者資訊

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
登入名稱	LoginName	string	登入名稱
使用者類型	UserType	string	使用者類型

傳回

名稱	路徑	類型	Description
使用者識別碼	userID	string	使用者識別碼
登入 ID	loginID	string	登入 ID
全名	fullName	string	全名
建立日期	createDate	string	建立日期
作者	createdBy	string	作者
Description	description	string	Description
Disabled	disabled	integer	Disabled
由管理員停用	disabledByAdmin	boolean	由管理員停用
密碼到期日期	passwordExpireDate	string	密碼到期日期
強制更改密碼	forcePasswordChange	boolean	強制更改密碼
密碼變更日期	passwordChangeDate	string	密碼變更日期
密碼變更間隔	passwordChangeInterval	integer	密碼變更間隔
授權類型	licenseType	string	授權類型
Offline	offline	boolean	Offline
報告	reports	boolean	報告
系統管理員	systemAdmin	boolean	系統管理員
Signature	signature	string	Signature
位置標識碼	locationID	string	位置標識碼
具有抽屜設定權限	hasDrawerSetupRights	string	具有抽屜設定權限
稅收流程	taxFlow	boolean	稅收流程
電子郵件通知	emailNotify	boolean	電子郵件通知
電子郵件通知群組	emailNotifyGroup	boolean	電子郵件通知群組
電子郵件通知事件管理使用者	emailNotifyEventMgmtUsers	boolean	電子郵件通知事件管理使用者
電子郵件通知事件管理群組	emailNotifyEventMgmtGroups	boolean	電子郵件通知事件管理群組
入口網站使用者管理	portalUserAdministration	boolean	入口網站使用者管理
內部使用者管理	internalUserAdministration	boolean	內部使用者管理
工作流程管理員使用者	workflowManagerUser	boolean	工作流程管理員使用者
管理員識別碼	managerId	string	管理員識別碼
管理員登入ID	managerLoginId	string	管理員登入ID
經理全名	managerFullName	string	經理全名
是經理	isManager	integer	是經理
Oberon 用戶	oberonUser	integer	Oberon 用戶
是管理員	isAdmin	integer	是管理員
上次登入	lastLogin	string	上次登入
groups	groups	array of string	groups

登出

作業識別碼：: Logout

登出應用程式

參數

名稱	機碼	必要	類型	Description
代幣	X-Authorization		string	權杖驗證

傳回

名稱	路徑	類型	Description
is登出成功	isLogoutSuccess	boolean	登出是否成功

登錄

作業識別碼：: Login

將使用者登入應用程式

參數

名稱	機碼	必要	類型	Description
登入名稱	LoginName	True	string	輸入登入名稱
密碼	Password	True	password	輸入密碼

傳回

名稱	路徑	類型	Description
authSuccess	authSuccess	boolean	驗證成功
authenticationResponse	authenticationResponse	string	authentication 回應值
customerId	customerId	string	customer Id 值
錯誤代碼	errorCode	string	錯誤代碼值
idleSessionTimeout分鐘	idleSessionTimeoutMinutes	integer	閒置工作階段逾時分鐘數
loneStarFirmId	loneStarFirmId	string	孤星公司 ID
孤星已驗證	loneStarValidated	boolean	孤星驗證
Token	token	string	代幣價值
userId	userId	string	user Id 值
使用者名稱	userName	string	使用者名稱值

發佈文件狀態

作業識別碼：: PublishDocumentStatus

從 ClientFlow 發佈或取消發佈文件。

參數

名稱	機碼	必要	類型	Description
DocumentId	documentId	True	string	輸入文件 ID
代幣	X-Authorization		string	權杖驗證
是已發布	IsPublished	True	string	指定 true 或 false

傳回

名稱	路徑	類型	Description
		array of object
documentException	documentException	string	文件例外狀況
documentId	documentId	string	文件識別碼值
是已發布	isPublished	boolean	是該文件已發布

稅務排序文件

作業識別碼：: TaxsortDocument

Taxsort PDF 文件

參數

名稱	機碼	必要	類型	Description
代幣	X-Authorization		string	權杖驗證
body	body		array of string

傳回

名稱	路徑	類型	Description
		array of object
documentId	documentId	string	文件識別碼值
isTax已排序	isTaxSorted	boolean	文件是否為 TaxSorted
taxsortDocumentException	taxsortDocumentException	string	taxsort 文件異常

索引查閱清單尋找

作業識別碼：: IndexLookupListFind

此方法設計用於自動完成欄位。

參數

名稱	機碼	必要	類型	Description
索引標識碼	indexId	True	string	輸入索引 ID
代幣	X-Authorization		string	權杖驗證
動作類型	ActionType		integer	輸入動作類型
Count	Count		integer	輸入計數
索引值	IndexValue		string	輸入索引值
搜尋類型	SearchType		integer	輸入搜尋類型

傳回

名稱	路徑	類型	Description
		array of object
索引標識	index.indexId	string	索引識別碼值
索引值	index.indexValue	string	索引值
linked索引	linkedIndexes	array of object	linked索引
索引標識	linkedIndexes.indexId	string	索引標識
索引值	linkedIndexes.indexValue	string	索引值

編輯主要交付項目

作業識別碼：: EditMasterDeliverable

編輯主要交付項目

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
目前可交付作業名稱	currentdeliverableName	string	目前可交付作業名稱
更新可傳送作業名稱	updatedeliverableName	string	更新可傳送作業名稱
到期日	dueDate	string	到期日
第一次擴展	firstExtension	string	第一次擴展
第二次擴展	secondExtension	string	第二次擴展
第三次延期	thirdExtension	string	第三次延期
日曆或財政	calenderOrFiscal	string	日曆或財政
Extension	extension	integer	Extension
服務類型	serviceType	string	服務類型
抽屜名稱	drawerName	string	抽屜名稱

傳回

名稱	路徑	類型	Description
更新狀態	isUpdated	boolean	更新狀態
回應訊息	responseMessage	string	回應訊息

編輯工作流程

作業識別碼：: EditWorkflow

編輯工作流程

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
備案編號	filingId	integer	備案編號
客戶名稱	ClientName	string	客戶名稱
客戶編號	ClientNumber	string	客戶編號
參與類型	EngagementType	string	參與類型
圖片	PIC	string	圖片
年	Year	string	年
期末	PeriodEnd	string	期末
交付項目名稱	action	string	交付項目名稱
當前到期日	currentduedate	string	當前到期日
原定截止日期	originalduedate	string	原定截止日期
附件	form	string	附件
附註動作	action	string	附註動作
註解類型	noteType	string	註解類型
noteid	noteid	array of string	noteid
附註訊息	note	string	附註訊息
資訊欄位名稱	name	string	資訊欄位名稱
資訊欄位值	value	string	資訊欄位值
送貨方式	Delivery	string	送貨方式
目的地	Destination	string	目的地
來源文件	sourceDocument	string	來源文件
負責領域	responsibleField	string	負責領域
指派至	value	string	指派至
重新索引文件	reindexDocs	boolean	重新索引文件

傳回

名稱	路徑	類型	Description
備案編號	filingId	integer	備案編號
錯誤註解	errorComment	string	錯誤註解
地位	status	boolean	地位
errorMessage	errorMessage	array of object	errorMessage
名稱	errorMessage.name	string	名稱
地位	errorMessage.status	boolean	地位
錯誤註解	errorMessage.errorComment	string	錯誤註解

複製文件

作業識別碼：: CopyDocument

複製文件

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
文件標識符	DocumentIds	array of string	文件標識符
索引標識符	IndexId	string	輸入索引識別碼
索引值	IndexValue	string	輸入索引值

傳回

名稱	路徑	類型	Description
		array of object
copyDocumentException	copyDocumentException	string	複製文件例外狀況
documentId	documentId	string	文件識別碼值
是複製的	isCopied	boolean	文件是否被複製
newDocumentId	newDocumentId	string	新文件ID

設定使用者文件安全性

作業識別碼：: SetUserDocSecurity

指派使用者檔案安全性許可權

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
內閣名稱	CabinetName	string	輸入機櫃名稱
文件安全類型	DocSecurityType	string	輸入Document Security型別
索引名稱	IndexName	string	輸入索引名稱
行動	Operation	string	進入運營
價值觀	Values	array of string	價值觀
抽屜名稱	DrawerName	string	輸入抽屜名稱
登入 ID	LoginId	string	輸入登入ID

傳回

名稱	路徑	類型	Description
isSetUserDoc安全性	isSetUserDocSecurity	boolean	使用者Document Security是否已套用
登入 ID	loginId	string	登入 ID 值
setUserDocSecurityException	setUserDocSecurityException	string	設定使用者文件安全性例外

設定使用者權限

作業識別碼：: SetUserPermissions

將權限指派給使用者

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
櫥	Cabinet	string	輸入機櫃名稱
加	Add	string	指定 true 或 false
刪除	Delete	string	指定 true 或 false
Deny	Deny	string	指定 true 或 false
Edit	Edit	string	指定 true 或 false
LookUp	LookUp	string	指定 true 或 false
參閱	Read	string	指定 true 或 false
抽屜	Drawer	string	輸入抽屜名稱
加	Add	string	指定 true 或 false
刪除	Delete	string	指定 true 或 false
Deny	Deny	string	指定 true 或 false
Edit	Edit	string	指定 true 或 false
LookUp	LookUp	string	指定 true 或 false
參閱	Read	string	指定 true 或 false
登入 ID	LoginId	string	輸入登入ID

傳回

名稱	路徑	類型	Description
isSetUser權限	isSetUserPermission	boolean	使用者權限是否更新
登入 ID	loginId	string	登入 ID 值
setUserPermissionException	setUserPermissionException	string	設定使用者權限例外

設定群組文件安全性

作業識別碼：: SetGroupDocSecurity

將檔案安全性指派給群組

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
內閣名稱	CabinetName	string	輸入機櫃名稱
文件安全類型	DocSecurityType	string	輸入Document Security型別
索引名稱	IndexName	string	輸入索引名稱
行動	Operation	string	輸入操作類型
價值觀	Values	array of string	價值觀
抽屜名稱	DrawerName	string	輸入抽屜名稱
GroupName	GroupName	string	輸入群組名稱

傳回

名稱	路徑	類型	Description
groupName	groupName	string	群組名稱值
isSetGroupDoc安全性	isSetGroupDocSecurity	boolean	Document Security是否已設定
setGroupDocSecurityException	setGroupDocSecurityException	string	群組文件安全性例外狀況

設定群組權限

作業識別碼：: SetGroupPermissions

將權限指派給群組

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
櫥	Cabinet	string	輸入機櫃名稱
加	Add	string	指定 true 或 false
刪除	Delete	string	指定 true 或 false
Deny	Deny	string	指定 true 或 false
Edit	Edit	string	指定 true 或 false
LookUp	LookUp	string	指定 true 或 false
參閱	Read	string	指定 true 或 false
抽屜	Drawer	string	輸入抽屜名稱
加	Add	string	指定 true 或 false
刪除	Delete	string	指定 true 或 false
Deny	Deny	string	指定 true 或 false
Edit	Edit	string	指定 true 或 false
LookUp	LookUp	string	指定 true 或 false
參閱	Read	string	指定 true 或 false
GroupName	GroupName	string	輸入群組名稱

傳回

名稱	路徑	類型	Description
groupId	groupId	string	群組識別碼值
groupPermissionException	groupPermissionException	string	群組權限例外
isSet	isSet	boolean	是否已套用權限

路由工作流程 V2

作業識別碼：: RouteWorkflowV2

路由工作流程 V2

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
歸檔標識符	filingId	array of integer	歸檔標識符
當前步驟	CurrentStep	array of string	當前步驟
完成	Complete	boolean	完成
完成日期	CompletedDate	string	完成日期
後續步驟	NextStep	string	後續步驟
指派至	AssignedTo	string	指派至
分配日期	AssignedDate	string	分配日期
Priority	Priority	string	Priority
地位	Status	string	地位
路由註釋	RoutingNote	string	路由註釋
電子郵件通知	emailNotify	boolean	電子郵件通知

傳回

名稱	路徑	類型	Description
備案編號	filingId	string	備案編號
已路由	isRouted	boolean	已路由

驗證權杖

作業識別碼：: ValidateToken

驗證權杖狀態

參數

名稱	機碼	必要	類型	Description
代幣	X-Authorization		string	權杖驗證

傳回

response: boolean

驗證索引

作業識別碼：: ValidateIndexes

檢查提供的索引是否有效。

參數

名稱	機碼	類型	Description
代幣	X-Authorization	string	權杖驗證
抽屜識別碼	DrawerId	string	輸入抽屜 ID
索引標識符	IndexId	string	輸入索引識別碼
索引值	IndexValue	string	輸入索引值

傳回

名稱	路徑	類型	Description
errorMessage	errorMessage	string	錯誤訊息
錯誤	errors	array of	錯誤
是有效	isValid	boolean	索引是否有效

共用方式為

GoFileRoom

先決條件

如何取得憑證？

正在建立連線

預設

節流限制

動作

依可交付成果取得 FirmFlow 資料

參數

傳回

依工作流程追蹤報告

參數

傳回

修改使用者

參數

傳回

修改群組

參數

傳回

刪除主要交付項目

參數

傳回

刪除使用者

參數

傳回

刪除工作流程

參數

傳回

刪除文件

參數

傳回

取得 LookupList 值

參數

傳回

取得上傳位置

參數

傳回

取得主交付成果

參數

傳回

取得使用者文件安全性

參數

傳回

取得使用者權限

參數

傳回

取得子索引

參數

傳回

取得密碼原則

參數

傳回

取得抽取器索引

參數

傳回

取得授權

參數

傳回

取得文件

參數

取得文件歷史記錄

參數

傳回

取得文件狀態

參數

傳回

取得文件索引

參數

傳回

取得索引值清單

參數

傳回

取得索引的動態規則

參數

傳回

取得群組

參數

傳回

取得群組文件安全性