PaySpace （獨立發行者）（預覽版）

我們強大的解決方案允許您訪問您的員工數據，以便在您的業務環境中使用。所有支援的端點都集中在一個地方，並準備好整合到您的解決方案中。

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

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

連絡人
名稱	Mint PaySpace 支持
URL	https://za.mintgroup.net/
Email	payspace.support@mintgroup.net

連接器中繼資料
Publisher	鑄幣廠管理技術
網站	https://www.payspace.com
隱私策略	https://www.payspace.com/privacy-policy/
類別	人力資源

節流限制

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

動作

上傳員工照片	根據指定的 EmployeeId 更新單一員工相片。
下載員工照片	根據指定的 EmployeeId 擷取單一員工相片。
刪除單一員工附件記錄	根據指定的 AttachmentId 刪除單一員工附件記錄。
刪除單一銀行詳細資料記錄	根據指定的 BankDetailId 擷取員工銀行詳細資料。
取得員工附件記錄的集合	根據指定的company_id擷取作用中員工附件記錄的清單。
取得員工集合	根據指定的公司識別碼，擷取截至今天日期的作用中員工履歷詳細資料清單。
取得單一倉位記錄	根據指定的 EmployeePositionId 擷取員工職位記錄。
取得單一員工記錄	根據指定的 EmployeeId 擷取員工資訊。
取得單一員工附件記錄	根據指定的 AttachmentId 擷取員工附件資訊。
取得單一銀行詳細記錄	根據指定的 BankDetailId 擷取員工銀行詳細資料。
取得截至生效日期的員工集合	擷取截至指定生效日期並根據指定公司識別碼的有效員工履歷詳細資料清單。
取得截至生效日期的頭寸集合	根據指定的company_id，擷取截至指定生效日期的員工職位記錄清單。
建立單一僱傭狀態記錄	為指定的 EmployeeNumber 建立單一員工僱傭狀態記錄。
建立單一員工記錄	為指定的 EmployeeNumber 建立單一員工記錄。
建立單一員工附件記錄	為指定的 EmployeeNumber 建立單一附件記錄。
建立單一職位記錄	為指定的 EmployeeNumber 建立單一員工職位記錄。
建立單一銀行詳細資料記錄	為指定的 EmployeeNumber 建立單一員工銀行詳細資料記錄。
更新單一員工記錄	根據指定的 EmployeeId 更新單一員工記錄。
更新單一員工附件記錄	根據指定的 AttachmentId 更新單一附件記錄。
更新單一職位記錄	根據指定的 EmployeePositionId 更新單一員工職位記錄。
更新單一銀行詳細資料記錄	根據指定的 BankdetailId 更新單一銀行詳細資料記錄。
獲取就業狀況集合	根據指定的公司識別碼擷取目前作用中員工就業狀態的清單。
獲取所有就業狀況的集合	根據指定的公司識別碼擷取所有員工僱傭狀態的清單。
獲取職位集合	擷取截至今天日期並根據指定company_id的員工職位記錄清單。
獲取銀行詳細記錄的集合	根據指定的company_id擷取員工銀行詳細資料清單。

上傳員工照片

作業識別碼：: UploadEmployeePhoto

根據指定的 EmployeeId 更新單一員工相片。

參數

名稱	機碼	必要	類型	Description
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
{{員工編號}}	EmployeeId	True	integer	The EmployeeId
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數

傳回

名稱	路徑	類型	Description
@odata.上下文	@odata.context	string	@odata.context
成功	Success	boolean	成功

下載員工照片

作業識別碼：: DownloadEmployeePhoto

根據指定的 EmployeeId 擷取單一員工相片。

參數

名稱	機碼	必要	類型	Description
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
{{員工編號}}	EmployeeId	True	integer	The EmployeeId
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數

傳回

名稱	路徑	類型	Description
@odata.上下文	@odata.context	string	@odata.context
成功	Success	boolean	成功

刪除單一員工附件記錄

作業識別碼：: DeleteASingleEmployeeAttachmentRecord

根據指定的 AttachmentId 刪除單一員工附件記錄。

參數

名稱	機碼	必要	類型	Description
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
附件標識符	AttachmentId	True	integer	{{附件Id}}The AttachmentId
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數

傳回

response: object

刪除單一銀行詳細資料記錄

作業識別碼：: DeleteASingleBankDetailRecord

根據指定的 BankDetailId 擷取員工銀行詳細資料。

參數

名稱	機碼	必要	類型	Description
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
{{銀行詳細編號}}	BankDetailId	True	integer	{{銀行詳細編號}}The BankDetailId
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數

傳回

response: object

取得員工附件記錄的集合

作業識別碼：: GetACollectionOfEmployeeAttachmentRecords

根據指定的company_id擷取作用中員工附件記錄的清單。

參數

名稱	機碼	必要	類型	Description
{{$attachment-field}} 的選用	$orderby		string	（字串） - 指定傳回專案的順序
可選$top	$top		integer	（integer（$int 32）） - 限制從集合傳回的專案數目
可選$skip	$skip	True	integer	（integer（$int 32）） - 從結果中排除查詢集合的指定項目數
可選$count	$count	True	string	（true/false） - 在回應中傳回總計數
可選$filter	$filter		string	按字段過濾，例如。 “員工編號等式 'Emp01'”
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數

傳回

名稱	路徑	類型	Description
@odata.上下文	@odata.context	string	@odata.context
@odata.計數	@odata.count	integer	@odata.count
value	value	array of object	value
附件標識符	value.AttachmentId	integer	附件標識符
員工編號	value.EmployeeNumber	string	員工編號
Classification	value.Classification	string	Classification
附件說明	value.AttachmentDescription	string	附件說明
AttachmentName	value.AttachmentName	string	AttachmentName
附件網址	value.AttachmentUrl	string	附件網址
Attachment	value.Attachment	string	Attachment
自訂欄位	value.CustomFields	array of object	自訂欄位
Code	value.CustomFields.Code	string	Code
標籤	value.CustomFields.Label	string	標籤
價值觀	value.CustomFields.Value	string	價值觀

取得員工集合

作業識別碼：: GetACollectionOfEmployees

根據指定的公司識別碼，擷取截至今天日期的作用中員工履歷詳細資料清單。

參數

名稱	機碼	必要	類型	Description
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
由 {{$employee-field}} 選用	$orderby		string	（字串） - 指定傳回專案的順序
可選$top	$top		integer	（integer（$int 32）） - 限制從集合傳回的專案數目
可選$skip	$skip		integer	（integer（$int 32）） - 從結果中排除查詢集合的指定項目數
可選$count	$count		string	（true/false） - 在回應中傳回總計數
可選$filter	$filter		string	選用 - 按字段過濾，例如。 “員工編號等式 'Emp01'”
可選$select	$select		string	選擇性（字串） - 僅傳回指定的欄位
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數

傳回

