UKG Pro HCM （預覽版）
UKG Pro HCM 連接器，適用於專業人力資源、薪資和人才。
此連接器適用於以下產品和區域：
| 服務 | 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） |
| 連絡人 | |
|---|---|
| 名稱 | KGS的 |
| URL | https://www.ukg.com/support |
| support@ukg.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | 迪利普·切納尼 |
| 網站 | https://www.ukg.com/ |
| 隱私策略 | https://www.ukg.com/privacy |
| 類別 | 人力資源 |
UKG Pro HCM 連接器使用 UKG Pro API 簡化資料傳輸，並使您能夠利用 UKG Pro 資料來解決業務應用程式和整合需求。
先決條件
- 具有 Web 服務帳戶和有效資源許可權的現有 UKG Pro 使用者，並具有適當的使用者名稱和使用者 API 金鑰值。 UKG Pro HCM 連接器使用基本驗證，並且需要唯一的使用者名稱和使用者 API 金鑰。
- UKG Pro 基底服務 URL 類似於 “https://servicet.ultipro.com/services/"”，但會因客戶數據中心和生產/測試環境而異。
如何取得認證
使用基本驗證的 UKG Pro HCM 連接器只能透過 Web 服務帳戶存取。 有關建立和維護 UKG Pro 服務帳戶的信息， 請單擊此處。
開始使用連接器
- 取得單人詳細資料記錄
- 取得單一公司的單一人員詳細資料記錄
- 獲取員工工資單
- 取得員工最後薪資明細表
- 獲取員工就業詳情
- 獲取員工人口統計詳細信息
- 取得一般總帳執行的詳細資料
- 將 XML 交易提交至匯入工具
- 員工 ID 查詢
- 獲取特定的員工 pto-plans
- 獲取員工主管詳細信息
- 取得指派給員工作為連絡人的人員的所有詳細資料
已知問題與限制
None
常見錯誤和補救措施
聯絡我們 https://www.ukg.com/support
FAQ
如有錯誤和問題，請通過以下方式聯繫 https://www.ukg.com/support 我們。
正在建立連線
連接器支援下列驗證類型：
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用：所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 使用者名 | securestring | 此 API 的使用者名稱 | 對 |
| 使用者 API 金鑰 | securestring | 此 API 的使用者 API 金鑰 | 對 |
| UKG Pro 基底服務 URL | 字串 | 基本服務 URL 將類似於 servicet.ultipro.com，但會因客戶資料中心和生產/測試環境而異 | 對 |
| 美國-客戶-Api-Key | 字串 | 輸入您的美國客戶Api-Key | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 取得一般總帳執行的詳細資料 |
傳回一般總帳執行的詳細資料清單。 |
| 取得員工最後薪資明細表 |
根據傳遞的員工標識符獲取員工最後工資報表。 |
| 取得單一公司的單一人員詳細資料記錄 |
取得單一公司的單一人員詳細資料記錄。 |
| 取得單人詳細資料記錄 |
取得單人詳細資料記錄。 |
| 取得指派給員工作為連絡人的人員的所有詳細資料 |
取得指派給員工作為連絡人之人員的所有詳細資料。 |
| 員工 ID 查詢 |
員工 ID 查詢。 |
| 將 XML 交易提交至匯入工具 |
將編碼的 XML 交易提交至匯入工具。 |
| 獲取員工主管詳細信息 |
獲取員工主管詳細信息。 |
| 獲取員工人口統計詳細信息 |
取得員工人口統計詳細資訊。 |
| 獲取員工就業詳情 |
獲取員工就業詳細信息。 |
| 獲取員工工資單 |
根據傳遞的員工識別碼取得員工薪資報表。 |
| 獲取特定的員工 pto-plans |
獲取特定的員工 pto-plans |
取得一般總帳執行的詳細資料
傳回一般總帳執行的詳細資料清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
runId
|
runId | string |
一般總帳執行的識別碼 |
|
|
區塊標識符
|
blockId | string |
一般總帳執行內特定區塊的識別碼 |
|
|
per_Page
|
per_Page | integer |
篩選以擷取最新資料 |
|
|
頁面
|
page | integer |
分頁，您要查看的頁面 |
|
|
最近期
|
mostRecent | string |
分頁，您要查看每頁的記錄數 |
傳回
取得員工最後薪資明細表
根據傳遞的員工標識符獲取員工最後工資報表。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
歐洲電路板
|
eeid | True | string |
輸入您的員工 ID。 |
|
科伊德
|
coid | True | string |
輸入您的公司 ID。 |
|
startDate
|
startDate | string |
輸入開始日期。 |
|
|
結束日期
|
endDate | string |
輸入 [結束日期]。 |
|
|
頁面
|
page | integer |
輸入頁碼。 |
|
|
per_Page
|
per_Page | integer |
輸入每頁值。 |
|
|
頁數
|
pagesCount | integer |
輸入頁數。 |
傳回
取得單一公司的單一人員詳細資料記錄
取得單一公司的單一人員詳細資料記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
員工 ID
|
employeeID | True | string |
員工識別號碼。 |
|
公司編號
|
companyID | True | string |
公司識別號碼。 |
|
lastName
|
lastName | string |
員工的姓氏 |
|
|
電子郵件地址
|
emailAddress | string |
員工的電子郵件地址 |
|
|
addressState
|
addressState | string |
員工居住州 |
|
|
地址國家
|
addressCountry | string |
員工居住國家/地區 |
|
|
眼鏡蛇是主動的
|
cobraIsActive | string |
布林值欄位，指示 COBRA 覆蓋範圍目前是否處於作用中狀態。 |
|
|
眼鏡蛇狀態
|
cobraStatus | string |
這是指示 COBRA 覆蓋範圍狀態的字串。 |
|
|
日期眼鏡蛇活動
|
dateOfCobraEvent | string |
用於查找 COBRA 事件的日期小於、大於、等於或經過的日期之間。 |
|
|
日期時間已建立
|
dateTimeCreated | string |
用於查找創建的人員記錄較少、更大、相等或經過的日期之間。 |
|
|
日期時間變更
|
dateTimeChanged | string |
用於查找人員記錄更改較小、較大、相等或經過日期之間。 |
|
|
國家標識碼
|
nationalId | string |
國民身分證號碼 |
|
|
nationalId國家/地區
|
nationalIdCountry | string |
國家識別號碼 |
|
|
頁面
|
page | integer |
分頁的頁碼 |
|
|
per_Page
|
per_Page | integer |
每頁項目數 |
傳回
取得單人詳細資料記錄
取得單人詳細資料記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
員工 ID
|
employeeID | True | string |
員工識別號碼。 |
傳回
取得指派給員工作為連絡人的人員的所有詳細資料
取得指派給員工作為連絡人之人員的所有詳細資料。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
員工編號
|
employeeId | string |
員工標識碼 |
|
|
是活躍的
|
isActive | string |
活動狀態指示燈 |
|
|
關係代碼
|
relationshipCode | string |
連絡人的員工關係類型代碼 |
|
|
contactId
|
contactId | string |
聯絡人識別碼 |
|
|
countryCode （國家代碼）
|
countryCode | string |
國碼 (地區碼) |
|
|
眼鏡蛇是主動的
|
cobraIsActive | string |
布林值欄位，指示 COBRA 覆蓋範圍目前是否處於作用中狀態。 |
|
|
眼鏡蛇狀態
|
cobraStatus | string |
這是一個字串，表示 COBRA 覆蓋範圍的狀態 |
|
|
是受益人
|
isBeneficiary | string |
受益指標 |
|
|
是相依性
|
isDependent | string |
相依指標 |
|
|
日期眼鏡蛇活動
|
dateOfCobraEvent | string |
用於查找 COBRA 事件的日期小於、大於、等於或經過的日期之間。 |
|
|
statusAsOfDate
|
statusAsOfDate | string |
用於查找截至日期的聯繫狀態，小於、大於、等於或經過日期之間。 |
|
|
頁面
|
page | integer |
分頁，您要查看的頁面 |
|
|
per_Page
|
per_Page | integer |
分頁，您要查看每頁的記錄數 |
傳回
員工 ID 查詢
員工 ID 查詢。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
employeeIdentifierType
|
employeeIdentifierType | True | string |
輸入員工識別碼類型。 |
|
employeeIdentifier值
|
employeeIdentifierValue | True | string |
輸入員工識別碼值 |
|
companyIdentifierType
|
companyIdentifierType | string |
輸入公司識別碼類型。 |
|
|
公司識別值
|
companyIdentifierValue | string |
輸入公司識別碼值 |
傳回
將 XML 交易提交至匯入工具
將編碼的 XML 交易提交至匯入工具。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
交易
|
transaction | True | string |
輸入編碼的 XML 交易。 |
|
uniqueFileName
|
uniqueFileName | string |
輸入以 xml 副檔名結尾的唯一檔案名稱。 |
傳回
獲取員工主管詳細信息
獲取員工主管詳細信息。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
公司編號
|
companyId | string |
公司識別碼 |
|
|
員工 ID
|
employeeId | string |
員工公司的識別碼 |
|
|
主管公司識別碼
|
supervisorCompanyId | string |
代表主管公司識別碼的字串 |
|
|
主管員工標識碼
|
supervisorEmployeeId | string |
代表主管員工識別碼的字串 |
|
|
主管公司代碼
|
supervisorCompanyCode | string |
代表主管公司代碼的字串 |
|
|
頁面
|
page | integer |
分頁，您要查看的頁面 |
|
|
per_Page
|
per_Page | integer |
分頁，您要查看每頁的記錄數 |
傳回
獲取員工人口統計詳細信息
取得員工人口統計詳細資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
員工編號
|
employeeId | string |
員工標識碼 |
|
|
companyId
|
companyId | string |
公司識別碼 |
|
|
lastName
|
lastName | string |
員工的姓氏 |
|
|
電子郵件地址
|
emailAddress | string |
員工的電子郵件地址 |
|
|
addressState
|
addressState | string |
員工居住州 |
|
|
地址國家
|
addressCountry | string |
員工居住國家/地區 |
|
|
頁面
|
page | integer |
分頁，您要查看的頁面 |
|
|
per_Page
|
per_Page | integer |
分頁，您要查看每頁的記錄數 |
傳回
獲取員工就業詳情
獲取員工就業詳細信息。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
公司ID
|
companyID | string |
公司識別號碼 |
|
|
員工ID
|
employeeID | string |
員工識別號碼 |
|
|
主要工作代碼
|
primaryJobCode | string |
代表員工主要工作的程式碼 |
|
|
職位名稱
|
jobTitle | string |
員工的工作名稱 |
|
|
fullTime或PartTime代碼
|
fullTimeOrPartTimeCode | string |
指示員工是全職還是兼職的代碼 |
|
|
primaryWorkLocationCode
|
primaryWorkLocationCode | string |
代表員工主要工作地點的代碼 |
|
|
主要專案代碼
|
primaryProjectCode | string |
代表員工主要專案群組的程式碼 |
|
|
推導群組代碼
|
deductionGroupCode | string |
代表員工扣除組的代碼 |
|
|
earningGroup代碼
|
earningGroupCode | string |
代表員工收入群組的代碼 |
|
|
employeeTypeCode
|
employeeTypeCode | string |
代表員工類型的程式碼 |
|
|
employeeStatusCode
|
employeeStatusCode | string |
代表員工狀態的代碼 |
|
|
員工編號
|
employeeNumber | string |
指派給員工的號碼 |
|
|
supervisorId
|
supervisorId | string |
員工主管的唯一識別碼 |
|
|
原始HireDate
|
originalHireDate | string |
員工最初受僱的日期 |
|
|
lastHireDate
|
lastHireDate | string |
員工最後一次僱用的日期 |
|
|
終止日期
|
dateOfTermination | string |
僱員離職日期 |
|
|
退休日期
|
dateOfRetirement | string |
僱員退休日期 |
|
|
日期時間已建立
|
dateTimeCreated | string |
指出記錄建立時間的時間戳記 |
|
|
日期時間變更
|
dateTimeChanged | string |
指出記錄上次更新時間的時間戳記 |
|
|
dateLastPayDate已付
|
dateLastPayDatePaid | string |
員工最後發薪日期的日期 |
|
|
支付組
|
payGroup | string |
與員工薪資相關的群組。 |
|
|
是家公司
|
isHomeCompany | boolean |
公司是否為員工的母公司指示器 |
|
|
頁面
|
page | integer |
分頁，您要查看的頁面 |
|
|
per_Page
|
per_Page | integer |
分頁，您要查看每頁的記錄數 |
傳回
獲取員工工資單
根據傳遞的員工識別碼取得員工薪資報表。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
公司代碼
|
companyCode | string |
輸入您的公司代碼。 |
|
|
員工編號
|
employeeNumber | string |
輸入您的員工編號。 |
|
|
歐洲電路板
|
eeid | string |
輸入您的員工 ID。 |
|
|
科伊德
|
coid | string |
輸入您的公司 ID。 |
|
|
startDate
|
startDate | string |
輸入開始日期。 |
|
|
結束日期
|
endDate | string |
輸入 [結束日期]。 |
|
|
頁面
|
page | integer |
輸入頁碼。 |
|
|
per_Page
|
per_Page | integer |
輸入每頁值。 |
|
|
頁數
|
pagesCount | integer |
輸入頁數。 |
傳回
- response
- array of getEmployeePayStatement
獲取特定的員工 pto-plans
獲取特定的員工 pto-plans
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
員工 ID
|
employeeID | True | string |
員工識別號碼。 |
|
公司編號
|
companyID | True | string |
公司識別號碼。 |
|
頁面
|
page | integer |
分頁，您要查看的頁面 |
|
|
per_page
|
per_page | integer |
分頁，您要查看每頁的記錄數 |
傳回
定義
getASinglePersonDetailRecord
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
附加名稱1
|
additionalName1 | string |
其他名稱欄位 1 |
|
附加名稱2
|
additionalName2 | string |
其他名稱欄位 2 |
|
地址標識碼
|
addressId | string |
地址的識別碼 |
|
地址IsOnTaxBoundary
|
addressIsOnTaxBoundary | boolean |
指出地址是否位於稅務邊界上 |
|
地址緯度
|
addressLatitude | float |
地址的緯度坐標 |
|
眼鏡蛇出口
|
cobraExport | string |
COBRA 出口信息 |
|
眼鏡蛇是主動的
|
cobraIsActive | boolean |
指出 COBRA 是否對員工處於作用中狀態 |
|
眼鏡蛇理性
|
cobraReason | string |
COBRA 狀態的原因 |
|
眼鏡蛇狀態
|
cobraStatus | string |
COBRA 狀態信息 |
|
眼鏡蛇狀態日期
|
cobraStatusDate | string |
COBRA 狀態更新日期 |
|
communityBroadcastSmsCode
|
communityBroadcastSmsCode | string |
社區廣播簡訊碼 |
|
同意電子W2
|
consentElectronicW2 | boolean |
表示同意電子 W2 表單 |
|
同意電子w2pr
|
consentElectronicw2pr | boolean |
表示同意電子 W2 表單 （特定於 PR） |
|
日期已故
|
dateDeceased | string |
逝世日期 |
|
日期眼鏡蛇活動
|
dateOfCobraEvent | string |
COBRA 活動日期 |
|
日期眼鏡蛇出口
|
dateOfCobraExport | string |
COBRA 出口日期 |
|
眼鏡蛇信的日期
|
dateOfCobraLetter | string |
COBRA 信件的日期 |
|
dateOfI9到期
|
dateOfI9Expiration | string |
I-9 表格到期日期 |
|
日期時間已變更
|
datetimeChanged | string |
指出資料上次更新時間的時間戳記 |
|
日期時間已建立
|
datetimeCreated | string |
指出資料建立時間的時間戳記 |
|
殘障類型
|
disabilityType | string |
殘疾類型 |
|
種族描述
|
ethnicDescription | string |
種族描述 |
|
前名稱
|
formerName | string |
以前的名字 |
|
健康血型
|
healthBloodType | string |
血型信息 |
|
健康眼睛
|
healthEyes | string |
眼睛顏色資訊 |
|
健康頭髮
|
healthHair | string |
髮色信息 |
|
健康高度腳
|
healthHeightFeet | string |
身高（英尺） |
|
健康高度英吋
|
healthHeightInches | string |
高度（英寸） |
|
健康最後捐贈日期
|
healthLastDonateDate | string |
最後一次獻血日期 |
|
健康體重
|
healthWeight | double |
重量（磅） |
|
i9外星人號碼
|
i9AlienNumber | string |
I-9 表格的外國人號碼 |
|
i9DocA
|
i9DocA | string |
I-9 表格的文件 A |
|
i9DocB
|
i9DocB | string |
I-9 表格的文件 B |
|
i9DocC
|
i9DocC | string |
I-9 表格的文件 C |
|
i9已驗證
|
i9Verified | boolean |
指示 I-9 表格是否經過驗證 |
|
i9簽證類型
|
i9VisaType | string |
I-9 表格的簽證類型 |
|
i9工作認證
|
i9WorkAuth | string |
I-9 表格的工作授權 |
|
isDisabled （已禁用）
|
isDisabled | boolean |
指出該人員是否已停用 |
|
是多付集團
|
isMultiPayGroup | boolean |
指出此人是否屬於多個薪資群組 |
|
是吸煙者
|
isSmoker | boolean |
指示此人是否是吸煙者 |
|
軍事服務
|
militaryService | boolean |
表示兵役狀態 |
|
軍事分部服役
|
militaryBranchServed | string |
服兵役部門 |
|
軍事時代
|
militaryEra | string |
軍時代信息 |
|
軍事是殘疾獸醫
|
militaryIsDisabledVet | string |
指出此人是否為殘疾退伍軍人 |
|
軍事是其他EligVett
|
militaryIsOthEligVet | string |
指出此人是否是其他符合資格的退伍軍人 |
|
軍事是OthEligVetBasis
|
militaryIsOthEligVetBasis | string |
其他符合條件的退伍軍人身份的依據 |
|
軍事是現役戰時獸醫
|
militaryIsActiveWartimeVet | string |
指示此人是否是現役戰時退伍軍人 |
|
名稱前任
|
nameFormer | string |
以前的名字 |
|
上一頁SSN
|
previousSSN | string |
以前的社會安全號碼 |
|
原產地國家
|
originCountry | string |
原產國 |
|
originLocation
|
originLocation | string |
原產地 |
|
w2是已故
|
w2IsDeceased | boolean |
指示此人是否已死亡 W2 表格 |
|
眼鏡蛇筆記
|
cobraNotes | string |
與 COBRA 相關的注意事項 |
|
地址短信
|
addressSms | string |
簡訊通知的地址 |
|
軍事分離日期
|
militarySeparationDate | string |
軍事分離日期 |
|
homePhoneIsPrivate
|
homePhoneIsPrivate | boolean |
指出住家電話號碼是否為私人 |
|
sms核准
|
smsApprovals | boolean |
指出是否已啟用簡訊核准 |
|
smsPay通知
|
smsPayNotification | boolean |
指出是否已啟用付款簡訊通知 |
|
i9簽證到期日期
|
i9VisaExpirationDate | string |
I-9簽證的到期日 |
|
軍事是勳章獸醫
|
militaryIsMedalVet | string |
指示此人是否是勳章退伍軍人 |
|
lastNameNotSameAsSSCard
|
lastNameNotSameAsSSCard | string |
指示姓氏是否與社會安全卡不同 |
|
chkCashingInstCode
|
chkCashingInstCode | string |
查看兌現機構代碼 |
|
國籍1
|
nationality1 | string |
國籍資訊 1 |
|
國籍2
|
nationality2 | string |
國籍資訊2 |
|
國籍3
|
nationality3 | string |
國籍資訊3 |
|
personId
|
personId | string |
人員的識別碼 |
|
員工編號
|
employeeId | string |
員工的識別碼 |
|
companyId
|
companyId | string |
公司的識別碼 |
|
使用者名稱
|
userName | string |
用戶名稱 |
|
名字
|
firstName | string |
名字 |
|
中間名
|
middleName | string |
中間名 |
|
lastName
|
lastName | string |
姓氏 |
|
preferredName
|
preferredName | string |
偏好名稱 |
|
namePrefixCode
|
namePrefixCode | string |
名稱的前置詞代碼 |
|
nameSufixCode
|
nameSufixCode | string |
名稱的後綴代碼 |
|
電子郵件地址
|
emailAddress | string |
電子郵件地址 |
|
電子郵件地址替代
|
emailAddressAlternate | string |
備用電子郵件地址 |
|
首頁電話
|
homePhone | string |
家庭電話號碼 |
|
首頁電話國家
|
homePhoneCountry | string |
住家電話號碼的國家/地區代碼 |
|
addressLine1
|
addressLine1 | string |
地址行 1 |
|
位址行 2
|
addressLine2 | string |
地址行 2 |
|
地址城市
|
addressCity | string |
城市 |
|
addressState
|
addressState | string |
State |
|
地址郵遞區號
|
addressZipCode | string |
郵遞區號 |
|
地址國家
|
addressCountry | string |
國家 |
|
地址縣
|
addressCounty | string |
國家 |
|
國家標識碼
|
nationalId | string |
國民身分證 |
|
nationalId國家/地區
|
nationalIdCountry | string |
國民身分證的國家/地區 |
|
dateOfBirth
|
dateOfBirth | string |
出生日期 |
|
性
|
gender | string |
性別 |
|
ethnicID代碼
|
ethnicIDCode | string |
民族身份證碼 |
|
婚姻狀態代碼
|
maritalStatusCode | string |
婚姻狀況代碼 |
|
社會安全號碼
|
ssn | string |
社會安全號碼 |
|
ssnIs抑制
|
ssnIsSuppressed | boolean |
指出社會安全號碼是否被隱藏 |
getEmployeePayStatement
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
應計費用
|
accruals | array of object |
應計明細一覽 |
|
金額當前
|
accruals.amountcurrent | double |
當前應計金額 |
|
amount類型
|
accruals.amounttype | string |
應計金額類型 |
|
餘額
|
accruals.balance | double |
當前應計餘額 |
|
計劃代碼
|
accruals.plancode | string |
識別計劃的代碼 |
|
計劃說明
|
accruals.plandescription | string |
計劃的描述 |
|
位址行1
|
addressline1 | string |
地址行 1 |
|
地址行2
|
addressline2 | string |
地址行 2 |
|
city
|
city | string |
位址所在的城市 |
|
公司地址城市
|
companyaddresscity | string |
公司所在城市地址 |
|
公司地址國家/地區
|
companyaddresscountry | string |
公司國家地址 |
|
公司地址縣
|
companyaddresscounty | string |
公司縣地址 |
|
公司地址line1
|
companyaddressline1 | string |
公司地址行 1 |
|
公司地址line2
|
companyaddressline2 | string |
公司地址行2 |
|
公司地址郵遞區號
|
companyaddresspostalcode | string |
公司地址的郵遞區號 |
|
公司地址州或省份
|
companyaddressstateorprovince | string |
公司地址的州或省 |
|
公司名稱
|
companyname | string |
公司名稱 |
|
公司電話
|
companyphone | string |
公司主要電話號碼 |
|
公司電話分機
|
companyphoneext | string |
公司電話的分機 |
|
country
|
country | string |
位址所在的國家/地區 |
|
扣除額
|
deductions | array of object | |
|
基礎金額
|
deductions.basisamount | double |
扣除的基準金額 |
|
扣除代碼
|
deductions.deductioncode | string |
識別扣除額的代碼 |
|
扣除說明
|
deductions.deductiondescription | string |
扣除說明 |
|
員工金額
|
deductions.employeeamount | double |
從員工那裡扣除的金額 |
|
員工金額ytd
|
deductions.employeeamountytd | double |
當年從僱員那裡扣除的金額 |
|
雇主金額
|
deductions.employeramount | double |
僱主供款的扣除額 |
|
employeramountytd
|
deductions.employeramountytd | double |
當年僱主扣除額 |
|
稅前
|
deductions.pretax | boolean |
指出扣除額是否為稅前 |
|
扣除額電流
|
deductionscurrent | double |
總電流扣除額 |
|
扣除額ytd
|
deductionsytd | double |
當年扣除總額 |
|
文件
|
document | string |
文件識別碼或描述 |
|
收益
|
earnings | array of object |
收益記錄列表 |
|
金額
|
earnings.amount | double |
收益金額 |
|
amountytd
|
earnings.amountytd | double |
本年度收益金額 |
|
小時
|
earnings.hours | double |
工作時數 |
|
小時ytd
|
earnings.hoursytd | double |
全年工作時數 |
|
支付代碼
|
earnings.paycode | string |
識別付款類型的代碼 |
|
薪酬說明
|
earnings.paydescription | string |
薪資類型說明 |
|
工資率
|
earnings.payrate | double |
工資率 |
|
期間結束
|
earnings.periodend | date-time |
支付期的結束日期 |
|
期間開始
|
earnings.periodstart | date-time |
支付期的開始日期 |
|
計件
|
earnings.piececount | double |
完成的件數（計件） |
|
計件工資率
|
earnings.piecepayrate | double |
每件工資率（計件） |
|
識別類型
|
employeeidentifier.identificationtype | string |
字串 |
|
公司識別碼
|
employeeidentifier.companyidentifier | string |
字串 |
|
員工識別碼
|
employeeidentifier.employeeidentifier | string |
字串 |
|
員工編號
|
employeenumber | string |
識別員工的號碼 |
|
聯邦額外金額預扣
|
federaladditionalamountWithheld | double |
預扣的額外聯邦稅 |
|
聯邦津貼已領取
|
federalallowancesclaimed | double |
申請的聯邦稅收減免 |
|
聯邦備案狀態
|
federalfilingstatus | string |
聯邦報稅狀態 |
|
聯邦應稅工資當前
|
federaltaxablewagescurrent | double |
目前的聯邦應稅工資 |
|
聯邦應稅工資
|
federaltaxablewagesytd | double |
當年聯邦應稅工資 |
|
全名
|
fullname | string |
員工全名 |
|
總電流
|
grosswagescurrent | double |
目前工資總額 |
|
總額
|
grosswagesytd | double |
全年工資總額 |
|
作業
|
job | string |
職位名稱或描述 |
|
位置
|
location | string |
員工的工作地點 |
|
淨支付
|
netpay | array of object |
淨薪酬記錄列表 |
|
帳號
|
netpay.accountnumber | string |
銀行帳號 |
|
帳戶類型
|
netpay.accounttype | string |
銀行帳戶類型 |
|
金額
|
netpay.amount | double |
淨工資金額 |
|
NetPay電流
|
netpaycurrent | double |
當前淨工資 |
|
netpayytd
|
netpayytd | double |
本年度淨薪酬 |
|
組織層級1
|
orglevel1 | string |
組織階層的第一層 |
|
組織層級2
|
orglevel2 | string |
組織層次結構的第二層 |
|
組織層級3
|
orglevel3 | string |
第三層組織層次結構 |
|
組織層級4
|
orglevel4 | string |
第四層組織層次結構 |
|
發薪日期
|
paydate | string |
發放工資的日期 |
|
payperiod頻率
|
payperiodfrequency | string |
發薪期的頻率 |
|
付費組
|
paygroup | string |
薪資的群組分類 |
|
payidentifier
|
payidentifier | string |
付費執行個體的識別碼 |
|
工資率
|
payrate | double |
工資率 |
|
期間結束日期
|
periodenddate | string |
支付期的結束日期 |
|
期間開始日期
|
periodstartdate | string |
支付期的開始日期 |
|
郵遞區號
|
postalcode | string |
員工地址的郵遞區號 |
|
residentstate津貼已索賠
|
residentstateallowancesclaimed | double |
居民申請的州稅免稅額 |
|
居民州備案狀態
|
residentstatefilingstatus | string |
居民的州備案身份 |
|
社會安全號碼
|
ssn | string |
社會安全號碼 |
|
州或省
|
stateorprovince | string |
僱員所在的州或省 |
|
稅
|
taxes | array of object |
稅務記錄列表 |
|
金額
|
taxes.amount | double |
稅額 |
|
amountytd
|
taxes.amountytd | double |
當年的稅額 |
|
基礎金額
|
taxes.basisamount | double |
稅款計算的基準金額 |
|
稅務說明
|
taxes.taxdescription | string |
稅費說明 |
|
稅碼
|
taxes.taxcode | string |
識別稅金的代碼 |
|
稅收現行
|
taxescurrent | double |
當前稅項總額 |
|
稅收
|
taxesytd | double |
當年的稅金總額 |
|
workstateallowancesclaimed
|
workstateallowancesclaimed | double |
僱員申請的州稅免稅額 |
|
workstatefiling狀態
|
workstatefilingstatus | string |
員工的州稅務申報狀況 |
getEmployeeEmploymentDetails
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
公司ID
|
companyID | string |
公司的識別碼 |
|
員工ID
|
employeeID | string |
員工的識別碼 |
|
主要工作代碼
|
primaryJobCode | string |
識別主要工作的程式碼 |
|
職位名稱
|
jobTitle | string |
員工的工作名稱 |
|
fullTime或PartTime代碼
|
fullTimeOrPartTimeCode | string |
指示工作是全職還是兼職的代碼 |
|
primaryWorkLocationCode
|
primaryWorkLocationCode | string |
主要工作位置的程式碼 |
|
主要專案代碼
|
primaryProjectCode | string |
與員工相關聯之主要專案的程式碼 |
|
推導群組代碼
|
deductionGroupCode | string |
識別扣款組的代碼 |
|
earningGroup代碼
|
earningGroupCode | string |
識別收入群組的代碼 |
|
employeeTypeCode
|
employeeTypeCode | string |
定義就業類型的代碼 |
|
employeeStatusCode
|
employeeStatusCode | string |
代表員工目前狀態的代碼 |
|
員工編號
|
employeeNumber | string |
指派給員工的唯一編號 |
|
supervisorId
|
supervisorId | string |
員工主管的識別碼 |
|
原始HireDate
|
originalHireDate | string |
員工最初入職的日期 |
|
lastHireDate
|
lastHireDate | string |
員工最近入職的日期 |
|
終止日期
|
dateOfTermination | string |
員工被解僱的日期 |
|
退休日期
|
dateOfRetirement | string |
員工退休日期 |
|
日期時間已建立
|
dateTimeCreated | string |
建立員工記錄的時間戳記 |
|
日期時間變更
|
dateTimeChanged | string |
上次修改員工記錄的時間戳記 |
|
dateLastPayDate已付
|
dateLastPayDatePaid | string |
向員工支付最後一次付款的日期 |
|
支付組
|
payGroup | string |
薪資的群組分類 |
|
是家公司
|
isHomeCompany | boolean |
指出公司是否為員工的母公司 |
|
頁面
|
page | integer |
編頁回應中的頁碼 |
|
per_Page
|
per_Page | integer |
編頁回應中每頁的項目數 |
getEmployeeDemographicDetails
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
種族描述
|
ethnicDescription | string |
種族背景 |
|
附加名稱1
|
additionalName1 | string |
其他名稱欄位 1 |
|
附加名稱2
|
additionalName2 | string |
其他名稱欄位 2 |
|
地址標識碼
|
addressId | string |
地址的識別碼 |
|
地址IsOnTaxBoundary
|
addressIsOnTaxBoundary | string |
稅務邊界狀況地址 |
|
地址緯度
|
addressLatitude | double |
地址的地理緯度 |
|
殘障類型
|
disabilityType | string |
殘疾類型 |
|
前名稱
|
formerName | string |
以前的名字 |
|
健康血型
|
healthBloodType | string |
血型信息 |
|
健康眼睛
|
healthEyes | string |
眼睛顏色資訊 |
|
健康頭髮
|
healthHair | string |
髮色信息 |
|
健康高度腳
|
healthHeightFeet | string |
身高（英尺） |
|
健康高度英吋
|
healthHeightInches | string |
高度（英寸） |
|
健康最後捐贈日期
|
healthLastDonateDate | string |
最後一次捐血日期 |
|
健康體重
|
healthWeight | double |
以適當單位表示的重量 |
|
上一頁SSN
|
previousSSN | string |
以前的社會安全號碼 |
|
原產地國家
|
originCountry | string |
原產國 |
|
originLocation
|
originLocation | string |
原產地 |
|
地址短信
|
addressSms | string |
簡訊通知的地址 |
|
homePhoneIsPrivate
|
homePhoneIsPrivate | boolean |
家庭電話號碼是私人的 |
|
lastNameNotSameAsSSCard
|
lastNameNotSameAsSSCard | string |
姓氏與SS卡不同 |
|
國籍1
|
nationality1 | string |
第一國籍信息 |
|
國籍2
|
nationality2 | string |
第二國籍信息 |
|
國籍3
|
nationality3 | string |
第三國籍信息 |
|
personId
|
personId | string |
人員的識別碼 |
|
員工編號
|
employeeId | string |
員工的識別碼 |
|
companyId
|
companyId | string |
公司的識別碼 |
|
名字
|
firstName | string |
名字 |
|
中間名
|
middleName | string |
中間名 |
|
lastName
|
lastName | string |
姓氏 |
|
preferredName
|
preferredName | string |
偏好名稱 |
|
namePrefixCode
|
namePrefixCode | string |
名稱的前置詞代碼 |
|
nameSuffixCode
|
nameSuffixCode | string |
名稱的尾碼 |
|
電子郵件地址
|
emailAddress | string |
電子郵件地址 |
|
電子郵件地址替代
|
emailAddressAlternate | string |
備用電子郵件地址 |
|
首頁電話ID
|
homePhoneID | string |
家庭電話的識別碼 |
|
首頁電話
|
homePhone | string |
家庭電話號碼 |
|
首頁電話國家
|
homePhoneCountry | string |
家庭電話的國家/地區代碼 |
|
addressLine1
|
addressLine1 | string |
主要地址行 |
|
位址行 2
|
addressLine2 | string |
次要地址行 |
|
addressLine3
|
addressLine3 | string |
第三級地址行 |
|
地址行4
|
addressLine4 | string |
第四元位址行 |
|
地址城市
|
addressCity | string |
位址所在的城市 |
|
addressState
|
addressState | string |
地址狀態 |
|
地址郵遞區號
|
addressZipCode | string |
地址的郵政編碼 |
|
地址國家
|
addressCountry | string |
位址所在的國家/地區 |
|
地址縣
|
addressCounty | string |
地址縣 |
|
dateOfBirth
|
dateOfBirth | string |
出生日期 |
|
性
|
gender | string |
個人的性別 |
|
ethnicId代碼
|
ethnicIdCode | string |
民族身份證碼 |
|
是吸煙者
|
isSmoker | boolean |
指示此人是否是吸煙者 |
|
isDisabled （已禁用）
|
isDisabled | string |
身心障礙狀態 |
|
婚姻狀態代碼
|
maritalStatusCode | string |
婚姻狀況代碼 |
|
社會安全號碼
|
ssn | string |
社會安全號碼 |
|
ssnIs抑制
|
ssnIsSuppressed | boolean |
指示是否抑制SSN |
|
使用者識別碼
|
userID | string |
使用者識別碼 |
|
integrationRecordId
|
integrationRecordId | string |
整合記錄識別碼 |
|
手機號碼
|
cellPhoneNumber | string |
手機號碼 |
returnsAListOfDetailsForAGeneralLedgerRun
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
runId
|
runId | string |
執行的唯一識別碼 |
|
payPeriodEndDate
|
payPeriodEndDate | string |
支付期的結束日期 |
|
accountType 帳戶類型
|
accountType | string |
帳戶類型 |
|
基礎區段
|
baseSegment | string |
基本區段識別碼 |
|
公司代碼
|
companyCode | string |
識別公司的代碼 |
|
信用額度
|
creditAmt | double |
記錄的信用額度 |
|
借方
|
debitAmt | double |
記錄的借方金額 |
|
描述
|
description | string |
交易說明 |
|
generalLedger帳戶
|
generalLedgerAccount | string |
總帳帳號 |
|
工作代碼
|
jobCode | string |
作業代碼 |
|
job描述
|
jobDesc | string |
職位描述 |
|
位置
|
location | string |
交易地點 |
|
組織層級1
|
orgLevel1 | string |
組織階層的第一層 |
|
組織層級2
|
orgLevel2 | string |
組織層次結構的第二層 |
|
組織層級3
|
orgLevel3 | string |
第三層組織層次結構 |
|
組織層級4
|
orgLevel4 | string |
第四層組織層次結構 |
|
支付組
|
payGroup | string |
薪資群組識別碼 |
|
periodEndDate
|
periodEndDate | string |
會計期間結束日期 |
|
periodStartDate
|
periodStartDate | string |
會計期間的開始日期 |
|
位置代碼
|
positionCode | string |
職位代碼 |
|
positionDesc
|
positionDesc | string |
職位描述 |
|
專案
|
project | string |
專案識別碼 |
|
systemId
|
systemId | double |
系統識別號碼 |
|
區塊標識符
|
blockId | double |
系統內的區塊識別碼 |
|
coId
|
coId | string |
公司識別碼 |
|
glRunDateTime
|
glRunDateTime | string |
GL 執行的日期和時間 |
|
總區塊數
|
totalNrOfBlocks | double |
執行中的區塊總數 |
|
userWhoRanThisGl
|
userWhoRanThisGl | string |
執行 GL 執行的使用者 |
|
glJson
|
glJson | string |
總帳執行的 JSON 資料 |
採取AnXmlTransactionAndFeedsItIntoTheImportTool
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
暫存標識符
|
stagingId | string |
暫置記錄的識別碼 |
|
日期時間已建立
|
dateTimeCreated | string |
建立記錄的時間戳記 |
|
fileName
|
fileName | string |
檔案名稱 |
employeeIdLookup
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
型別
|
type | string |
錯誤或狀態類型 |
|
title
|
title | string |
摘要錯誤或狀態的標題 |
|
detail
|
detail | string |
錯誤或狀態的詳細描述 |
|
錯誤計數
|
errorCount | double |
報告的錯誤數目 |
|
多狀態
|
multistatus | array of object | |
|
序列標識符
|
multistatus.sequenceId | double |
多狀態序列的識別碼 |
|
狀態
|
multistatus.status | string |
多狀態作業的狀態 |
|
屬性名稱
|
multistatus.modelstate.property-name | array of object |
以屬性名稱索引鍵的錯誤訊息清單 |
|
訊息
|
multistatus.modelstate.property-name.message | string |
特定屬性的錯誤訊息 |
|
型別
|
multistatus.modelstate.property-name.type | string |
特定屬性的錯誤類型 |
|
歐洲電路板
|
multistatus.body.eeid | string |
員工識別碼 |
|
科伊德
|
multistatus.body.coid | array of string |
公司識別碼列表;家公司是第一位的 |
getASpecificEmployeesPtoplans
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
員工編號
|
employeeId | string |
員工的唯一識別碼 |
|
companyId
|
companyId | string |
與員工相關聯之公司的識別碼 |
|
取材計劃
|
ptoPlan | string |
適用於員工的 PTO 計劃的識別碼 |
|
獲得
|
earned | double |
員工賺取的 PTO 總小時數 |
|
拍攝
|
taken | double |
員工的 PTO 總時數 |
|
pending餘額
|
pendingBalance | double |
待處理 PTO 小時數的當前餘額 |
|
earnedThroughDate
|
earnedThroughDate | string |
PTO 應計的最後日期 |
|
重置
|
reset | string |
PTO 餘額重置的日期 |
|
pendingMoveDate
|
pendingMoveDate | string |
與待處理的 PTO 規則相關的日期 |
getEmployeeSupervisor詳細資料
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
員工ID
|
employeeID | string |
員工的識別碼 |
|
公司ID
|
companyID | string |
員工公司的識別碼 |
|
員工編號
|
employeeNumber | string |
指派給員工的唯一編號 |
|
主管員工識別碼
|
supervisorEmployeeID | string |
主管的識別碼 |
|
主管名字
|
supervisorFirstName | string |
主管的名字 |
|
supervisor姓氏
|
supervisorLastName | string |
主管的姓氏 |
|
主管員工編號
|
supervisorEmployeeNumber | string |
主管員工編號 |
|
主管公司識別碼
|
supervisorCompanyID | string |
主管的公司識別碼 |
|
主管公司代碼
|
supervisorCompanyCode | string |
與主管相關聯的公司代碼 |
|
supervisorStatusCode
|
supervisorStatusCode | string |
代表主管就業狀況的狀態代碼 |
|
主管工作代碼
|
supervisorJobCode | string |
指派給主管的工作代碼 |
|
主管職位代碼
|
supervisorPositionCode | string |
指派給主管的職位代碼 |
|
主管電子郵件
|
supervisorEmail | string |
主管的電子郵件地址 |
|
主管工作電話
|
supervisorWorkPhone | string |
主管的工作電話號碼 |
|
supervisorPersonId
|
supervisorPersonId | string |
主管作為個人的唯一識別碼 |
getAllDetailsForAPersonAssignedToAnEmployeeAsAContact
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
city
|
city | string |
位址所在的城市 |
|
countryCode （國家代碼）
|
countryCode | string |
地址的國家代碼 |
|
縣
|
county | string |
地址縣 |
|
地址是與員工不同
|
addressIsDifferentFromEmployee | boolean |
指出地址是否與員工地址不同 |
|
addressLine1
|
addressLine1 | string |
主要地址行 |
|
位址行 2
|
addressLine2 | string |
次要地址行 |
|
狀態
|
state | string |
地址狀態 |
|
郵遞區號
|
zipCode | string |
地址的郵政編碼 |
|
眼鏡蛇出口
|
cobraExport | boolean |
指示是否匯出 COBRA 資料 |
|
眼鏡蛇是主動的
|
cobraIsActive | boolean |
指示 COBRA 是否處於活動狀態 |
|
眼鏡蛇理性
|
cobraReason | string |
COBRA 狀態的原因 |
|
眼鏡蛇狀態
|
cobraStatus | string |
目前 COBRA 狀態 |
|
眼鏡蛇狀態日期
|
cobraStatusDate | string |
目前 COBRA 狀態的日期 |
|
dateOfBirth
|
dateOfBirth | string |
出生日期 |
|
dateOfCOBRA出門
|
dateOfCOBRAEvent | string |
COBRA 活動日期 |
|
dateOfCOBRA萊特
|
dateOfCOBRALetter | string |
COBRA 信函發出日期 |
|
員工編號
|
employeeId | string |
員工的識別碼 |
|
性
|
gender | string |
個人的性別 |
|
importId
|
importId | string |
匯入識別碼 |
|
是受益人
|
isBeneficiary | boolean |
表明個人是否是受益人 |
|
是相依性
|
isDependent | boolean |
指出個人是否為受撫養人 |
|
isDisabled （已禁用）
|
isDisabled | boolean |
指出個人是否已停用 |
|
是緊急聯絡方式
|
isEmergencyContact | boolean |
指出個人是否為緊急聯絡人 |
|
是吸煙者
|
isSmoker | boolean |
指出個人是否是吸煙者 |
|
是學生
|
isStudent | boolean |
指出個人是否為學生 |
|
結婚日期
|
marriageDate | string |
結婚日期 |
|
名字
|
firstName | string |
個人的名字 |
|
前名稱
|
formerName | string |
個人的舊名 |
|
lastName
|
lastName | string |
個人姓氏 |
|
中間名
|
middleName | string |
個人的中間名 |
|
name後綴
|
nameSuffix | string |
個人姓名的後綴 |
|
職業
|
occupation | string |
個人職業 |
|
其他保險
|
otherInsurance | string |
其他保險詳情 |
|
首頁電話國家
|
homePhoneCountry | string |
家庭電話的國家/地區代碼 |
|
首頁電話號碼
|
homePhoneNumber | string |
家庭電話號碼 |
|
其他電話號碼
|
otherPhoneNumber | string |
其他電話號碼 |
|
其他電話類型
|
otherPhoneType | string |
其他電話類型 |
|
preferred電話號碼
|
preferredPhoneNumber | string |
首選電話號碼 |
|
關係代碼
|
relationshipCode | string |
描述關聯性的程式碼 |
|
關係說明
|
relationshipDescription | string |
關係描述 |
|
社會安全號碼
|
ssn | string |
社會安全號碼 |
|
contactId
|
contactId | string |
聯絡人的識別碼 |
|
userDefinedField01
|
userDefinedField01 | string |
自訂欄位以取得其他資訊 |
|
workPhoneExtension 的
|
workPhoneExtension | string |
公司電話號碼的分機 |
|
工作電話號碼
|
workPhoneNumber | string |
公司電話號碼 |
|
眼鏡蛇筆記
|
cobraNotes | string |
與 COBRA 相關的注意事項 |
|
附註
|
notes | string |
關於個人的一般注意事項 |
|
是活躍的
|
isActive | boolean |
指出記錄是否處於作用中狀態 |
|
statusAsOfDate
|
statusAsOfDate | string |
目前狀態的日期 |
|
死亡日期
|
deathDate | string |
死亡日期 |
|
離婚日期
|
divorceDate | string |
離婚日期 |
|
電子郵件地址
|
emailAddress | string |
電子郵件地址 |
|
其他電話國家代碼
|
otherPhoneCountryCode | string |
其他手機的國家/地區代碼 |
|
healthCareId
|
healthCareId | string |
醫療保健識別碼 |
|
國家標識碼
|
nationalId | string |
國家識別碼 |
|
nationalId到期日期
|
nationalIdExpirationDate | string |
國民身分證的有效期限 |
|
personID
|
personID | string |
人員的唯一識別碼 |
|
地址ID
|
addressID | string |
地址識別碼 |
|
workPhoneId
|
workPhoneId | string |
公司電話的識別碼 |
|
homePhoneId
|
homePhoneId | string |
家庭電話的識別碼 |
|
其他PhoneId
|
otherPhoneId | string |
另一部手機的識別碼 |