名稱	路徑	類型	Description
@odata.上下文	@odata.context	string	@odata.context
@odata.計數	@odata.count	integer	@odata.count
value	value	array of object	value
EmployeeId	value.EmployeeId	integer	EmployeeId
員工編號	value.EmployeeNumber	string	員工編號
Title	value.Title	string	Title
FirstName	value.FirstName	string	FirstName
姓氏	value.LastName	string	姓氏
偏好名稱	value.PreferredName	string	偏好名稱
娘家名稱	value.MaidenName	string	娘家名稱
MiddleName	value.MiddleName	string	MiddleName
首字母	value.Initials	string	首字母
Email	value.Email	string	Email
生日	value.Birthday	string	生日
HomeNumber	value.HomeNumber	string	HomeNumber
工作編號	value.WorkNumber	string	工作編號
儲存格編號	value.CellNumber	string	儲存格編號
工作延伸	value.WorkExtension	string	工作延伸
語言	value.Language	string	語言
性別	value.Gender	string	性別
MaritalStatus	value.MaritalStatus	string	MaritalStatus
族	value.Race	string	族
Nationality	value.Nationality	string	Nationality
國籍	value.Citizenship	string	國籍
DisabledType （已停用類型）	value.DisabledType	string	DisabledType （已停用類型）
外國國民	value.ForeignNational	boolean	外國國民
DateCreated	value.DateCreated	string	DateCreated
緊急聯絡人名稱	value.EmergencyContactName	string	緊急聯絡人名稱
緊急聯絡電話	value.EmergencyContactNumber	string	緊急聯絡電話
緊急聯絡地址	value.EmergencyContactAddress	string	緊急聯絡地址
是退休	value.IsRetired	boolean	是退休
自訂欄位值	value.CustomFieldValue	string	自訂欄位值
自訂欄位值2	value.CustomFieldValue2	string	自訂欄位值2
Uif豁免	value.UifExemption	string	Uif豁免
Sdl豁免	value.SdlExemption	string	Sdl豁免
Eti豁免	value.EtiExempt	boolean	Eti豁免
影像下載網址	value.ImageDownloadUrl	string	影像下載網址
自訂欄位	value.CustomFields	array of object	自訂欄位
Code	value.CustomFields.Code	string	Code
標籤	value.CustomFields.Label	string	標籤
價值觀	value.CustomFields.Value	string	價值觀
Address	value.Address	array of object	Address
位址標識碼	value.Address.AddressId	integer	位址標識碼
地址類型	value.Address.AddressType	string	地址類型
員工編號	value.Address.EmployeeNumber	string	員工編號
地址欄位1	value.Address.AddressLine1	string	地址欄位1
地址欄位二	value.Address.AddressLine2	string	地址欄位二
地址行 3	value.Address.AddressLine3	string	地址行 3
地址代碼	value.Address.AddressCode	string	地址代碼
地址國家/地區	value.Address.AddressCountry	string	地址國家/地區
省	value.Address.Province	string	省
單位編號	value.Address.UnitNumber	string	單位編號
Complex	value.Address.Complex	string	Complex
街道號碼	value.Address.StreetNumber	string	街道號碼
相同為物理	value.Address.SameAsPhysical	boolean	相同為物理
IsCareof地址	value.Address.IsCareofAddress	boolean	IsCareof地址
中介護理	value.Address.CareOfIntermediary	string	中介護理
特殊服務	value.Address.SpecialServices	string	特殊服務

取得單一倉位記錄

作業識別碼：: GetASinglePositionRecord

根據指定的 EmployeePositionId 擷取員工職位記錄。

參數

名稱	機碼	必要	類型	Description
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
{{員工位置Id}}	EmployeePositionId	True	integer	The EmployeePositionId
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數

傳回

名稱	路徑	類型	Description
@odata.上下文	@odata.context	string	@odata.context
@odata.計數	@odata.count	integer	@odata.count
value	value	array of object	value
員工位置標識符	value.EmployeePositionId	integer	員工位置標識符
員工編號	value.EmployeeNumber	string	員工編號
全名	value.FullName	string	全名
EffectiveDate	value.EffectiveDate	string	EffectiveDate
組織職位	value.OrganizationPosition	string	組織職位
組織位置標識符	value.OrganizationPositionId	integer	組織位置標識符
組織位置與程式碼	value.OrganizationPositionWithCode	string	組織位置與程式碼
職位類型	value.PositionType	string	職位類型
Grade	value.Grade	string	Grade
職業級別	value.OccupationalLevel	string	職業級別
DirectlyReportsPositionOverride	value.DirectlyReportsPositionOverride	string	DirectlyReportsPositionOverride
直接報告職位	value.DirectlyReportsPosition	string	直接報告職位
組織群組	value.OrganizationGroup	string	組織群組
組織群組說明	value.OrganizationGroupDescription	string	組織群組說明
組織群組	value.OrganizationGroups	array of object	組織群組
組織單位標識符	value.OrganizationGroups.OrganizationUnitId	integer	組織單位標識符
ParentOrganizationUnitId	value.OrganizationGroups.ParentOrganizationUnitId	integer	ParentOrganizationUnitId
上傳代碼	value.OrganizationGroups.UploadCode	string	上傳代碼
Description	value.OrganizationGroups.Description	string	Description
成本中心	value.OrganizationGroups.CostCentre	boolean	成本中心
組織層級	value.OrganizationGroups.OrganizationLevel	string	組織層級
群組GlKey	value.OrganizationGroups.GroupGlKey	string	群組GlKey
預算	value.OrganizationGroups.Budget	integer	預算
Reference	value.OrganizationGroups.Reference	string	Reference
經理員工編號	value.OrganizationGroups.ManagerEmployeeNumber	string	經理員工編號
非活躍日期	value.OrganizationGroups.InactiveDate	string	非活躍日期
組織區域	value.OrganizationRegion	string	組織區域
支付點	value.PayPoint	string	支付點
直接下屬員工	value.DirectlyReportsEmployee	string	直接下屬員工
直接報告員工編號	value.DirectlyReportsEmployeeNumber	string	直接報告員工編號
就業類別	value.EmploymentCategory	string	就業類別
就業子類別	value.EmploymentSubCategory	string	就業子類別
系統管理員	value.Administrator	string	系統管理員
管理員員工編號	value.AdministratorEmployeeNumber	string	管理員員工編號
工作流程角色	value.WorkflowRole	string	工作流程角色
總帳	value.GeneralLedger	string	總帳
工會	value.TradeUnion	string	工會
是促銷	value.IsPromotion	boolean	是促銷
名冊	value.Roster	string	名冊
Job	value.Job	string	Job
評論	value.Comments	string	評論
替代位置名稱	value.AltPositionName	string	替代位置名稱
添加日期	value.DateAdded	string	添加日期
位置生效日期	value.PositionEffectiveDate	string	位置生效日期
海關工會	value.CustomTradeUnion	string	海關工會
自訂欄位	value.CustomFields	array of object	自訂欄位
Code	value.CustomFields.Code	string	Code
標籤	value.CustomFields.Label	string	標籤
價值觀	value.CustomFields.Value	string	價值觀

取得單一員工記錄

作業識別碼：: GetASingleEmployeeRecord

根據指定的 EmployeeId 擷取員工資訊。

參數

名稱	機碼	必要	類型	Description
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
{{員工編號}}	EmployeeId	True	integer	The EmployeeId
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數

傳回

名稱	路徑	類型	Description
@odata.上下文	@odata.context	string	@odata.context
EmployeeId	EmployeeId	integer	EmployeeId
員工編號	EmployeeNumber	string	員工編號
Title	Title	string	Title
FirstName	FirstName	string	FirstName
姓氏	LastName	string	姓氏
偏好名稱	PreferredName	string	偏好名稱
娘家名稱	MaidenName	string	娘家名稱
MiddleName	MiddleName	string	MiddleName
首字母	Initials	string	首字母
Email	Email	string	Email
生日	Birthday	string	生日
HomeNumber	HomeNumber	string	HomeNumber
工作編號	WorkNumber	string	工作編號
儲存格編號	CellNumber	string	儲存格編號
工作延伸	WorkExtension	string	工作延伸
語言	Language	string	語言
性別	Gender	string	性別
MaritalStatus	MaritalStatus	string	MaritalStatus
族	Race	string	族
Nationality	Nationality	string	Nationality
國籍	Citizenship	string	國籍
DisabledType （已停用類型）	DisabledType	string	DisabledType （已停用類型）
外國國民	ForeignNational	boolean	外國國民
DateCreated	DateCreated	string	DateCreated
緊急聯絡人名稱	EmergencyContactName	string	緊急聯絡人名稱
緊急聯絡電話	EmergencyContactNumber	string	緊急聯絡電話
緊急聯絡地址	EmergencyContactAddress	string	緊急聯絡地址
是退休	IsRetired	boolean	是退休
自訂欄位值	CustomFieldValue	string	自訂欄位值
自訂欄位值2	CustomFieldValue2	string	自訂欄位值2
Uif豁免	UifExemption	string	Uif豁免
Sdl豁免	SdlExemption	string	Sdl豁免
Eti豁免	EtiExempt	boolean	Eti豁免
影像下載網址	ImageDownloadUrl	string	影像下載網址
自訂欄位	CustomFields	array of object	自訂欄位
Code	CustomFields.Code	string	Code
標籤	CustomFields.Label	string	標籤
價值觀	CustomFields.Value	string	價值觀
Address	Address	array of object	Address
位址標識碼	Address.AddressId	integer	位址標識碼
地址類型	Address.AddressType	string	地址類型
員工編號	Address.EmployeeNumber	string	員工編號
地址欄位1	Address.AddressLine1	string	地址欄位1
地址欄位二	Address.AddressLine2	string	地址欄位二
地址行 3	Address.AddressLine3	string	地址行 3
地址代碼	Address.AddressCode	string	地址代碼
地址國家/地區	Address.AddressCountry	string	地址國家/地區
省	Address.Province	string	省
單位編號	Address.UnitNumber	string	單位編號
Complex	Address.Complex	string	Complex
街道號碼	Address.StreetNumber	string	街道號碼
相同為物理	Address.SameAsPhysical	boolean	相同為物理
IsCareof地址	Address.IsCareofAddress	boolean	IsCareof地址
中介護理	Address.CareOfIntermediary	string	中介護理
特殊服務	Address.SpecialServices	string	特殊服務

取得單一員工附件記錄

作業識別碼：: GetASingleEmployeeAttachmentRecord

根據指定的 AttachmentId 擷取員工附件資訊。

參數

名稱	機碼	必要	類型	Description
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
{{附件Id}}	AttachmentId	True	integer	The AttachmentId
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數

傳回

名稱	路徑	類型	Description
@odata.上下文	@odata.context	string	@odata.context
附件標識符	AttachmentId	integer	附件標識符
員工編號	EmployeeNumber	string	員工編號
Classification	Classification	string	Classification
附件說明	AttachmentDescription	string	附件說明
AttachmentName	AttachmentName	string	AttachmentName
附件網址	AttachmentUrl	string	附件網址
Attachment	Attachment	string	Attachment
自訂欄位	CustomFields	array of object	自訂欄位
Code	CustomFields.Code	string	Code
標籤	CustomFields.Label	string	標籤
價值觀	CustomFields.Value	string	價值觀

取得單一銀行詳細記錄

作業識別碼：: GetASingleBankDetailRecord

根據指定的 BankDetailId 擷取員工銀行詳細資料。

參數

名稱	機碼	必要	類型	Description
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
{{銀行詳細編號}}	BankDetailId	True	integer	The BankDetailId
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數

傳回

名稱	路徑	類型	Description
@odata.上下文	@odata.context	string	@odata.context
BankDetailId	BankDetailId	integer	BankDetailId
員工編號	EmployeeNumber	string	員工編號
PaymentMethod	PaymentMethod	string	PaymentMethod
分割類型	SplitType	string	分割類型
銀行帳戶擁有者	BankAccountOwner	string	銀行帳戶擁有者
銀行帳戶擁有者名稱	BankAccountOwnerName	string	銀行帳戶擁有者名稱
帳戶類型	AccountType	string	帳戶類型
銀行名稱	BankName	string	銀行名稱
銀行分行編號	BankBranchNo	string	銀行分行編號
銀行帳戶編號	BankAccountNo	string	銀行帳戶編號
Reference	Reference	string	Reference
IsMainAccount	IsMainAccount	boolean	IsMainAccount
總數	Amount	integer	總數
評論	Comments	string	評論
迅捷代碼	SwiftCode	string	迅捷代碼
路由代碼	RoutingCode	string	路由代碼
元件標識符	ComponentId	integer	元件標識符

取得截至生效日期的員工集合

作業識別碼：: GetACollectionOfEmployeesAsOfAnEffectiveDate

擷取截至指定生效日期並根據指定公司識別碼的有效員工履歷詳細資料清單。

參數

名稱	機碼	必要	類型	Description
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
生效日期	effectivedate	True	string	生效日期格式為 YYYY-MM-DD。例如。2022-01-15
由 {{$employee-field}} 選用	$orderby		string	（字串） - 指定傳回專案的順序
可選$top	$top		integer	（integer（$int 32）） - 限制從集合傳回的專案數目
可選$skip	$skip	True	integer	（integer（$int 32）） - 從結果中排除查詢集合的指定項目數
可選$count	$count	True	string	（true/false） - 在回應中傳回總計數
可選$filter	$filter		string	按字段過濾，例如。 “員工編號等式 'Emp01'”
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數

傳回

名稱	路徑	類型	Description
@odata.上下文	@odata.context	string	@odata.context
@odata.計數	@odata.count	integer	@odata.count
value	value	array of object	value
EmployeeId	value.EmployeeId	integer	EmployeeId
員工編號	value.EmployeeNumber	string	員工編號
Title	value.Title	string	Title
FirstName	value.FirstName	string	FirstName
姓氏	value.LastName	string	姓氏
偏好名稱	value.PreferredName	string	偏好名稱
娘家名稱	value.MaidenName	string	娘家名稱
MiddleName	value.MiddleName	string	MiddleName
首字母	value.Initials	string	首字母
Email	value.Email	string	Email
生日	value.Birthday	string	生日
HomeNumber	value.HomeNumber	string	HomeNumber
工作編號	value.WorkNumber	string	工作編號
儲存格編號	value.CellNumber	string	儲存格編號
工作延伸	value.WorkExtension	string	工作延伸
語言	value.Language	string	語言
性別	value.Gender	string	性別
MaritalStatus	value.MaritalStatus	string	MaritalStatus
族	value.Race	string	族
Nationality	value.Nationality	string	Nationality
國籍	value.Citizenship	string	國籍
稅務參考編號	value.TaxRefNumber	string	稅務參考編號
Disabled	value.Disabled	boolean	Disabled
DisabledType （已停用類型）	value.DisabledType	string	DisabledType （已停用類型）
種族群體	value.EthnicGroup	string	種族群體
外國國民	value.ForeignNational	boolean	外國國民
群組日期	value.GroupDate	string	群組日期
DateCreated	value.DateCreated	string	DateCreated
緊急聯絡人名稱	value.EmergencyContactName	string	緊急聯絡人名稱
緊急聯絡電話	value.EmergencyContactNumber	string	緊急聯絡電話
緊急聯絡地址	value.EmergencyContactAddress	string	緊急聯絡地址
是模擬員工	value.IsMockEmployee	boolean	是模擬員工
是退休	value.IsRetired	boolean	是退休
自訂欄位值	value.CustomFieldValue	string	自訂欄位值
自訂欄位值2	value.CustomFieldValue2	string	自訂欄位值2
Uif豁免	value.UifExemption	string	Uif豁免
Sdl豁免	value.SdlExemption	string	Sdl豁免
Eti豁免	value.EtiExempt	boolean	Eti豁免
影像下載網址	value.ImageDownloadUrl	string	影像下載網址
自訂欄位	value.CustomFields	array of object	自訂欄位
Code	value.CustomFields.Code	string	Code
標籤	value.CustomFields.Label	string	標籤
價值觀	value.CustomFields.Value	string	價值觀
Address	value.Address	array of object	Address
位址標識碼	value.Address.AddressId	integer	位址標識碼
地址類型	value.Address.AddressType	string	地址類型
員工編號	value.Address.EmployeeNumber	string	員工編號
地址欄位1	value.Address.AddressLine1	string	地址欄位1
地址欄位二	value.Address.AddressLine2	string	地址欄位二
地址行 3	value.Address.AddressLine3	string	地址行 3
地址代碼	value.Address.AddressCode	string	地址代碼
地址國家/地區	value.Address.AddressCountry	string	地址國家/地區
省	value.Address.Province	string	省
單位編號	value.Address.UnitNumber	string	單位編號
Complex	value.Address.Complex	string	Complex
街道號碼	value.Address.StreetNumber	string	街道號碼
相同為物理	value.Address.SameAsPhysical	boolean	相同為物理
IsCareof地址	value.Address.IsCareofAddress	boolean	IsCareof地址
中介護理	value.Address.CareOfIntermediary	string	中介護理
特殊服務	value.Address.SpecialServices	string	特殊服務

取得截至生效日期的頭寸集合

作業識別碼：: GetACollectionOfPositionsAsOfAnEffectiveDate

根據指定的company_id，擷取截至指定生效日期的員工職位記錄清單。

參數

名稱	機碼	必要	類型	Description
{{$employee-field}}	$orderby	True	string	（字串） - 指定傳回專案的順序
可選$top	$top		integer	（integer（$int 32）） - 限制從集合傳回的專案數目
可選$skip	$skip	True	integer	（integer（$int 32）） - 從結果中排除查詢集合的指定項目數
可選$count	$count	True	string	（true/false） - 在回應中傳回總計數
可選$expand	$expand	True	string	選擇性 - 若要傳回 OrganizationGroups 欄位資料，請使用值 'OrganizationGroups'
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
生效日期	effectivedate	True	string	生效日期格式為 YYYY-MM-DD。例如。2022-01-15
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數

傳回

名稱	路徑	類型	Description
@odata.上下文	@odata.context	string	@odata.context
@odata.計數	@odata.count	integer	@odata.count
value	value	array of object	value
員工位置標識符	value.EmployeePositionId	integer	員工位置標識符
員工編號	value.EmployeeNumber	string	員工編號
全名	value.FullName	string	全名
EffectiveDate	value.EffectiveDate	string	EffectiveDate
組織職位	value.OrganizationPosition	string	組織職位
組織位置標識符	value.OrganizationPositionId	integer	組織位置標識符
組織位置與程式碼	value.OrganizationPositionWithCode	string	組織位置與程式碼
職位類型	value.PositionType	string	職位類型
Grade	value.Grade	string	Grade
職業級別	value.OccupationalLevel	string	職業級別
DirectlyReportsPositionOverride	value.DirectlyReportsPositionOverride	string	DirectlyReportsPositionOverride
直接報告職位	value.DirectlyReportsPosition	string	直接報告職位
組織群組	value.OrganizationGroup	string	組織群組
組織群組說明	value.OrganizationGroupDescription	string	組織群組說明
組織群組	value.OrganizationGroups	array of object	組織群組
組織單位標識符	value.OrganizationGroups.OrganizationUnitId	integer	組織單位標識符
ParentOrganizationUnitId	value.OrganizationGroups.ParentOrganizationUnitId	integer	ParentOrganizationUnitId
上傳代碼	value.OrganizationGroups.UploadCode	string	上傳代碼
Description	value.OrganizationGroups.Description	string	Description
成本中心	value.OrganizationGroups.CostCentre	boolean	成本中心
組織層級	value.OrganizationGroups.OrganizationLevel	string	組織層級
群組GlKey	value.OrganizationGroups.GroupGlKey	string	群組GlKey
預算	value.OrganizationGroups.Budget	integer	預算
Reference	value.OrganizationGroups.Reference	string	Reference
經理員工編號	value.OrganizationGroups.ManagerEmployeeNumber	string	經理員工編號
非活躍日期	value.OrganizationGroups.InactiveDate	string	非活躍日期
組織區域	value.OrganizationRegion	string	組織區域
支付點	value.PayPoint	string	支付點
直接下屬員工	value.DirectlyReportsEmployee	string	直接下屬員工
直接報告員工編號	value.DirectlyReportsEmployeeNumber	string	直接報告員工編號
就業類別	value.EmploymentCategory	string	就業類別
就業子類別	value.EmploymentSubCategory	string	就業子類別
系統管理員	value.Administrator	string	系統管理員
管理員員工編號	value.AdministratorEmployeeNumber	string	管理員員工編號
工作流程角色	value.WorkflowRole	string	工作流程角色
總帳	value.GeneralLedger	string	總帳
工會	value.TradeUnion	string	工會
是促銷	value.IsPromotion	boolean	是促銷
名冊	value.Roster	string	名冊
Job	value.Job	string	Job
評論	value.Comments	string	評論
替代位置名稱	value.AltPositionName	string	替代位置名稱
添加日期	value.DateAdded	string	添加日期
位置生效日期	value.PositionEffectiveDate	string	位置生效日期
海關工會	value.CustomTradeUnion	string	海關工會
自訂欄位	value.CustomFields	array of object	自訂欄位
Code	value.CustomFields.Code	string	Code
標籤	value.CustomFields.Label	string	標籤
價值觀	value.CustomFields.Value	string	價值觀

建立單一僱傭狀態記錄

作業識別碼：: CreateASingleEmploymentStatusRecord

為指定的 EmployeeNumber 建立單一員工僱傭狀態記錄。

參數

名稱	機碼	必要	類型	Description
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數
body	body	True	string

傳回

名稱	路徑	類型	Description
@odata.上下文	@odata.context	string	@odata.context
就業狀態標識符	EmploymentStatusId	integer	就業狀態標識符
員工編號	EmployeeNumber	string	員工編號
群組加入日期	GroupJoinDate	string	群組加入日期
就業日期	EmploymentDate	string	就業日期
終止日期	TerminationDate	string	終止日期
終止原因	TerminationReason	string	終止原因
TaxStatus	TaxStatus	string	TaxStatus
稅務參考編號	TaxReferenceNumber	string	稅務參考編號
人的本性	NatureOfPerson	string	人的本性
稅務局	TaxOffice	integer	稅務局
稅務指令號碼	TaxDirectiveNumber	string	稅務指令號碼
IT3A簡訊	IT3AReason	integer	IT3A簡訊
就業行動	EmploymentAction	string	就業行動
終止公司運行	TerminationCompanyRun	string	終止公司運行
身分識別類型	IdentityType	string	身分識別類型
身分證號碼	IdNumber	string	身分證號碼
護照號碼	PassportNumber	string	護照號碼
百分比金額	PercentageAmount	string	百分比金額
總數	Amount	integer	總數
百分比	Percentage	integer	百分比
視同月酬	DeemedMonthlyRemuneration	integer	視同月酬
視為75指標	Deemed75Indicator	boolean	視為75指標
視同恢復每月	DeemedRecoveryMonthly	boolean	視同恢復每月
EncashLeave（現金休假）	EncashLeave	boolean	EncashLeave（現金休假）
愛爾蘭30	Irp30	boolean	愛爾蘭30
FinalizeIssueTaxCert	FinalizeIssueTaxCert	boolean	FinalizeIssueTaxCert
護照國家/地區	PassportCountry	boolean	護照國家/地區
護照簽發	PassportIssued	string	護照簽發
護照到期	PassportExpiry	string	護照到期
許可證已簽發	PermitIssued	string	許可證已簽發
許可到期	PermitExpiry	string	許可到期
附加日期	AdditionalDate	string	附加日期
EmploymentCaptureDate	EmploymentCaptureDate	string	EmploymentCaptureDate
終止擷取日期	TerminationCaptureDate	string	終止擷取日期
臨時工作者	TempWorker	boolean	臨時工作者
附加日期1	AdditionalDate1	string	附加日期1
不可再就業	NotReEmployable	boolean	不可再就業
ReferenceNumber	ReferenceNumber	string	ReferenceNumber
舊員工標識碼	OldEmployeeId	integer	舊員工標識碼

建立單一員工記錄

作業識別碼：: CreateASingleEmployeeRecord

為指定的 EmployeeNumber 建立單一員工記錄。

參數

名稱	機碼	必要	類型	Description
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數
body	body	True	string

傳回

名稱	路徑	類型	Description
@odata.上下文	@odata.context	string	@odata.context
EmployeeId	EmployeeId	integer	EmployeeId
員工編號	EmployeeNumber	string	員工編號
Title	Title	string	Title
FirstName	FirstName	string	FirstName
姓氏	LastName	string	姓氏
偏好名稱	PreferredName	string	偏好名稱
娘家名稱	MaidenName	string	娘家名稱
MiddleName	MiddleName	string	MiddleName
首字母	Initials	string	首字母
Email	Email	string	Email
生日	Birthday	string	生日
HomeNumber	HomeNumber	string	HomeNumber
工作編號	WorkNumber	string	工作編號
儲存格編號	CellNumber	string	儲存格編號
工作延伸	WorkExtension	string	工作延伸
語言	Language	string	語言
性別	Gender	string	性別
MaritalStatus	MaritalStatus	string	MaritalStatus
族	Race	string	族
Nationality	Nationality	string	Nationality
國籍	Citizenship	string	國籍
DisabledType （已停用類型）	DisabledType	string	DisabledType （已停用類型）
外國國民	ForeignNational	boolean	外國國民
DateCreated	DateCreated	string	DateCreated
緊急聯絡人名稱	EmergencyContactName	string	緊急聯絡人名稱
緊急聯絡電話	EmergencyContactNumber	string	緊急聯絡電話
緊急聯絡地址	EmergencyContactAddress	string	緊急聯絡地址
是退休	IsRetired	boolean	是退休
自訂欄位值	CustomFieldValue	string	自訂欄位值
自訂欄位值2	CustomFieldValue2	string	自訂欄位值2
Uif豁免	UifExemption	string	Uif豁免
Sdl豁免	SdlExemption	string	Sdl豁免
Eti豁免	EtiExempt	boolean	Eti豁免
影像下載網址	ImageDownloadUrl	string	影像下載網址
自訂欄位	CustomFields	array of object	自訂欄位
Code	CustomFields.Code	string	Code
標籤	CustomFields.Label	string	標籤
價值觀	CustomFields.Value	string	價值觀
Address	Address	array of object	Address
位址標識碼	Address.AddressId	integer	位址標識碼
地址類型	Address.AddressType	string	地址類型
員工編號	Address.EmployeeNumber	string	員工編號
地址欄位1	Address.AddressLine1	string	地址欄位1
地址欄位二	Address.AddressLine2	string	地址欄位二
地址行 3	Address.AddressLine3	string	地址行 3
地址代碼	Address.AddressCode	string	地址代碼
地址國家/地區	Address.AddressCountry	string	地址國家/地區
省	Address.Province	string	省
單位編號	Address.UnitNumber	string	單位編號
Complex	Address.Complex	string	Complex
街道號碼	Address.StreetNumber	string	街道號碼
相同為物理	Address.SameAsPhysical	boolean	相同為物理
IsCareof地址	Address.IsCareofAddress	boolean	IsCareof地址
中介護理	Address.CareOfIntermediary	string	中介護理
特殊服務	Address.SpecialServices	string	特殊服務

建立單一員工附件記錄

作業識別碼：: CreateASingleEmployeeAttachmentRecord

為指定的 EmployeeNumber 建立單一附件記錄。

參數

名稱	機碼	必要	類型	Description
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數
body	body	True	string

傳回

名稱	路徑	類型	Description
@odata.上下文	@odata.context	string	@odata.context
附件標識符	AttachmentId	integer	附件標識符
員工編號	EmployeeNumber	string	員工編號
Classification	Classification	string	Classification
附件說明	AttachmentDescription	string	附件說明
AttachmentName	AttachmentName	string	AttachmentName
附件網址	AttachmentUrl	string	附件網址
Attachment	Attachment	string	Attachment
自訂欄位	CustomFields	array of object	自訂欄位
Code	CustomFields.Code	string	Code
標籤	CustomFields.Label	string	標籤
價值觀	CustomFields.Value	string	價值觀

建立單一職位記錄

作業識別碼：: CreateASinglePositionRecord

為指定的 EmployeeNumber 建立單一員工職位記錄。

參數

名稱	機碼	必要	類型	Description
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數
body	body	True	string

傳回

名稱	路徑	類型	Description
@odata.上下文	@odata.context	string	@odata.context
員工位置標識符	EmployeePositionId	integer	員工位置標識符
員工編號	EmployeeNumber	string	員工編號
EffectiveDate	EffectiveDate	string	EffectiveDate
組織職位	OrganizationPosition	string	組織職位
組織位置與程式碼	OrganizationPositionWithCode	string	組織位置與程式碼
職位類型	PositionType	string	職位類型
Grade	Grade	string	Grade
職業級別	OccupationalLevel	string	職業級別
DirectlyReportsPositionOverride	DirectlyReportsPositionOverride	string	DirectlyReportsPositionOverride
直接報告職位	DirectlyReportsPosition	string	直接報告職位
組織群組	OrganizationGroup	string	組織群組
組織群組	OrganizationGroups	array of	組織群組
組織區域	OrganizationRegion	string	組織區域
支付點	PayPoint	string	支付點
直接下屬員工	DirectlyReportsEmployee	string	直接下屬員工
直接報告員工編號	DirectlyReportsEmployeeNumber	string	直接報告員工編號
就業類別	EmploymentCategory	string	就業類別
就業子類別	EmploymentSubCategory	string	就業子類別
系統管理員	Administrator	string	系統管理員
管理員員工編號	AdministratorEmployeeNumber	string	管理員員工編號
工作流程角色	WorkflowRole	string	工作流程角色
總帳	GeneralLedger	string	總帳
工會	TradeUnion	string	工會
是促銷	IsPromotion	boolean	是促銷
名冊	Roster	string	名冊
Job	Job	string	Job
評論	Comments	string	評論
替代位置名稱	AltPositionName	string	替代位置名稱
添加日期	DateAdded	string	添加日期
位置生效日期	PositionEffectiveDate	string	位置生效日期
海關工會	CustomTradeUnion	string	海關工會
自訂欄位	CustomFields	array of object	自訂欄位
Code	CustomFields.Code	string	Code
標籤	CustomFields.Label	string	標籤
價值觀	CustomFields.Value	string	價值觀

建立單一銀行詳細資料記錄

作業識別碼：: CreateASingleBankDetailRecord

為指定的 EmployeeNumber 建立單一員工銀行詳細資料記錄。

參數

名稱	機碼	必要	類型	Description
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
body	body	True	string
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數

傳回

名稱	路徑	類型	Description
@odata.上下文	@odata.context	string	@odata.context
BankDetailId	BankDetailId	integer	BankDetailId
員工編號	EmployeeNumber	string	員工編號
PaymentMethod	PaymentMethod	string	PaymentMethod
分割類型	SplitType	string	分割類型
銀行帳戶擁有者	BankAccountOwner	string	銀行帳戶擁有者
銀行帳戶擁有者名稱	BankAccountOwnerName	string	銀行帳戶擁有者名稱
帳戶類型	AccountType	string	帳戶類型
銀行名稱	BankName	string	銀行名稱
銀行分行編號	BankBranchNo	string	銀行分行編號
銀行帳戶編號	BankAccountNo	string	銀行帳戶編號
Reference	Reference	string	Reference
IsMainAccount	IsMainAccount	boolean	IsMainAccount
總數	Amount	integer	總數
評論	Comments	string	評論
迅捷代碼	SwiftCode	string	迅捷代碼
路由代碼	RoutingCode	string	路由代碼
元件標識符	ComponentId	integer	元件標識符

更新單一員工記錄

作業識別碼：: UpdateASingleEmployeeRecord

根據指定的 EmployeeId 更新單一員工記錄。

參數

名稱	機碼	必要	類型	Description
{{公司編號}}	company-id	True	string	{{公司編號}}公司編號
{{員工編號}}	EmployeeId	True	string	{{員工編號}}The EmployeeId
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數
body	body	True	string

傳回

名稱	路徑	類型	Description
@odata.上下文	@odata.context	string	@odata.context
成功	Success	boolean	成功

更新單一員工附件記錄

作業識別碼：: UpdateASingleEmployeeAttachmentRecord

根據指定的 AttachmentId 更新單一附件記錄。

參數

名稱	機碼	必要	類型	Description
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
附件標識符	AttachmentId	True	integer	{{附件Id}}The AttachmentId
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數
body	body	True	string

傳回

response: object

更新單一職位記錄

作業識別碼：: UpdateASinglePositionRecord

根據指定的 EmployeePositionId 更新單一員工職位記錄。

參數

名稱	機碼	必要	類型	Description
{{員工位置Id}}	EmployeePositionId	True	integer	{{員工位置Id}}The EmployeePositionId
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數
body	body	True	string

傳回

response: object

更新單一銀行詳細資料記錄

作業識別碼：: UpdateASingleBankDetailRecord

根據指定的 BankdetailId 更新單一銀行詳細資料記錄。

參數

名稱	機碼	必要	類型	Description
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
{{銀行詳細編號}}	BankDetailId	True	integer	{{銀行詳細編號}}The BankDetailId
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數
body	body	True	string

傳回

response: object

獲取就業狀況集合

作業識別碼：: GetACollectionOfEmploymentStatuses

根據指定的公司識別碼擷取目前作用中員工就業狀態的清單。

參數

名稱	機碼	必要	類型	Description
由 {{$employee-field}} 選用	$orderby		string	（字串） - 指定傳回專案的順序
可選$top	$top		integer	（integer（$int 32）） - 限制從集合傳回的專案數目
可選$skip	$skip	True	integer	（integer（$int 32）） - 從結果中排除查詢集合的指定項目數
可選$count	$count	True	string	（true/false） - 在回應中傳回總計數
可選$filter	$filter		string	按字段過濾，例如。 “員工編號等式 'Emp01'”
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數

傳回

名稱	路徑	類型	Description
@odata.上下文	@odata.context	string	@odata.context
@odata.計數	@odata.count	integer	@odata.count
value	value	array of object	value
就業狀態標識符	value.EmploymentStatusId	integer	就業狀態標識符
員工編號	value.EmployeeNumber	string	員工編號
群組加入日期	value.GroupJoinDate	string	群組加入日期
就業日期	value.EmploymentDate	string	就業日期
終止日期	value.TerminationDate	string	終止日期
終止原因	value.TerminationReason	string	終止原因
TaxStatus	value.TaxStatus	string	TaxStatus
稅務參考編號	value.TaxReferenceNumber	string	稅務參考編號
人的本性	value.NatureOfPerson	string	人的本性
稅務局	value.TaxOffice	integer	稅務局
稅務指令號碼	value.TaxDirectiveNumber	string	稅務指令號碼
IT3A簡訊	value.IT3AReason	integer	IT3A簡訊
就業行動	value.EmploymentAction	string	就業行動
終止公司運行	value.TerminationCompanyRun	string	終止公司運行
身分識別類型	value.IdentityType	string	身分識別類型
身分證號碼	value.IdNumber	string	身分證號碼
護照號碼	value.PassportNumber	string	護照號碼
百分比金額	value.PercentageAmount	string	百分比金額
總數	value.Amount	integer	總數
百分比	value.Percentage	integer	百分比
視同月酬	value.DeemedMonthlyRemuneration	integer	視同月酬
視為75指標	value.Deemed75Indicator	boolean	視為75指標
視同恢復每月	value.DeemedRecoveryMonthly	boolean	視同恢復每月
EncashLeave（現金休假）	value.EncashLeave	boolean	EncashLeave（現金休假）
愛爾蘭30	value.Irp30	boolean	愛爾蘭30
FinalizeIssueTaxCert	value.FinalizeIssueTaxCert	boolean	FinalizeIssueTaxCert
護照國家/地區	value.PassportCountry	boolean	護照國家/地區
護照簽發	value.PassportIssued	string	護照簽發
護照到期	value.PassportExpiry	string	護照到期
許可證已簽發	value.PermitIssued	string	許可證已簽發
許可到期	value.PermitExpiry	string	許可到期
附加日期	value.AdditionalDate	string	附加日期
EmploymentCaptureDate	value.EmploymentCaptureDate	string	EmploymentCaptureDate
終止擷取日期	value.TerminationCaptureDate	string	終止擷取日期
臨時工作者	value.TempWorker	boolean	臨時工作者
附加日期1	value.AdditionalDate1	string	附加日期1
不可再就業	value.NotReEmployable	boolean	不可再就業
ReferenceNumber	value.ReferenceNumber	string	ReferenceNumber
舊員工標識碼	value.OldEmployeeId	integer	舊員工標識碼
自訂欄位	value.CustomFields	array of object	自訂欄位
Code	value.CustomFields.Code	string	Code
標籤	value.CustomFields.Label	string	標籤
價值觀	value.CustomFields.Value	string	價值觀

獲取所有就業狀況的集合

作業識別碼：: GetACollectionOfAllEmploymentStatuses

根據指定的公司識別碼擷取所有員工僱傭狀態的清單。

參數

名稱	機碼	必要	類型	Description
{{$employee-field}}	$orderby		string	選擇性（字串） - 指定傳回專案的順序
可選$top	$top		integer	（integer（$int 32）） - 限制從集合傳回的專案數目
可選$skip	$skip	True	integer	（integer（$int 32）） - 從結果中排除查詢集合的指定項目數
可選$count	$count	True	string	（true/false） - 在回應中傳回總計數
可選$filter	$filter		string	按字段過濾，例如。 “員工編號等式 'Emp01'”
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數

傳回

名稱	路徑	類型	Description
@odata.上下文	@odata.context	string	@odata.context
@odata.計數	@odata.count	integer	@odata.count
value	value	array of object	value
就業狀態標識符	value.EmploymentStatusId	integer	就業狀態標識符
員工編號	value.EmployeeNumber	string	員工編號
群組加入日期	value.GroupJoinDate	string	群組加入日期
就業日期	value.EmploymentDate	string	就業日期
終止日期	value.TerminationDate	string	終止日期
終止原因	value.TerminationReason	string	終止原因
TaxStatus	value.TaxStatus	string	TaxStatus
稅務參考編號	value.TaxReferenceNumber	string	稅務參考編號
人的本性	value.NatureOfPerson	string	人的本性
稅務局	value.TaxOffice	integer	稅務局
稅務指令號碼	value.TaxDirectiveNumber	string	稅務指令號碼
IT3A簡訊	value.IT3AReason	integer	IT3A簡訊
就業行動	value.EmploymentAction	string	就業行動
終止公司運行	value.TerminationCompanyRun	string	終止公司運行
身分識別類型	value.IdentityType	string	身分識別類型
身分證號碼	value.IdNumber	string	身分證號碼
護照號碼	value.PassportNumber	string	護照號碼
百分比金額	value.PercentageAmount	string	百分比金額
總數	value.Amount	integer	總數
百分比	value.Percentage	integer	百分比
視同月酬	value.DeemedMonthlyRemuneration	integer	視同月酬
視為75指標	value.Deemed75Indicator	boolean	視為75指標
視同恢復每月	value.DeemedRecoveryMonthly	boolean	視同恢復每月
EncashLeave（現金休假）	value.EncashLeave	boolean	EncashLeave（現金休假）
愛爾蘭30	value.Irp30	boolean	愛爾蘭30
FinalizeIssueTaxCert	value.FinalizeIssueTaxCert	boolean	FinalizeIssueTaxCert
護照國家/地區	value.PassportCountry	boolean	護照國家/地區
護照簽發	value.PassportIssued	string	護照簽發
護照到期	value.PassportExpiry	string	護照到期
許可證已簽發	value.PermitIssued	string	許可證已簽發
許可到期	value.PermitExpiry	string	許可到期
附加日期	value.AdditionalDate	string	附加日期
EmploymentCaptureDate	value.EmploymentCaptureDate	string	EmploymentCaptureDate
終止擷取日期	value.TerminationCaptureDate	string	終止擷取日期
臨時工作者	value.TempWorker	boolean	臨時工作者
附加日期1	value.AdditionalDate1	string	附加日期1
不可再就業	value.NotReEmployable	boolean	不可再就業
ReferenceNumber	value.ReferenceNumber	string	ReferenceNumber
舊員工標識碼	value.OldEmployeeId	integer	舊員工標識碼
自訂欄位	value.CustomFields	array of object	自訂欄位
Code	value.CustomFields.Code	string	Code
標籤	value.CustomFields.Label	string	標籤
價值觀	value.CustomFields.Value	string	價值觀

獲取職位集合

作業識別碼：: GetACollectionOfPositions

擷取截至今天日期並根據指定company_id的員工職位記錄清單。

參數

名稱	機碼	必要	類型	Description
可選$top	$top		integer	（integer（$int 32）） - 限制從集合傳回的專案數目
可選$skip	$skip	True	integer	（integer（$int 32）） - 從結果中排除查詢集合的指定項目數
可選$count	$count	True	string	（true/false） - 在回應中傳回總計數
可選$filter	$filter		string	按字段過濾，例如。 “員工編號等式 'Emp01'”
可選$expand	$expand	True	string	選擇性 - 若要傳回 OrganizationGroups 欄位資料，請使用值 'OrganizationGroups'
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數

傳回

名稱	路徑	類型	Description
@odata.上下文	@odata.context	string	@odata.context
@odata.計數	@odata.count	integer	@odata.count
value	value	array of object	value
員工位置標識符	value.EmployeePositionId	integer	員工位置標識符
員工編號	value.EmployeeNumber	string	員工編號
全名	value.FullName	string	全名
EffectiveDate	value.EffectiveDate	string	EffectiveDate
組織職位	value.OrganizationPosition	string	組織職位
組織位置標識符	value.OrganizationPositionId	integer	組織位置標識符
組織位置與程式碼	value.OrganizationPositionWithCode	string	組織位置與程式碼
職位類型	value.PositionType	string	職位類型
Grade	value.Grade	string	Grade
職業級別	value.OccupationalLevel	string	職業級別
DirectlyReportsPositionOverride	value.DirectlyReportsPositionOverride	string	DirectlyReportsPositionOverride
直接報告職位	value.DirectlyReportsPosition	string	直接報告職位
組織群組	value.OrganizationGroup	string	組織群組
組織群組說明	value.OrganizationGroupDescription	string	組織群組說明
組織群組	value.OrganizationGroups	array of object	組織群組
組織單位標識符	value.OrganizationGroups.OrganizationUnitId	integer	組織單位標識符
ParentOrganizationUnitId	value.OrganizationGroups.ParentOrganizationUnitId	integer	ParentOrganizationUnitId
上傳代碼	value.OrganizationGroups.UploadCode	string	上傳代碼
Description	value.OrganizationGroups.Description	string	Description
成本中心	value.OrganizationGroups.CostCentre	boolean	成本中心
組織層級	value.OrganizationGroups.OrganizationLevel	string	組織層級
群組GlKey	value.OrganizationGroups.GroupGlKey	string	群組GlKey
預算	value.OrganizationGroups.Budget	integer	預算
Reference	value.OrganizationGroups.Reference	string	Reference
經理員工編號	value.OrganizationGroups.ManagerEmployeeNumber	string	經理員工編號
非活躍日期	value.OrganizationGroups.InactiveDate	string	非活躍日期
組織區域	value.OrganizationRegion	string	組織區域
支付點	value.PayPoint	string	支付點
直接下屬員工	value.DirectlyReportsEmployee	string	直接下屬員工
直接報告員工編號	value.DirectlyReportsEmployeeNumber	string	直接報告員工編號
就業類別	value.EmploymentCategory	string	就業類別
就業子類別	value.EmploymentSubCategory	string	就業子類別
系統管理員	value.Administrator	string	系統管理員
管理員員工編號	value.AdministratorEmployeeNumber	string	管理員員工編號
工作流程角色	value.WorkflowRole	string	工作流程角色
總帳	value.GeneralLedger	string	總帳
工會	value.TradeUnion	string	工會
是促銷	value.IsPromotion	boolean	是促銷
名冊	value.Roster	string	名冊
Job	value.Job	string	Job
評論	value.Comments	string	評論
替代位置名稱	value.AltPositionName	string	替代位置名稱
添加日期	value.DateAdded	string	添加日期
位置生效日期	value.PositionEffectiveDate	string	位置生效日期
海關工會	value.CustomTradeUnion	string	海關工會
自訂欄位	value.CustomFields	array of object	自訂欄位
Code	value.CustomFields.Code	string	Code
標籤	value.CustomFields.Label	string	標籤
價值觀	value.CustomFields.Value	string	價值觀

獲取銀行詳細記錄的集合

作業識別碼：: GetACollectionOfBankDetailRecords

根據指定的company_id擷取員工銀行詳細資料清單。

參數

名稱	機碼	必要	類型	Description
{{$bank-detail-field}} 的選用	$orderby	True	string	（字串） - 指定傳回專案的順序
可選$top	$top		string	（integer（$int 32）） - 限制從集合傳回的專案數目
可選$skip	$skip	True	string	（integer（$int 32）） - 從結果中排除查詢集合的指定項目數
可選$count	$count	True	string	（true/false） - 在回應中傳回總計數
可選$filter	$filter		string	按字段過濾，例如。 “員工編號等式 'Emp01'”
{{公司編號}}	company-id	True	integer	{{公司編號}}公司編號
持有者令牌	CustomAuthHeader	True	string	持有人權杖值（不含關鍵字持有者）
環境變數	CustomEnvironmentHeader	True	string	API （適用於 PROD）或 apistaging （適用於 STAGING）的變數

傳回

名稱	路徑	類型	Description
@odata.上下文	@odata.context	string	@odata.context
@odata.計數	@odata.count	integer	@odata.count
value	value	array of object	value
BankDetailId	value.BankDetailId	integer	BankDetailId
員工編號	value.EmployeeNumber	string	員工編號
PaymentMethod	value.PaymentMethod	string	PaymentMethod
分割類型	value.SplitType	string	分割類型
銀行帳戶擁有者	value.BankAccountOwner	string	銀行帳戶擁有者
銀行帳戶擁有者名稱	value.BankAccountOwnerName	string	銀行帳戶擁有者名稱
帳戶類型	value.AccountType	string	帳戶類型
銀行名稱	value.BankName	string	銀行名稱
銀行分行編號	value.BankBranchNo	string	銀行分行編號
銀行帳戶編號	value.BankAccountNo	string	銀行帳戶編號
Reference	value.Reference	string	Reference
IsMainAccount	value.IsMainAccount	boolean	IsMainAccount
總數	value.Amount	integer	總數
評論	value.Comments	string	評論
迅捷代碼	value.SwiftCode	string	迅捷代碼
路由代碼	value.RoutingCode	string	路由代碼
元件標識符	value.ComponentId	integer	元件標識符

定義

物件

這是類型 'object'。

共用方式為

PaySpace （獨立發行者） （預覽版）