intelliHR （預覽版）

intelliHR 是一個基於雲的人員管理平台，具有高級分析功能。連線到您的 intelliHR 租用戶，以自動化以人為本的工作流程（例如上線）和資料匯出。

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

服務	Class	Regions
副駕駛工作室	進階	除下列區域外的所有 Power Automate 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
邏輯應用程式	標準	所有 Logic Apps 區域，但下列區域除外： - Azure Government 區域 - Azure 中國區域 - 美國國防部（DoD）
Power Apps	進階	除下列區域外的所有 Power Apps 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
Power Automate（自動化服務）	進階	除下列區域外的所有 Power Automate 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）

連絡人
名稱	客戶支持
URL	https://intellihr.zendesk.com/hc/en-us
Email	support@intellihr.co

連接器中繼資料
Publisher	intelliHR
網站	https://www.intellihr.com
隱私策略	https://intellihr.co/privacy-policy/
類別	人力資源;商業智慧

intelliHR 是一個易於使用的人員管理和分析平台，可集中在一個地方進行績效管理、員工敬業度、核心人力資源流程和人力資源分析。使用 IntelliHR 連接器，使用 Power Automate、Office 365、SharePoint Microsoft Dynamics 365 和其他服務中的人員資料建立排程工作和自動化工作流程，無需程式碼。

先決條件

若要使用此連接器，您必須擁有 intelliHR 租用戶。若要為您的團體或組織佈建租用戶，請造訪此頁面。

如何取得認證

若要設定連接器，您將需要 API 金鑰和租用戶名稱。

您的租戶名稱將與您的帳戶子網域相對應（例如。 https://this-is-your-tenant-name.intellihr.net

若要建立 API 金鑰：

使用管理員帳戶登入您的租用戶
導覽至「設定」頁面
搜尋「API」，然後按一下「公共 API 存取金鑰」
請依照此頁面上的提示建立金鑰。

您也可以在以下位置找到正確的介面 https://your-tenant.intellihr.net/spa/settings/access-keys

開始使用連接器

新增 intelliHR 連接器時，系統會提示您輸入租用戶名稱和 API 金鑰，以及連線的顯示名稱。

要：輸入 API 金鑰時，請務必在金鑰前面加上「Bearer」，以便輸入應為「Bearer xyz123」。否則將導致「API 金鑰無效」錯誤。

已知問題與限制

intelliHR 連接器是 intelliHR 公用 API 的翻譯，因此它繼承相同的限制，並需要對請求進行相同的驗證。

常見錯誤和補救措施

由於 intelliHR 連接器會將要求傳遞至 intelliHR 的公用 API，因此大部分問題都可以透過參考公用 API 文件來疑難排解。

如果要求的某些部分不適當，則會傳回 400 範圍錯誤，並伴隨描述問題的訊息。最常見的問題是連接器在 API 金鑰輸入中配置時沒有「持有人」。

正在建立連線

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


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

預設

適用：所有地區

建立連線的參數。

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

名稱	類型	Description	為必填項目
API 金鑰	securestring	此 API 的 API 金鑰，前面加上 'Bearer'	對
租戶	字串	您的 intelliHR 租用戶名稱	對

節流限制

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

動作

依 ID 尋找 Webhook	傳回單一 Webhook。
依 ID 尋找工作類別	傳回單一工作類別。
依 ID 尋找業務單位	傳回單一業務單位。
依 ID 尋找預設報酬元件	傳回單一預設報酬元件。
依 ID 更新文件	更新文件
依ID尋找Webhook事件	傳回單一 Webhook 事件。
依識別碼刪除 Webhook	刪除提供的 Webhook。
依識別碼刪除業務單位	按給定 ID 刪除業務單位。
依識別碼刪除訓練記錄	刪除提供的訓練記錄。
依識別碼尋找自訂欄位定義	傳回單一自訂欄位定義。
依識別碼尋找訓練記錄	傳回單一訓練記錄。
依識別碼更新業務單位	傳回更新的業務單位。
依識別碼更新訓練記錄	更新訓練記錄
依身分證件更新人員	更新人員
修補現有任務	使用提供的資料修補現有工作記錄的屬性。
列出所有人員	傳回目前日期所有人員的清單。
列出所有位置	傳回所有位置的清單。
列出所有僱傭條件	傳回所有僱傭條件的清單。
列出所有商業實體	傳回所有商業實體的清單。
列出所有培訓提供者	傳回所有訓練提供者的清單。
列出所有工作	傳回目前日期所有工作實體記錄的清單。
列出所有工作權利	傳回系統中記錄的所有工作權利清單。
列出所有工作類別	傳回系統中記錄的所有工作類別的清單。
列出所有工作類型	傳回系統中記錄的所有工作類型的清單。
列出所有招聘來源	傳回所有招募來源的清單。
列出所有業務單位	傳回系統中記錄的所有業務單位的清單。
列出所有自訂欄位定義	傳回所有自訂欄位定義的清單。
列出所有薪資等級	傳回所有薪資等級的清單。
列出所有訓練	傳回所有訓練記錄的清單。
列出所有訓練類型	傳回所有訓練類型的清單。
列出所有預設報酬組成部分	傳回系統中記錄的所有預設報酬組成部分的清單。
建立新工作	使用提供的資料建立新的工作記錄。
建立新的人員記錄	建立人員
建立新的業務單位	傳回已建立的業務單位。
建立訓練記錄	建立新的訓練記錄
建立預先簽署的上傳網址	建立預先簽署的上傳網址
按 ID 查找培訓提供者	傳回單一訓練提供者。
按 ID 查找工作類型	傳回單一工作類型。
按 ID 查找工資等級	傳回單一薪資等級。
按 ID 查找訓練類型	傳回單一訓練類型。
更新AWebhook	修補 Webhook
設定作業的結束日期	設定作業的結束日期
透過 ID 尋找商業實體	依其識別碼傳回單一商業實體。
透過身分證件尋找就業條件	傳回單一僱傭條件。
通過 ID 查找人員	依 UUIDv4 識別碼取得單一人員記錄。
通過 ID 查找位置	傳回單一位置。
通過 ID 查找作品	傳回單一工作權利。
通過 ID 查找工作	依 UUIDv4 識別碼取得單一工作記錄。
通過 ID 查找招聘來源	傳回單一招募來源。

依 ID 尋找 Webhook

作業識別碼：: FindaWebhookbyID

傳回單一 Webhook。

參數

名稱	機碼	必要	類型	Description
Webhook 的識別碼	id	True	string	資源識別碼字串

傳回

單一Webhook: SingleWebhook

依 ID 尋找工作類別

作業識別碼：: FindaWorkClassbyID

傳回單一工作類別。

參數

名稱	機碼	必要	類型	Description
工作類別的 ID	id	True	string	資源識別碼字串

傳回

SingleWorkClass: SingleWorkClass

依 ID 尋找業務單位

作業識別碼：: FindaBusinessUnitbyID

傳回單一業務單位。

參數

名稱	機碼	必要	類型	Description
業務單位的識別碼	id	True	string	資源識別碼字串

傳回

回應: Response

依 ID 尋找預設報酬元件

作業識別碼：: FindaDefaultRemunerationComponentbyID

傳回單一預設報酬元件。

參數

名稱	機碼	必要	類型	Description
薪酬元件 ID	id	True	string	資源識別碼字串

傳回

SingleDefaultRemuneration元件: SingleDefaultRemunerationComponent

依 ID 更新文件

作業識別碼：: PersonDocumentsById_PATCH

更新文件

參數

名稱	機碼	必要	類型	Description
文件的 ID	id	True	string	資源識別碼字串
personId	personId	True	string	此文件所屬人員的識別碼字串。
上傳狀態	uploadStatus	True	string	此文件的上傳狀態。枚舉： `SUCCESS`， `PENDING`， `FAILED`.

傳回

PatchaPerson文件: PatchaPersonDocument

依ID尋找Webhook事件

作業識別碼：: FindaWebhookEventbyID

傳回單一 Webhook 事件。

參數

名稱	機碼	必要	類型	Description
Webhook 事件的識別碼	id	True	string	資源識別碼字串

傳回

單一 Webhook 事件。

Webhook 事件: webhook-events

依識別碼刪除 Webhook

作業識別碼：: DeleteaWebhookbyID

刪除提供的 Webhook。

參數

名稱	機碼	必要	類型	Description
Webhook 的識別碼	id	True	string	資源識別碼字串

傳回

response: string

依識別碼刪除業務單位

作業識別碼：: DeleteaBusinessUnitbyID

按給定 ID 刪除業務單位。

參數

名稱	機碼	必要	類型	Description
業務單位的識別碼	id	True	string	資源識別碼字串

傳回

response: string

依識別碼刪除訓練記錄

作業識別碼：: DeleteaTrainingbyID

刪除提供的訓練記錄。

參數

名稱	機碼	必要	類型	Description
訓練記錄的識別碼	id	True	string	資源識別碼字串

傳回

response: string

依識別碼尋找自訂欄位定義

作業識別碼：: FindaCustomFieldDefinitionbyID

傳回單一自訂欄位定義。

參數

名稱	機碼	必要	類型	Description
自訂欄位的ID	id	True	string	資源識別碼字串

傳回

SingleCustomField定義: SingleCustomFieldDefinition

依識別碼尋找訓練記錄

作業識別碼：: FindaTrainingbyID

傳回單一訓練記錄。

參數

名稱	機碼	必要	類型	Description
訓練記錄的識別碼	id	True	string	資源識別碼字串

傳回

單體訓練: SingleTraining

依識別碼更新業務單位

作業識別碼：: UpdateaBusinessUnitbyID

傳回更新的業務單位。

參數

名稱	機碼	必要	類型	Description
業務單位的識別碼	id	True	string	資源識別碼字串
識別碼	identifier		string	可用於管理工作的選用識別碼。
名稱	name	True	string	該業務單位的名稱。此名稱通常會顯示給系統的使用者。
附註	notes		string	附加到業務單位的附註
parentId	parentId		string	父業務單位的識別碼字串，如果沒有父業務單位，則為 null （這是最上層業務單位）。
isEnabled	isEnabled		boolean	指定使用者是否可以在下拉式清單中選取此業務單位。

傳回

回應: Response

依識別碼更新訓練記錄

作業識別碼：: UpdateTrainingByID

更新訓練記錄

參數

名稱	機碼	必要	類型	Description
訓練記錄的識別碼	id	True	string	資源識別碼字串
識別碼	id		string	人員要在系統中尋找的識別碼字串。
名稱	name		string	要搜尋的 intelliHR 中人員的名稱。請注意，搜尋會自動考慮名稱順序的差異。
primaryEmailAddress的	primaryEmailAddress		string	標示為系統內人員的主要電子郵件地址。
員工編號	employeeNumber		string	手動輸入的員工編號，用於識別 intelliHR 中的人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
autoIncrementIntellihrId	autoIncrementIntellihrId		string	自動產生的號碼，可在 intelliHR 中唯一識別人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
完成日期	completionDate		string	訓練完成的時間戳記。此日期將遵循 RFC3339定義的格式。 YYYY- 也支援MM-DD 日期格式，不過使用此格式，日期會儲存為UTC時間的一天開始，而不是要求租用戶時區。
成本	cost		string	本次培訓的費用。
貨幣	currency		string	用於此訓練的貨幣。未提供時，將預設為租用戶預設貨幣。國際貨幣代碼。通常澳元代表澳元，美元代表美元等。請參閱官方代碼列表。
小時	hours		string	本次培訓花費了多少小時
識別碼	id		string	完成此訓練之任務的識別碼字串。
名稱	name		string	為此訓練提供使用者友善的名稱，以在系統中識別它。
識別碼	id		string	人員要在系統中尋找的識別碼字串。
名稱	name		string	要搜尋的 intelliHR 中人員的名稱。請注意，搜尋會自動考慮名稱順序的差異。
primaryEmailAddress的	primaryEmailAddress		string	標示為系統內人員的主要電子郵件地址。
員工編號	employeeNumber		string	手動輸入的員工編號，用於識別 intelliHR 中的人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
autoIncrementIntellihrId	autoIncrementIntellihrId		string	自動產生的號碼，可在 intelliHR 中唯一識別人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
識別碼	id		string	訓練之訓練提供者的識別碼字串。
名稱	name		string	提供給培訓培訓提供者的用戶友好名稱。
識別碼	id		string	訓練的訓練類型識別碼字串。
名稱	name		string	指定給訓練的訓練類型的使用者易記名稱。
自訂欄位	customFields			此訓練的自訂欄位值

傳回

單體訓練: SingleTraining

依身分證件更新人員

作業識別碼：: UpdatePersonByID

更新人員

參數

名稱	機碼	必要	類型	Description
人員記錄的 ID	id	True	string	資源識別碼字串
名字	firstName		string	人員的名字。
中間名	middleName		string	此人的中間名。
lastName	lastName		string	此人的姓氏。
preferredName	preferredName		string	此人的偏好名稱。一般可以由員工自行配置。
dateOfBirth	dateOfBirth		string	出生日期（YYYY-MM-DD）。
性	gender		string	人為性別的人類可讀字串，例如 `Male`. 搜索不區分大小寫，並且“開頭為”，例如，傳遞 `male` 將與名為“男性”的性別匹配，“m”或“M”也是如此。如果多個性別相符，則會選擇第一個。
員工編號	employeeNumber		string	手動輸入的員工編號，用於識別 intelliHR 中的人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
title	title		string	稱呼此人的頭銜，例如“先生”。如果未提供，則為 null，且不區分大小寫。
名稱	name		string	緊急聯絡人的名稱。
關聯	relationship		string	此緊急聯絡人與此人的關係。
phone	phone		string	緊急聯絡人的電話號碼。
電子郵件	email		string	緊急聯絡人的電子郵件。
電子郵件	email		string	與此人員相關聯的電子郵件地址。
是個人的	isPersonal		boolean	表示此電子郵件是個人電子郵件還是工作電子郵件。
isPrimary	isPrimary		boolean	表示此電子郵件是否為主要聯絡電子郵件。
數字	number		string	電話號碼。此號碼可以以區號為前綴。發生這種情況時，系統會自動嘗試確定電話號碼的來源國家/地區
是個人的	isPersonal		boolean	表示此電話是個人電話號碼還是工作電話號碼。
isPrimary	isPrimary		boolean	表示此電話是否為主要聯絡電話號碼。
addressType	addressType		string	枚舉： `Home`， `Postal`. 地址類型。
完整地址	fullAddress		string	完整的可讀地址，減去郵遞區號和國家/地區
country	country		string	地址所在的國家/地區。
郵遞區號	postcode		string	地址的郵遞區號。
狀態	state		string	位址所處的狀態。這是澳大利亞特有的，可能並不總是提供。
街道	street		string	地址所在的街道。這是澳大利亞特有的，可能並不總是提供。
郊區	suburb		string	地址所在的郊區。這是澳大利亞特有的，可能並不總是提供。
自訂欄位	customFields		object	此人員的自訂欄位值
識別碼	id		string	此人員所屬之工作權利的識別碼字串。
名稱	name		string	工作權的名稱。
workRight到期日期	workRightExpiryDate		string	此人的工作權利到期日期（YYYY-MM-DD）。

傳回

單人: SinglePerson

修補現有任務

作業識別碼：: PatchanexistingJob

使用提供的資料修補現有工作記錄的屬性。

參數

名稱	機碼	必要	類型	Description
工作的識別碼	id	True	string	資源識別碼字串
effectiveFrom	effectiveFrom	True	string	此職位更新在組織內部生效的日期。請注意，這不會影響整體作業本身的開始日期。值 `null` 會指出此更新從工作開始生效。此日期將遵循 RFC3339定義的格式。 YYYY- 也支援MM-DD 日期格式，不過使用此格式，日期會儲存為UTC時間的一天開始，而不是要求租用戶時區。
有效至	effectiveTo		string	此職位更新在組織內生效的日期。請注意，這不會影響整體作業本身的結束日期。此日期將遵循 RFC3339定義的格式。 YYYY- 也支援MM-DD 日期格式，不過使用此格式，日期會儲存為UTC時間的一天開始，而不是要求租用戶時區。
名稱	name		string	要更新的工作名稱
識別碼	id		string	此工作所屬商業實體的 ID 字串。
名稱	name		string	該商業實體的名稱。此名稱通常會顯示給系統的使用者。
法律名稱	legalName		string	商業實體的法定名稱。通常用於管理任務。
數字	number		string	合法註冊的商業實體編號，例如在澳大利亞，這可能是 ABN，在美國可能是 RN。
識別碼	id		string	此工作所屬業務單位的識別碼字串。
名稱	name		string	該業務單位的名稱。此名稱通常會顯示給系統的使用者。
識別碼	id		string	人員要在系統中尋找的識別碼字串。
名稱	name		string	要搜尋的 intelliHR 中人員的名稱。請注意，搜尋會自動考慮名稱順序的差異。
primaryEmailAddress的	primaryEmailAddress		string	標示為系統內人員的主要電子郵件地址。
員工編號	employeeNumber		string	手動輸入的員工編號，用於識別 intelliHR 中的人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
autoIncrementIntellihrId	autoIncrementIntellihrId		string	自動產生的號碼，可在 intelliHR 中唯一識別人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
識別碼	id		string	此工作的主管工作的識別碼字串。
名稱	name		string	主管職位的名稱/職位名稱。
識別碼	id		string	位置的識別碼字串。
名稱	name		string	該位置的名稱。此名稱通常會顯示給系統的使用者。
address	address		string	此位置的位址。
識別碼	id		string	此工作所屬之工作類別的 ID 字串。
名稱	name		string	工作類別的名稱。
識別碼	id		string	此工作所屬之「工作類型」的識別碼字串。
名稱	name		string	工作類型的名稱。枚舉： `Permanent`， `Fixed Contract`， `Unpaid`， `Temporary/Casual`，， `Independent Contract`.
FTE	fte		string	相當於這份工作的全職工作。表示員工的工作量，可以在不同環境中進行比較。對於沒有 FTE 的人來說，這是無效的。
識別碼	id		string	薪資等級的識別碼字串。
字碼	code		string	與薪資等級相關的行政短代碼。
名稱	name		string	給薪資等級的使用者友善名稱。
型別	type		string	此報酬表的支付方式。枚舉： `Annual Salary`， `Hourly Rate`， `No Remuneration Schedule`.
支付週期	payCycle	True	string	工作支付的週期。枚舉： `Weekly`， `Fortnightly`， `Monthly`.
貨幣	currency		string	支付此工作的基本金額和總金額的貨幣。國際貨幣代碼。通常澳元代表澳元，美元代表美元等。請參閱官方代碼列表。
識別碼	id		string	本薪酬表的僱傭條件的識別碼字串。
名稱	name		string	本僱傭條件的名稱。
獎項名稱	awardName		string	獎勵名稱可以與呈現給使用者的名稱不同。通常用於獎項的法定名稱。
每週期的小時數	hoursPerCycle	True	double	每個工資週期的工作小時數。
base年薪	baseAnnualSalary		double	每年支付的基本工資，僅當薪酬表類型為“年薪”時才需要。
baseHourlyRate （基本每小時費率）	baseHourlyRate		double	按小時支付的基本費率，僅當薪酬表類型為「小時費率」時才需要。
名稱	name	True	string	此新增的名稱。
型別	type	True	string	如何計算此加法並將其套用至基本金額，MultipleOfBase 會乘以 baseAnnualSalary，然後新增至總計，而 FixedAmount 會直接新增至總計。枚舉： `MultipleOfBase`， `FixedAmount`.
value	value	True	string	對於 MultipleOfBase，這是乘數（例如 9 = 9%），而對於固定金額，這是直接添加到總數中的金額。
貨幣	currency		string	用於此新增的貨幣。國際貨幣代碼。通常澳元代表澳元，美元代表美元等。請參閱官方代碼列表。
識別碼	id		string	預設報酬元件的識別碼字串。
名稱	name		string	預設酬金組成部分的名稱。
名稱	name	True	string	此新增的名稱。
型別	type	True	string	如何計算此加法並將其套用至基本金額，MultipleOfBase 會乘以 baseAnnualSalary，然後新增至總計，而 FixedAmount 會直接新增至總計。枚舉： `MultipleOfBase`， `FixedAmount`.
value	value	True	string	對於 MultipleOfBase，這是乘數（例如 9 = 9%），而對於固定金額，這是直接添加到總數中的金額。
貨幣	currency		string	用於此新增的貨幣。國際貨幣代碼。通常澳元代表澳元，美元代表美元等。請參閱官方代碼列表。
名稱	name	True	string	這個故障的名稱。
型別	type	True	string	如何計算此明細並套用至基本金額，MultipleOfBase 會乘以 baseAnnualSalary，然後新增至總計，而 FixedAmount 會直接新增至總計。枚舉： `MultipleOfBase`， `FixedAmount`.
value	value	True	string	對於 MultipleOfBase，這是乘數（例如 9 = 9%），而對於固定金額，這是直接添加到總數中的金額。
貨幣	currency		string	用於此細分的貨幣。國際貨幣代碼。通常澳元代表澳元，美元代表美元等。請參閱官方代碼列表。
識別碼	id		string	預設報酬元件的識別碼字串。
名稱	name		string	預設酬金組成部分的名稱。

傳回

單一工作: SingleJob

列出所有人員

作業識別碼：: Listallpeople

傳回目前日期所有人員的清單。

參數

名稱	機碼	類型	Description
每頁的項目數	limit	integer	每頁的項目數
頁碼	page	integer	頁碼
要套用至查詢的篩選器	filters	string	可以在查詢字串中套用篩選條件，以限制從此端點傳回的資料。過濾器以格式 `filters[<filter_name>][<operation_type>]=<filter_value>`提供。例如，取得符合特定ID的專案的篩選器是 `filters[id][eq]=8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9`。
套用至查詢的排序順序	sort	string	可以在查詢字串中套用排序，以排序從此端點傳回的資料。排序可以在前面加上減號，以遞減（-）順序傳回資料。例如，先取得最新記錄的排序會是 `-createdAt`。

傳回

列表人物: ListPeople

列出所有位置

作業識別碼：: Listalllocations

傳回所有位置的清單。

參數

名稱	機碼	必要	類型	Description
每頁的項目數	limit		integer	每頁的項目數
頁碼	page		integer	頁碼

傳回

清單位置: Listlocations

列出所有僱傭條件

作業識別碼：: Listallemploymentconditions

傳回所有僱傭條件的清單。

參數

名稱	機碼	必要	類型	Description
每頁的項目數	limit		integer	每頁的項目數
頁碼	page		integer	頁碼

傳回

就業條件清單: ListofEmploymentConditions

列出所有商業實體

作業識別碼：: ListallBusinessEntities

傳回所有商業實體的清單。

參數

名稱	機碼	必要	類型	Description
每頁的項目數	limit		integer	每頁的項目數
頁碼	page		integer	頁碼

傳回

企業實體清單: ListofBusinessEntities

列出所有培訓提供者

作業識別碼：: ListallTrainingProviders

傳回所有訓練提供者的清單。

參數

名稱	機碼	必要	類型	Description
每頁的項目數	limit		integer	每頁的項目數
頁碼	page		integer	頁碼

傳回

Listall培訓提供者: ListallTrainingProviders

列出所有工作

作業識別碼：: ListallJobs

傳回目前日期所有工作實體記錄的清單。

參數

名稱	機碼	類型	Description
每頁的項目數	limit	integer	每頁的項目數
頁碼	page	integer	頁碼
要套用至查詢的篩選器	filters	string	可以在查詢字串中套用篩選條件，以限制從此端點傳回的資料。過濾器以格式 `filters[<filter_name>][<operation_type>]=<filter_value>`提供。例如，取得符合特定ID的專案的篩選器是 `filters[id][eq]=8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9`。
套用至查詢的排序順序	sort	string	可以在查詢字串中套用排序，以排序從此端點傳回的資料。排序可以在前面加上減號，以遞減（-）順序傳回資料。例如，先取得最新記錄的排序會是 `-createdAt`。

傳回

清單工作: ListJobs

列出所有工作權利

作業識別碼：: ListallWorkRights

傳回系統中記錄的所有工作權利清單。

參數

名稱	機碼	必要	類型	Description
每頁的項目數	limit		integer	每頁的項目數
頁碼	page		integer	頁碼

傳回

工作權利清單: ListofWorkRights

列出所有工作類別

作業識別碼：: Listallworkclasses

傳回系統中記錄的所有工作類別的清單。

參數

名稱	機碼	必要	類型	Description
每頁的項目數	limit		integer	每頁的項目數
頁碼	page		integer	頁碼

傳回

ListWorkClasses: ListWorkClasses

列出所有工作類型

作業識別碼：: ListallWorkTypes

傳回系統中記錄的所有工作類型的清單。

參數

名稱	機碼	必要	類型	Description
每頁的項目數	limit		integer	每頁的項目數
頁碼	page		integer	頁碼

傳回

ListWork類型: ListWorkTypes

列出所有招聘來源

作業識別碼：: Listallrecruitmentsources

傳回所有招募來源的清單。

參數

名稱	機碼	必要	類型	Description
每頁的項目數	limit		integer	每頁的項目數
頁碼	page		integer	頁碼

傳回

招募來源列表: ListofRecruitmentSources

列出所有業務單位

作業識別碼：: ListallBusinessUnits

傳回系統中記錄的所有業務單位的清單。

參數

名稱	機碼	必要	類型	Description
每頁的項目數	limit		integer	每頁的項目數
頁碼	page		integer	頁碼

傳回

業務單位清單: ListofBusinessUnits

列出所有自訂欄位定義

作業識別碼：: ListallCustomFieldDefinitions

傳回所有自訂欄位定義的清單。

參數

名稱	機碼	類型	Description
每頁的項目數	limit	integer	每頁的項目數
頁碼	page	integer	頁碼
要套用至查詢的篩選器	filters	string	可以在查詢字串中套用篩選條件，以限制從此端點傳回的資料。過濾器以格式 `filters[<filter_name>][<operation_type>]=<filter_value>`提供。例如，取得符合特定ID的專案的篩選器是 `filters[id][eq]=8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9`。

傳回

ListofCustomField定義: ListofCustomFieldDefinitions

列出所有薪資等級

作業識別碼：: Listallpaygrades

傳回所有薪資等級的清單。

參數

名稱	機碼	必要	類型	Description
每頁的項目數	limit		integer	每頁的項目數
頁碼	page		integer	頁碼

傳回

薪資等級列表: ListofPayGrades

列出所有訓練

作業識別碼：: ListallTrainings

傳回所有訓練記錄的清單。

參數

名稱	機碼	類型	Description
每頁的項目數	limit	integer	每頁的項目數
頁碼	page	integer	頁碼
要套用至查詢的篩選器	filters	string	可以在查詢字串中套用篩選條件，以限制從此端點傳回的資料。過濾器以格式 `filters[<filter_name>][<operation_type>]=<filter_value>`提供。例如，取得符合特定ID的專案的篩選器是 `filters[id][eq]=8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9`。
套用至查詢的排序順序	sort	string	可以在查詢字串中套用排序，以排序從此端點傳回的資料。排序可以在前面加上減號，以遞減（-）順序傳回資料。例如，先取得最新記錄的排序會是 `-createdAt`。

傳回

培訓清單: ListofTrainings

列出所有訓練類型

作業識別碼：: ListallTrainingTypes

傳回所有訓練類型的清單。

參數

名稱	機碼	必要	類型	Description
每頁的項目數	limit		integer	每頁的項目數
頁碼	page		integer	頁碼

傳回

ListallTrainingTypes: ListallTrainingTypes

列出所有預設報酬組成部分

作業識別碼：: ListallDefaultRemunerationComponents

傳回系統中記錄的所有預設報酬組成部分的清單。

參數

名稱	機碼	必要	類型	Description
每頁的項目數	limit		integer	每頁的項目數
頁碼	page		integer	頁碼

傳回

預設報酬元件清單: ListofDefaultRemunerationComponents

建立新工作

作業識別碼：: CreateanewJob

使用提供的資料建立新的工作記錄。

參數

名稱	機碼	必要	類型	Description
識別碼	id		string	人員要在系統中尋找的識別碼字串。
名稱	name		string	要搜尋的 intelliHR 中人員的名稱。請注意，搜尋會自動考慮名稱順序的差異。
primaryEmailAddress的	primaryEmailAddress		string	標示為系統內人員的主要電子郵件地址。
員工編號	employeeNumber		string	手動輸入的員工編號，用於識別 intelliHR 中的人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
autoIncrementIntellihrId	autoIncrementIntellihrId		string	自動產生的號碼，可在 intelliHR 中唯一識別人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
公司開始日期	companyStartDate	True	string	此工作在組織內開始或將開始的日期。此日期將遵循 RFC3339定義的格式。 YYYY- 也支援MM-DD 日期格式，不過使用此格式，日期會儲存為UTC時間的一天開始，而不是要求租用戶時區。
公司結束日期	companyEndDate		string	本工作在組織內結束或將結束的日期。此日期將遵循 RFC3339定義的格式。 YYYY- 也支援MM-DD 日期格式，不過使用此格式，日期會儲存為UTC時間的一天開始，而不是要求租用戶時區。
名稱	name	True	string	要建立的工作名稱
識別碼	id		string	此工作所屬商業實體的 ID 字串。
名稱	name		string	該商業實體的名稱。此名稱通常會顯示給系統的使用者。
法律名稱	legalName		string	商業實體的法定名稱。通常用於管理任務。
數字	number		string	合法註冊的商業實體編號，例如在澳大利亞，這可能是 ABN，在美國可能是 RN。
識別碼	id		string	此工作所屬業務單位的識別碼字串。
名稱	name		string	該業務單位的名稱。此名稱通常會顯示給系統的使用者。
識別碼	id		string	人員要在系統中尋找的識別碼字串。
名稱	name		string	要搜尋的 intelliHR 中人員的名稱。請注意，搜尋會自動考慮名稱順序的差異。
primaryEmailAddress的	primaryEmailAddress		string	標示為系統內人員的主要電子郵件地址。
員工編號	employeeNumber		string	手動輸入的員工編號，用於識別 intelliHR 中的人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
autoIncrementIntellihrId	autoIncrementIntellihrId		string	自動產生的號碼，可在 intelliHR 中唯一識別人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
識別碼	id		string	此工作的主管工作的識別碼字串。
名稱	name		string	主管職位的名稱/職位名稱。
識別碼	id		string	位置的識別碼字串。
名稱	name		string	該位置的名稱。此名稱通常會顯示給系統的使用者。
address	address		string	此位置的位址。
識別碼	id		string	此工作所屬之工作類別的 ID 字串。
名稱	name		string	工作類別的名稱。
識別碼	id		string	此工作所屬之「工作類型」的識別碼字串。
名稱	name		string	工作類型的名稱。枚舉： `Permanent`， `Fixed Contract`， `Unpaid`， `Temporary/Casual`，， `Independent Contract`.
FTE	fte		string	相當於這份工作的全職工作。表示員工的工作量，可以在不同環境中進行比較。對於沒有 FTE 的人來說，這是無效的。
識別碼	id		string	薪資等級的識別碼字串。
字碼	code		string	與薪資等級相關的行政短代碼。
名稱	name		string	給薪資等級的使用者友善名稱。
型別	type		string	此報酬表的支付方式。枚舉： `Annual Salary`， `Hourly Rate`， `No Remuneration Schedule`.
支付週期	payCycle	True	string	工作支付的週期。枚舉： `Weekly`， `Fortnightly`， `Monthly`.
貨幣	currency		string	支付此工作的基本金額和總金額的貨幣。國際貨幣代碼。通常澳元代表澳元，美元代表美元等。請參閱官方代碼列表。
識別碼	id		string	本薪酬表的僱傭條件的識別碼字串。
名稱	name		string	本僱傭條件的名稱。
獎項名稱	awardName		string	獎勵名稱可以與呈現給使用者的名稱不同。通常用於獎項的法定名稱。
每週期的小時數	hoursPerCycle	True	double	每個工資週期的工作小時數。
base年薪	baseAnnualSalary		double	每年支付的基本工資，僅當薪酬表類型為“年薪”時才需要。
baseHourlyRate （基本每小時費率）	baseHourlyRate		double	按小時支付的基本費率，僅當薪酬表類型為「小時費率」時才需要。
名稱	name	True	string	此新增的名稱。
型別	type	True	string	如何計算此加法並將其套用至基本金額，MultipleOfBase 會乘以 baseAnnualSalary，然後新增至總計，而 FixedAmount 會直接新增至總計。枚舉： `MultipleOfBase`， `FixedAmount`.
value	value	True	string	對於 MultipleOfBase，這是乘數（例如 9 = 9%），而對於固定金額，這是直接添加到總數中的金額。
貨幣	currency		string	用於此新增的貨幣。國際貨幣代碼。通常澳元代表澳元，美元代表美元等。請參閱官方代碼列表。
識別碼	id		string	預設報酬元件的識別碼字串。
名稱	name		string	預設酬金組成部分的名稱。
名稱	name	True	string	此新增的名稱。
型別	type	True	string	如何計算此加法並將其套用至基本金額，MultipleOfBase 會乘以 baseAnnualSalary，然後新增至總計，而 FixedAmount 會直接新增至總計。枚舉： `MultipleOfBase`， `FixedAmount`.
value	value	True	string	對於 MultipleOfBase，這是乘數（例如 9 = 9%），而對於固定金額，這是直接添加到總數中的金額。
貨幣	currency		string	用於此新增的貨幣。國際貨幣代碼。通常澳元代表澳元，美元代表美元等。請參閱官方代碼列表。
名稱	name	True	string	這個故障的名稱。
型別	type	True	string	如何計算此明細並套用至基本金額，MultipleOfBase 會乘以 baseAnnualSalary，然後新增至總計，而 FixedAmount 會直接新增至總計。枚舉： `MultipleOfBase`， `FixedAmount`.
value	value	True	string	對於 MultipleOfBase，這是乘數（例如 9 = 9%），而對於固定金額，這是直接添加到總數中的金額。
貨幣	currency		string	用於此細分的貨幣。國際貨幣代碼。通常澳元代表澳元，美元代表美元等。請參閱官方代碼列表。
識別碼	id		string	預設報酬元件的識別碼字串。
名稱	name		string	預設酬金組成部分的名稱。
識別碼	id		string	招募來源的識別碼字串。
名稱	name		string	此招募來源的名稱。
成本	cost		double	招聘成本。
貨幣	currency		string	用於招募此職位的貨幣。國際貨幣代碼。通常澳元代表澳元，美元代表美元等。請參閱官方代碼列表。

傳回

單一工作: SingleJob

建立新的人員記錄

作業識別碼：: CreateaPerson

建立人員

參數

名稱	機碼	必要	類型	Description
名字	firstName		string	人員的名字。
中間名	middleName		string	此人的中間名。
lastName	lastName	True	string	此人的姓氏。
preferredName	preferredName		string	此人的偏好名稱。一般可以由員工自行配置。
dateOfBirth	dateOfBirth		string	出生日期（YYYY-MM-DD）。
性	gender		string	人為性別的人類可讀字串，例如 `Male`. 搜索不區分大小寫，並且“開頭為”，例如，傳遞 `male` 將與名為“男性”的性別匹配，“m”或“M”也是如此。如果多個性別相符，則會選擇第一個。
員工編號	employeeNumber		string	手動輸入的員工編號，用於識別 intelliHR 中的人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
title	title		string	稱呼此人的頭銜，例如“先生”。如果未提供，則為 null，且不區分大小寫。
名稱	name		string	緊急聯絡人的名稱。
關聯	relationship		string	此緊急聯絡人與此人的關係。
phone	phone		string	緊急聯絡人的電話號碼。
電子郵件	email		string	緊急聯絡人的電子郵件。
電子郵件	email		string	實際電子郵件地址。
是個人的	isPersonal		boolean	表示此電子郵件是個人電子郵件還是工作電子郵件。
數字	number		string	實際電話號碼。此號碼可以以區號為前綴。發生這種情況時，系統會自動嘗試確定電話號碼的來源國家/地區
是個人的	isPersonal		boolean	表示此電話是個人電話號碼還是工作電話號碼。
自訂欄位	customFields		object	此人員的自訂欄位值
識別碼	id		string	此人員所屬之工作權利的識別碼字串。
名稱	name		string	工作權的名稱。
workRight到期日期	workRightExpiryDate		string	此人的工作權利到期日期（YYYY-MM-DD）。

傳回

單人: SinglePerson

建立新的業務單位

作業識別碼：: CreateanewBusinessUnit

傳回已建立的業務單位。

參數

名稱	機碼	必要	類型	Description
識別碼	identifier		string	可用於管理工作的選用識別碼。
名稱	name	True	string	該業務單位的名稱。此名稱通常會顯示給系統的使用者。
附註	notes		string	附加到業務單位的附註
parentId	parentId		string	父業務單位的識別碼字串，如果沒有父業務單位，則為 null （這是最上層業務單位）。
isEnabled	isEnabled		boolean	指定使用者是否可以在下拉式清單中選取此業務單位。

傳回

回應: Response

建立訓練記錄

作業識別碼：: CreateaTraining

建立新的訓練記錄

參數

名稱	機碼	必要	類型	Description
識別碼	id		string	人員要在系統中尋找的識別碼字串。
名稱	name		string	要搜尋的 intelliHR 中人員的名稱。請注意，搜尋會自動考慮名稱順序的差異。
primaryEmailAddress的	primaryEmailAddress		string	標示為系統內人員的主要電子郵件地址。
員工編號	employeeNumber		string	手動輸入的員工編號，用於識別 intelliHR 中的人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
autoIncrementIntellihrId	autoIncrementIntellihrId		string	自動產生的號碼，可在 intelliHR 中唯一識別人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
完成日期	completionDate	True	string	訓練完成的時間戳記。此日期將遵循 RFC3339定義的格式。 YYYY- 也支援MM-DD 日期格式，不過使用此格式，日期會儲存為UTC時間的一天開始，而不是要求租用戶時區。
成本	cost		string	本次培訓的費用。
貨幣	currency		string	用於此訓練的貨幣。未提供時，將預設為租用戶預設貨幣。國際貨幣代碼。通常澳元代表澳元，美元代表美元等。請參閱官方代碼列表。
小時	hours		string	本次培訓花費了多少小時
識別碼	id		string	完成此訓練之任務的識別碼字串。
名稱	name	True	string	為此訓練提供使用者友善的名稱，以在系統中識別它。
識別碼	id		string	人員要在系統中尋找的識別碼字串。
名稱	name		string	要搜尋的 intelliHR 中人員的名稱。請注意，搜尋會自動考慮名稱順序的差異。
primaryEmailAddress的	primaryEmailAddress		string	標示為系統內人員的主要電子郵件地址。
員工編號	employeeNumber		string	手動輸入的員工編號，用於識別 intelliHR 中的人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
autoIncrementIntellihrId	autoIncrementIntellihrId		string	自動產生的號碼，可在 intelliHR 中唯一識別人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
識別碼	id		string	訓練之訓練提供者的識別碼字串。
名稱	name		string	提供給培訓培訓提供者的用戶友好名稱。
識別碼	id		string	訓練的訓練類型識別碼字串。
名稱	name		string	指定給訓練的訓練類型的使用者易記名稱。
自訂欄位	customFields			此訓練的自訂欄位值

傳回

單體訓練: SingleTraining

建立預先簽署的上傳網址

作業識別碼：: PersonDocuments_POST

建立預先簽署的上傳網址

參數

名稱	機碼	必要	類型	Description
識別碼	id		string	人員要在系統中尋找的識別碼字串。
名稱	name		string	要搜尋的 intelliHR 中人員的名稱。請注意，搜尋會自動考慮名稱順序的差異。
primaryEmailAddress的	primaryEmailAddress		string	標示為系統內人員的主要電子郵件地址。
員工編號	employeeNumber		string	手動輸入的員工編號，用於識別 intelliHR 中的人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
autoIncrementIntellihrId	autoIncrementIntellihrId		string	自動產生的號碼，可在 intelliHR 中唯一識別人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
filename	filename	True	string	文件的原始檔案名稱。這將用於顯示名稱。包括擴展。
默劇	mime	True	string	文件的 MIME 類型
size	size	True	integer	文件的預估大小（以位元組為單位）
副檔名	extension	True	string	文件的副檔名，不包括點

傳回

單人文件: SinglePersonDocument

按 ID 查找培訓提供者

作業識別碼：: FindaTrainingProviderbyID

傳回單一訓練提供者。

參數

名稱	機碼	必要	類型	Description
訓練提供者的識別碼	id	True	string	資源識別碼字串

傳回

單一訓練提供者: SingleTrainingProvider

按 ID 查找工作類型

作業識別碼：: FindaWorkTypebyID

傳回單一工作類型。

參數

名稱	機碼	必要	類型	Description
工作類型的識別碼	id	True	string	資源識別碼字串

傳回

單一工作類型: SingleWorkType

按 ID 查找工資等級

作業識別碼：: FindaPayGradebyID

傳回單一薪資等級。

參數

名稱	機碼	必要	類型	Description
薪資等級的識別碼	id	True	string	資源識別碼字串

傳回

單一薪級: SinglePayGrade

按 ID 查找訓練類型

作業識別碼：: FindaTrainingTypebyID

傳回單一訓練類型。

參數

名稱	機碼	必要	類型	Description
訓練類型識別碼	id	True	string	資源識別碼字串

傳回

SingleTraining類型: SingleTrainingTypes

更新AWebhook

作業識別碼：: UpdateAWebhook

修補 Webhook

參數

名稱	機碼	必要	類型	Description
Webhook 的識別碼	id	True	string	資源識別碼字串
url	url		string	觸發訂閱的 Webhook 事件時，將要求傳送至的 Webhook 端點。
webhook事件	webhookEvent		string	Webhook 事件的蛞蝓。
isEnabled	isEnabled		boolean	指定使用者是否可以選取此 Webhook。停用後，將不會傳送此 Webhook 。
來源	source		string	可自訂的字串，可用來識別建立此 Webhook 的系統。透過 intelliHR 應用程式建立的 Webhook 將具有來源：「自訂」。

傳回

單一Webhook: SingleWebhook

設定作業的結束日期

作業識別碼：: EndJob

設定作業的結束日期

參數

名稱	機碼	必要	類型	Description
要結束的工作識別碼	id	True	string	要結束的工作識別碼
結束日期	endDate	True	string	結束日期
營業額類型	turnoverType	True	string	營業額類型
營業額原因	turnoverReason		string	營業額原因

傳回

單一工作: SingleJob

透過 ID 尋找商業實體

作業識別碼：: FindaBusinessEntitybyID

依其識別碼傳回單一商業實體。

參數

名稱	機碼	必要	類型	Description
資源識別碼字串	id	True	string	資源識別碼字串

傳回

單一企業實體: SingleBusinessEntity

透過身分證件尋找就業條件

作業識別碼：: FindanEmploymentConditionbyID

傳回單一僱傭條件。

參數

名稱	機碼	必要	類型	Description
僱傭條件 ID	id	True	string	資源識別碼字串

傳回

單身就業條件: SingleEmploymentCondition

通過 ID 查找人員

作業識別碼：: FindaPersonbyID

依 UUIDv4 識別碼取得單一人員記錄。

參數

名稱	機碼	必要	類型	Description
人員記錄的 ID	id	True	string	人員記錄的 ID

傳回

單人: SinglePerson

通過 ID 查找位置

作業識別碼：: FindaLocationbyID

傳回單一位置。

參數

名稱	機碼	必要	類型	Description
位置的 ID	id	True	string	資源識別碼字串

傳回

單一位置: SingleLocation

通過 ID 查找作品

作業識別碼：: FindaWorkRightbyID

傳回單一工作權利。

參數

名稱	機碼	必要	類型	Description
工作權利的 ID	id	True	string	資源識別碼字串

傳回

單一工作權利: SingleWorkRight

通過 ID 查找工作

作業識別碼：: FindaJobbyID

依 UUIDv4 識別碼取得單一工作記錄。

參數

名稱

機碼

必要

類型

Description

要傳回的工作識別碼

True

string

資源識別碼字串

傳回此日期工作的正確資料

asAt

string

用來設定要傳回此工作資料的日期，做為 RFC3339 日期時間。

從工作端點傳回的所有資料都代表特定時間點的人員工作屬性值。

依預設，會使用目前的日期時間，但此參數可用來設定不同的日期時間，以檢視歷程資料。

傳回

單一工作: SingleJob

通過 ID 查找招聘來源

作業識別碼：: FindaRecruitmentSourcebyID

傳回單一招募來源。

參數

名稱	機碼	必要	類型	Description
招募來源的ID	id	True	string	資源識別碼字串

傳回

單人招募來源: SingleRecruitmentSource

觸發程序

建立 Webhook 並訂閱租使用者中的事件類型

作業識別碼：: CreateWebhook

建立 Webhook 並訂閱租使用者中的事件類型

參數

名稱	機碼	必要	類型	Description
webhook事件	webhookEvent	True	string	webhook事件
isEnabled	isEnabled		boolean	isEnabled
來源	source		string	來源

傳回

名稱	路徑	類型	Description
識別碼	id	string	識別碼
事件	event	string	事件
時間戳記	timestamp	string	時間戳記
自我	links.self	string	自我

定義

單一企業實體

名稱	路徑	類型	Description
商業實體	data	BusinessEntity

企業實體清單

名稱	路徑	類型	Description
資料	data	array of BusinessEntity
Meta	meta	Meta	包含有關回應的雜項元資訊。
Links	links	Links	其他相關資源的連結。

回應

名稱	路徑	類型	Description
業務單位3	data	BusinessUnit3
元1	meta	Meta1	包含有關回應的雜項元資訊。

業務單位清單

名稱	路徑	類型	Description
資料	data	array of BusinessUnit3
元2	meta	Meta2	包含有關回應的雜項元資訊。
Links	links	Links	其他相關資源的連結。

SingleCustomField定義

名稱	路徑	類型	Description
自訂欄位定義	data	CustomFieldDefinition

ListofCustomField定義

名稱	路徑	類型	Description
資料	data	array of CustomFieldDefinition
Meta	meta	Meta	包含有關回應的雜項元資訊。
Links	links	Links	其他相關資源的連結。

SingleDefaultRemuneration元件

名稱	路徑	類型	Description
DefaultRemuneration元件	data	DefaultRemunerationComponent

預設報酬元件清單

名稱	路徑	類型	Description
資料	data	array of DefaultRemunerationComponent
Meta	meta	Meta	包含有關回應的雜項元資訊。
Links	links	Links	其他相關資源的連結。

單身就業條件

名稱	路徑	類型	Description
就業條件	data	EmploymentCondition

就業條件清單

名稱	路徑	類型	Description
資料	data	array of EmploymentCondition
Meta	meta	Meta	包含有關回應的雜項元資訊。
Links	links	Links	其他相關資源的連結。

單一工作

名稱	路徑	類型	Description
元1	meta	Meta1	包含有關回應的雜項元資訊。
Job	data	Job

清單工作

名稱	路徑	類型	Description
資料	data	array of Job
元8	meta	Meta8	包含有關回應的雜項元資訊。
Links	links	Links	其他相關資源的連結。

單一位置

名稱	路徑	類型	Description
地點5	data	location5

清單位置

名稱	路徑	類型	Description
資料	data	array of location5
Meta	meta	Meta	包含有關回應的雜項元資訊。
Links	links	Links	其他相關資源的連結。

單一薪級

名稱	路徑	類型	Description
薪酬等級5	data	payGrade5

薪資等級列表

名稱	路徑	類型	Description
資料	data	array of payGrade5
Meta	meta	Meta	包含有關回應的雜項元資訊。
Links	links	Links	其他相關資源的連結。

列表人物

名稱	路徑	類型	Description
資料	data	array of data1
Meta	meta	Meta	包含有關回應的雜項元資訊。
Links	links	Links	其他相關資源的連結。

單人

名稱	路徑	類型	Description
資料1	data	data1

單人文件

名稱	路徑	類型	Description
資料3	data	Data3

PatchaPerson文件

名稱	路徑	類型	Description
數據4	data	Data4

單人招募來源

名稱	路徑	類型	Description
招聘來源	data	recruitmentSource

招募來源列表

名稱	路徑	類型	Description
資料	data	array of recruitmentSource	招募來源詳情。
Meta	meta	Meta	包含有關回應的雜項元資訊。
Links	links	Links	其他相關資源的連結。

單一訓練提供者

名稱	路徑	類型	Description
培訓提供者	data	trainingProviders

Listall培訓提供者

名稱	路徑	類型	Description
資料	data	array of trainingProviders
Meta	meta	Meta	包含有關回應的雜項元資訊。
Links	links	Links	其他相關資源的連結。

單體訓練

名稱	路徑	類型	Description
Training	data	Training

培訓清單

名稱	路徑	類型	Description
資料	data	array of Training
Meta	meta	Meta	包含有關回應的雜項元資訊。
Links	links	Links	其他相關資源的連結。

SingleTraining類型

名稱	路徑	類型	Description
訓練類型	data	trainingTypes

ListallTrainingTypes

名稱	路徑	類型	Description
資料	data	array of trainingTypes
Meta	meta	Meta	包含有關回應的雜項元資訊。
Links	links	Links	其他相關資源的連結。

SingleWorkClass

名稱	路徑	類型	Description
工作類別結構描述	data	WorkClassesSchema

ListWorkClasses

名稱	路徑	類型	Description
資料	data	array of WorkClassesSchema
Meta	meta	Meta	包含有關回應的雜項元資訊。
Links	links	Links	其他相關資源的連結。

單一工作權利

名稱	路徑	類型	Description
工作權2	data	WorkRight2

工作權利清單

名稱	路徑	類型	Description
資料	data	array of WorkRight2
Meta	meta	Meta	包含有關回應的雜項元資訊。
Links	links	Links	其他相關資源的連結。

單一工作類型

名稱	路徑	類型	Description
工作類型4	data	workType4

ListWork類型

名稱	路徑	類型	Description
資料	data	array of workType4
Meta	meta	Meta	包含有關回應的雜項元資訊。
Links	links	Links	其他相關資源的連結。

Webhook 事件

單一 Webhook 事件。

名稱	路徑	類型	Description
數據5	data	Data5

單一Webhook

名稱	路徑	類型	Description
數據7	data	Data7

加法

名稱	路徑	類型	Description
名稱	name	string	此新增的名稱。
型別	type	string	如何計算此加法並將其應用於基本金額，multipleOfBase 乘以 baseAnnualSalary，然後添加到總額中，而固定金額將直接添加到總額中。枚舉： `MultipleOfBase`， `FixedAmount`.
value	value	double	對於 multipleOfBase，這是乘數（例如 9 = 9%），而對於固定金額，這是直接添加到總數中的金額。
貨幣	currency	string	用於此新增的貨幣。國際貨幣代碼。通常澳元代表澳元，美元代表美元等。請參閱官方代碼列表。

加算到總計

名稱	路徑	類型	Description
名稱	name	string	此總加法的名稱。
型別	type	string	如何計算此總加法並將其應用於基本金額，multipleOfBase 乘以 baseAnnualSalary，然後添加到總計中，而固定金額將直接添加到總額中。枚舉： `MultipleOfBase`， `FixedAmount`.
value	value	double	對於 multipleOfBase，這是乘數（例如 9 = 9%），而對於固定金額，這是直接添加到總數中的金額。
貨幣	currency	string	用於此新增的貨幣。國際貨幣代碼。通常澳元代表澳元，美元代表美元等。請參閱官方代碼列表。

Address

名稱	路徑	類型	Description
addressType	addressType	string	地址類型。
完整地址	fullAddress	string	完整地址。
country	country	string	地址所在的國家/地區。
郵遞區號	postcode	string	地址的郵遞區號。
狀態	state	string	位址的狀態。
街道	street	string	地址所在的街道。
郊區	suburb	string	地址的郊區。

故障

名稱	路徑	類型	Description
名稱	name	string	此新增的名稱。
型別	type	string	與其他薪酬組成部分不同，這種添加是如何記錄的，它不用於計算應付總薪酬。枚舉： `MultipleOfBase`， `FixedAmount`.
value	value	double	對於 multipleOfBase，這是乘數（例如 9 = 9%），而對於固定金額，這是直接添加到總數中的金額。
貨幣	currency	string	用於此新增的貨幣。國際貨幣代碼。通常澳元代表澳元，美元代表美元等。請參閱官方代碼列表。

商業實體

名稱	路徑	類型	Description
識別碼	id	string	商業實體的識別碼字串。
名稱	name	string	該商業實體的名稱。此名稱通常會顯示給系統的使用者。
法律名稱	legalName	string	法定名稱可以與呈現給使用者的名稱不同。通常用於管理任務。
數字	number	string	合法註冊的商業實體編號，例如在澳大利亞，這可能是 ABN，在美國可能是 RN。
isEnabled	isEnabled	boolean	指定使用者是否可以在下拉式清單中選取此商業實體。

業務單位3

名稱	路徑	類型	Description
識別碼	id	string	業務單位的識別碼字串。
識別碼	identifier	string	可用於管理工作的選用識別碼。
名稱	name	string	該業務單位的名稱。此名稱通常會顯示給系統的使用者。
附註	notes	string	附加到業務單位的附註
parentId	parentId	string	父業務單位的識別碼字串，如果沒有父業務單位，則為 null （這是最上層業務單位）。
isEnabled	isEnabled	boolean	指定使用者是否可以在下拉式清單中選取此業務單位。

商業實體2

工作在系統中的現行商業實體。

名稱	路徑	類型	Description
識別碼	id	string	此工作之「商業實體」的識別碼字串。
名稱	name	string	該商業實體的名稱。此名稱通常會顯示給系統的使用者。
連結	link	string	在公共 API 上鏈接以獲取有關此數據的更多資訊。

業務單位4

工作在系統中的目前業務單位。

名稱	路徑	類型	Description
識別碼	id	string	此工作業務單位的識別碼字串。
名稱	name	string	該業務單位的名稱。此名稱通常會顯示給系統的使用者。
連結	link	string	在公共 API 上鏈接以獲取有關此數據的更多資訊。

協調員

進行培訓的協調員。此資料是選擇性的，未儲存時為空值。

名稱	路徑	類型	Description
識別碼	id	string	訓練協調員的識別碼字串。
顯示名稱	displayName	string	協調培訓的人員的姓名。
員工編號	employeeNumber	string	手動輸入的員工編號，用於識別 intelliHR 中的人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
autoIncrementIntellihrId	autoIncrementIntellihrId	double	自動產生的號碼，可在 intelliHR 中唯一識別人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
連結	link	string	在公共 API 上鏈接以獲取有關此數據的更多資訊。

自訂欄位定義

名稱	路徑	類型	Description
識別碼	id	string	自訂欄位定義的識別碼字串。
名稱	name	string	指定給此自訂欄位定義的名稱。此名稱通常會顯示給系統的使用者。
api名稱	apiName	string	指定給此自訂欄位定義的 API 名稱。此名稱用於唯一識別 API 中的自訂欄位，並在修改記錄上的自訂欄位時用作索引鍵。
說明	description	string	此自訂欄位定義的說明。這會用作建立和更新頁面上的工具提示。
modelType	modelType	string	此自訂欄位相關且可附加的模型。枚舉： `TRAINING`， `PERSON`.
型別	type	string	此欄位記錄的資料類型。枚舉： `SINGLE_SELECT`， `MULTI_SELECT`， `TEXT`， `NUMBER`，， `PEOPLE_DROPDOWN`.
definitions	definitions	object	此索引鍵的值會根據「類型」索引鍵而變更。它用於儲存與該金鑰相關的其他資訊。如需自訂欄位設定的詳細資訊，請參閱我們關於自訂欄位的知識庫文章

資料1

名稱	路徑	類型	Description
識別碼	id	string	人員的識別碼字串。
顯示名稱	displayName	string	要在整個系統中顯示此人員的名稱。通常遵循模式preferredName （firstName） lastName，但可以在全租用戶的基礎上設定為不同的格式。
名字	firstName	string	人員的名字。
中間名	middleName	string	此人的中間名。
lastName	lastName	string	此人的姓氏。
preferredName	preferredName	string	此人的偏好名稱。一般可以由員工自行配置。
dateOfBirth	dateOfBirth	string	出生日期（YYYY-MM-DD）。
性	gender	string	人為性別的人類可讀字串，例如男性。
員工編號	employeeNumber	string	手動輸入的員工編號，用於識別 intelliHR 中的人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
autoIncrementIntellihrId	autoIncrementIntellihrId	double	自動產生的號碼，可在 intelliHR 中唯一識別人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
title	title	string	稱呼此人的頭銜，例如“先生”。如果未提供，則為空值。
電子郵件位址	emailAddresses	array of EmailAddress	屬於此人員的電子郵件地址陣列。
緊急聯絡方式	emergencyContact	EmergencyContact	此人員緊急聯絡人的詳細資料。
就業狀態	employmentStatus	string	該人員在組織內的當前狀態。枚舉： `Current Staff`， `Exiting Staff`，， `No Job RecordsPast Staff`， `Returning Staff`，， . `Upcoming Staff`
jobs	jobs	array of Job4	與此人員相關聯的簡單工作項目陣列，按開始日期的時間倒序排列。
工作權利	workRights	WorkRights	顯示該人的工作權利
主要電子郵件地址1	primaryEmailAddress	PrimaryEmailAddress1	有關此人的主要電子郵件地址的信息，如果他們沒有電子郵件信息，則為空。
主要電話號碼 1	primaryPhoneNumber	PrimaryPhoneNumber1	有關此人的主要電話號碼的信息，如果他們沒有電話號碼，則為空。
addresses	addresses	array of Address	屬於此人員的位址陣列。
電話號碼	phoneNumbers	array of PhoneNumber	屬於此人員的電話號碼陣列。
創建於	createdAt	string	建立此記錄的時間。此日期將遵循 RFC3339定義的格式。
updatedAt	updatedAt	string	此記錄上次更新的時間。此日期將遵循 RFC3339定義的格式。

資料3

名稱	路徑	類型	Description
識別碼	id	string	「人員文件」的識別碼字串。
personId	personId	string	此文件所屬人員的識別碼字串。
presignedUploadUrl	presignedUploadUrl	string	預先簽署的上傳 URL，可讓您將人員文件上傳至 S3。此連結將在建立後 20 分鐘過期。如需如何上傳具有預先簽署 S3 URL 的物件的指示，請參閱此處

數據4

名稱	路徑	類型	Description
識別碼	id	string	「人員文件」的識別碼字串。
personId	personId	string	此文件所屬人員的識別碼字串。
上傳狀態	uploadStatus	string	此文件的上傳狀態。枚舉： `SUCCESS`， `PENDING`， `FAILED`.

數據5

名稱	路徑	類型	Description
識別碼	id	string	Webhook 事件的識別碼字串。
名稱	name	string	此 Webhook 事件的人類可讀唯一事件索引鍵。
事件	event	string	Webhook 事件的蛞蝓。
範例承載	examplePayload	object	將傳送至訂閱此特定 Webhook 事件的 Webhook 的承載範例。

數據7

名稱	路徑	類型	Description
識別碼	id	string	Webhook 的識別碼字串。
url	url	string	觸發訂閱的 Webhook 事件時，將要求傳送至的 Webhook 端點。
WebhookEvent	webhookEvent	WebhookEvent	觸發此 Webhook 的 Webhook 事件。
isEnabled	isEnabled	boolean	指定使用者是否可以選取此 Webhook。停用後，將不會傳送此 Webhook 。
來源	source	string	可自訂的字串，可用來識別建立此 Webhook 的系統。透過 intelliHR 應用程式建立的 Webhook 將具有來源：「自訂」。
創建於	createdAt	string	建立此記錄的時間。此日期將遵循 RFC3339定義的格式。
updatedAt	updatedAt	string	此記錄上次更新的時間。此日期將遵循 RFC3339定義的格式。

扣除

名稱	路徑	類型	Description
名稱	name	string	此扣除額的名稱。
型別	type	string	如何計算此扣除額並將其應用於基本金額，multipleOfBase 乘以 baseAnnualSalary，然後從總額中扣除，而固定金額則直接從總額中扣除。枚舉： `MultipleOfBase`， `FixedAmount`.
value	value	double	對於 multipleOfBase，這是乘數，而對於固定金額，這是直接從總額中扣除的金額。
貨幣	currency	string	用於此扣除額的貨幣。國際貨幣代碼。通常澳元代表澳元，美元代表美元等。請參閱官方代碼列表。

DefaultRemuneration元件

名稱	路徑	類型	Description
識別碼	id	string	預設報酬元件的識別碼字串。
名稱	name	string	賦予此預設報酬組成部分的名稱。此名稱通常會顯示給系統的使用者。
value	value	string	該薪酬組成部分的價值。對於 multipleOfBase，這是乘數，而對於固定金額，這是直接添加到總數中的金額。
是使用中	isInUse	boolean	是否將此預設薪酬組成部分用作任何報酬組成部分。
自動新增到工作	automaticallyAddToJobs	boolean	此預設報酬元件是否會自動新增至新建立/更新的工作。
isEnabled	isEnabled	boolean	如果啟用此預設薪酬組件以在系統中使用。
貨幣	currency	string	用於此預設薪酬組成部分的貨幣。國際貨幣代碼。通常澳元代表澳元，美元代表美元等。請參閱官方代碼列表。
型別	type	string	此預設報酬組成部分的類型。枚舉： `AdditionToBase`， `AdditionToTotal`， `DeductionToBase`， `Breakdown`.
valueType	valueType	string	此預設報酬元件的值類型。枚舉： `MultipleOfBase`， `FixedAmount`.

電子郵件地址

名稱	路徑	類型	Description
電子郵件	email	string	實際電子郵件地址。
isPrimary	isPrimary	boolean	如果這是主要電子郵件地址。
是個人的	isPersonal	boolean	如果這是個人電子郵件地址。

緊急聯絡方式

此人員緊急聯絡人的詳細資料。

名稱	路徑	類型	Description
名稱	name	string	緊急聯絡人的名稱。
關聯	relationship	string	此緊急聯絡人與此人的關係。
phone	phone	string	緊急聯絡人的電話號碼。
電子郵件	email	string	緊急聯絡人的電子郵件。

就業條件

名稱	路徑	類型	Description
識別碼	id	string	「僱用條件」的識別碼字串。
名稱	name	string	本僱傭條件的名稱。此名稱通常會顯示給系統的使用者。
獎項名稱	awardName	string	獎勵名稱可以與呈現給使用者的名稱不同。通常用於獎項的法定名稱。
isEnabled	isEnabled	boolean	指定使用者是否可以在下拉式清單中選取此「僱用條件」。

就業條件2

該工作的就業條件。

名稱	路徑	類型	Description
識別碼	id	string	本薪酬表的僱傭條件的識別碼字串。
名稱	name	string	本僱傭條件的名稱。此名稱通常會顯示給系統的使用者。
獎項名稱	awardName	string	獎勵名稱可以與呈現給使用者的名稱不同。通常用於獎項的法定名稱。
連結	link	string	在公共 API 上鏈接以獲取有關此數據的更多資訊。

Job

名稱	路徑	類型	Description
識別碼	id	string	工作的識別碼字串。
Person	person	Person	本工作所屬之人。
招聘	recruitment	Recruitment	為該職位儲存的招募詳細資料。
地點	location	Location	此工作的地理位置。
薪酬等級	payGrade	PayGrade	工作在系統中的當前薪資等級。
業務單位4	businessUnit	BusinessUnit4	工作在系統中的目前業務單位。
商業實體2	businessEntity	BusinessEntity2	工作在系統中的現行商業實體。
主管職位	supervisorJob	SupervisorJob	此工作主管的工作資訊，如果沒有主管，則為空值。
主管人員	supervisorPerson	SupervisorPerson	此工作主管的人員資訊，如果沒有主管，則為空值。
薪酬表	remunerationSchedule	RemunerationSchedule	該職位的當前薪酬詳細信息，包括工資和時薪等信息，所有職位都有薪酬表，但對於無薪員工，他們將有一個特殊的 `No Remuneration Schedule` 時間表。
名稱	name	string	此職位的名稱/職位名稱。
FTE	fte	number	相當於這份工作的全職工作。表示員工的工作量，可以在不同環境中進行比較。對於沒有 FTE 的人來說，這是無效的。
workClass	workClass	string	這項工作的工作類別。這是有關工作類型的額外詳細資訊。
工作類型	workType	string	這是該工作的工作分類，用於區分全職和兼職員工與無薪志願者。枚舉： `Permanent`， `Fixed Contract`， `Unpaid`， `Temporary/Casual`，， `Independent Contract`.
工作狀態	jobStatus	string	該工作在本組織內的當前狀態。枚舉： `Past Job`， `Future Job`， `Ending Job`， `Current Job`.
公司開始日期	companyStartDate	string	此工作在組織內開始或將開始的日期。此日期將遵循 RFC3339定義的格式。
公司結束日期	companyEndDate	string	此工作在組織內結束或將結束的日期，如果沒有結束日期，則為空。此日期將遵循 RFC3339定義的格式。
isEndDate已確認	isEndDateConfirmed	boolean	結束日期是否已在 intelliHR 應用程式中最終確定。
營業額類型	turnoverType	string	本工作結束的人員流動類型被分類為。
營業額原因	turnoverReason	string	周轉原因的名稱。
創建於	createdAt	string	建立此記錄的時間。此日期將遵循 RFC3339定義的格式。

工作4

名稱	路徑	類型	Description
識別碼	id	string	工作的識別碼字串。
名稱	name	string	此職位的名稱/職位名稱。
startDate	startDate	string	此工作在組織內開始或將開始的日期。此日期將遵循 RFC3339定義的格式。
結束日期	endDate	string	此工作在組織內結束或將結束的日期，如果沒有結束日期，則為空。此日期將遵循 RFC3339定義的格式。
工作狀態	jobStatus	string	該職位在本組織內的當前狀態。枚舉： `Past Job`， `Future Job`， `Ending Job`， `Current Job`.
連結	link	string	在公共 API 上鏈接以獲取有關此數據的更多資訊。

約伯7

進行培訓的人的工作。

名稱	路徑	類型	Description
識別碼	id	string	訓練任務的識別碼字串。
名稱	name	string	進行培訓的人員工作名稱。
startDate	startDate	string	工作生效開始日期。此日期將遵循 RFC3339定義的格式。
結束日期	endDate	string	工作生效結束日期。此日期將遵循 RFC3339定義的格式。
工作狀態	jobStatus	string	狀態結構描述。枚舉： `Past Job`， `Future Job`， `Ending Job`， `Current Job`.
連結	link	string	在公共 API 上鏈接以獲取有關此數據的更多資訊。

Links

其他相關資源的連結。

名稱	路徑	類型	Description
自我	self	string	目前頁面 URL
先	first	string	首頁網址
上一頁	prev	string	上一頁網址
next	next	string	下一頁網址
last	last	string	最後一頁 URL

地點

此工作的地理位置。

名稱	路徑	類型	Description
識別碼	id	string	此工作位置的識別碼字串。
名稱	name	string	該位置的名稱。此名稱通常會顯示給系統的使用者。
address	address	string	此位置的位址。
連結	link	string	在公共 API 上鏈接以獲取有關此數據的更多資訊。

地點5

名稱	路徑	類型	Description
識別碼	id	string	位置的識別碼字串。
parentId	parentId	string	父 Location 的識別碼字串，如果沒有父項，則為 null （這是最上層位置）。
名稱	name	string	該位置的名稱。此名稱通常會顯示給系統的使用者。
address	address	string	此位置的位址。
isEnabled	isEnabled	boolean	指定使用者是否可以在下拉式清單中選取此位置。

元1

包含有關回應的雜項元資訊。

名稱	路徑	類型	Description
在	asAt	string	此回應所針對的時間點。此日期將遵循 RFC3339定義的格式。

元2

包含有關回應的雜項元資訊。

名稱	路徑	類型	Description
在	asAt	string	此回應所針對的時間點。此日期將遵循 RFC3339定義的格式。
分頁	pagination	Pagination	包含與回應分頁相關的資訊

元8

包含有關回應的雜項元資訊。

名稱	路徑	類型	Description
在	asAt	string	此回應中的資料準確的時間點。此日期將遵循 RFC3339定義的格式。
分頁	pagination	Pagination	包含與回應分頁相關的資訊

分頁

包含與回應分頁相關的資訊

名稱	路徑	類型	Description
總計	total	integer	項目總計數
count	count	integer	目前頁面的項目數
per_page	per_page	integer	每頁項目數限制
current_page	current_page	integer	當前頁面
total_pages	total_pages	integer	總頁數

薪酬等級

工作在系統中的當前薪資等級。

名稱	路徑	類型	Description
識別碼	id	string	此工作薪資等級的識別碼字串。
名稱	name	string	給薪資等級的使用者友善名稱。
字碼	code	string	與薪資等級相關的行政短代碼。
連結	link	string	在公共 API 上鏈接以獲取有關此數據的更多資訊。

薪酬等級5

名稱	路徑	類型	Description
識別碼	id	string	薪資等級的識別碼字串。
字碼	code	string	與薪資等級相關的行政短代碼。
名稱	name	string	給薪資等級的使用者友善名稱。
isEnabled	isEnabled	boolean	指定使用者是否可以在下拉式清單中選取此薪資等級。

Person

本工作所屬之人。

名稱	路徑	類型	Description
識別碼	id	string	此工作所屬人員的識別碼字串。
顯示名稱	displayName	string	要在整個系統中顯示此人員的名稱。通常遵循模式preferredName （firstName） lastName，但可以在全租用戶的基礎上設定為不同的格式。
員工編號	employeeNumber	string	手動輸入的員工編號，用於識別 intelliHR 中的人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
autoIncrementIntellihrId	autoIncrementIntellihrId	double	自動產生的號碼，可在 intelliHR 中唯一識別人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
連結	link	string	在公共 API 上鏈接以獲取有關此數據的更多資訊。

人員7

進行培訓的人。

名稱	路徑	類型	Description
識別碼	id	string	訓練人員的識別碼字串。
顯示名稱	displayName	string	進行訓練的人員的姓名。
員工編號	employeeNumber	string	手動輸入的員工編號，用於識別 intelliHR 中的人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
autoIncrementIntellihrId	autoIncrementIntellihrId	double	自動產生的號碼，可在 intelliHR 中唯一識別人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
連結	link	string	在公共 API 上鏈接以獲取有關此數據的更多資訊。

電話號碼

名稱	路徑	類型	Description
數字	number	string	實際電話號碼。
fullNumber	fullNumber	string	帶有區號的實際電話號碼（如果已註冊）。
isPrimary	isPrimary	boolean	如果這是主要電話號碼。
是個人的	isPersonal	boolean	如果這是個人電話號碼。

主要電子郵件地址1

有關此人的主要電子郵件地址的信息，如果他們沒有電子郵件信息，則為空。

名稱	路徑	類型	Description
電子郵件	email	string	實際電子郵件地址。
是個人的	isPersonal	boolean	表示此電子郵件是個人電子郵件還是工作電子郵件。

主要電話號碼 1

有關此人的主要電話號碼的信息，如果他們沒有電話號碼，則為空。

名稱	路徑	類型	Description
數字	number	string	實際電話號碼。
fullNumber	fullNumber	string	帶有區號的實際電話號碼（如果已註冊）。
是個人的	isPersonal	boolean	表示此電話號碼是個人號碼還是工作號碼。

Provider

訓練的訓練提供者。

名稱	路徑	類型	Description
識別碼	id	string	訓練之訓練提供者的識別碼字串。
名稱	name	string	提供給培訓培訓提供者的用戶友好名稱。
連結	link	string	在公共 API 上鏈接以獲取有關此數據的更多資訊。

招聘

為該職位儲存的招募詳細資料。

名稱	路徑	類型	Description
成本	cost	number	招募此職位的成本。如果為空，則未記錄成本。
貨幣	currency	string	用於招募此職位的貨幣。國際貨幣代碼。通常澳元代表澳元，美元代表美元等。請參閱官方代碼列表。
來源	source	Source	招聘來源：該職位的來源，如果未記錄，則為空。

招聘來源

名稱	路徑	類型	Description
識別碼	id	string	招募來源的識別碼字串。
名稱	name	string	此招募來源的名稱。
parentId	parentId	string	父項招募來源的識別碼字串，如果沒有父項，則為 null （這是最上層招募來源）。
isEnabled	isEnabled	boolean	指定使用者是否可以在下拉式清單中選取此招募來源。

薪酬表

該職位的當前薪酬詳細信息，包括工資和時薪等信息，所有職位都有薪酬表，但對於無薪員工，他們將有一個特殊的 No Remuneration Schedule 時間表。

名稱	路徑	類型	Description
型別	type	string	支付此薪酬表的方法，如果一個人沒有支付，那麼這將是 `No Remuneration Schedule`。枚舉： `Annual Salary`， `Hourly Rate`， `No Remuneration Schedule`.
base年薪	baseAnnualSalary	double	基本工資按年支付，如果按小時支付，這是近似值。請注意，如果在建立或修補要求中同時提供 baseAnnualSalary 和 baseHourlyRate，則會忽略 baseHourlyRate。
baseHourlyRate （基本每小時費率）	baseHourlyRate	double	基本費率按小時支付，如果按年支付，這是近似值。請注意，如果在建立或修補要求中同時提供 baseAnnualSalary 和 baseHourlyRate，則會忽略 baseHourlyRate。
貨幣	currency	string	支付此工作的基本金額和總金額的貨幣。國際貨幣代碼。通常澳元代表澳元，美元代表美元等。請參閱官方代碼列表。
每週期的小時數	hoursPerCycle	double	每個工資週期的工作小時數。
支付週期	payCycle	string	工作支付的週期。枚舉： `Weekly`， `Fortnightly`， `Monthly`.
年費套餐	annualPackage	double	每年支付的總套餐，包括附加和扣除。該金額的計算方法是將基本年薪和附加額減去扣除額。
小時套餐	hourlyPackage	double	每小時支付的總套餐，包括附加和扣除。該金額的計算方法是將年度套餐除以每年的總小時數。
currencyConversion發生	currencyConversionOccurred	boolean	如果在計算年度套餐時必須在加法和扣除貨幣之間進行任何轉換。
就業條件2	employmentCondition	EmploymentCondition2	該工作的就業條件。
新增內容	additions	array of Addition	本薪酬表的一系列新增內容。
扣除額	deductions	array of Deduction	此薪酬表的一系列扣除額。
additionsToTotal	additionsToTotal	array of AdditionsToTotal	在此薪酬表的所有其他組成部分之後應用於套餐的一系列附加內容。
故障	breakdowns	array of Breakdown	此薪酬表的一系列明細。細分不會用於計算總套餐。

來源

招聘來源：該職位的來源，如果未記錄，則為空。

名稱	路徑	類型	Description
識別碼	id	string	此職位的招聘來源的識別碼字串。
名稱	name	string	此招募來源的名稱。
連結	link	string	在公共 API 上鏈接以獲取有關此數據的更多資訊。

主管職位

此工作主管的工作資訊，如果沒有主管，則為空值。

名稱	路徑	類型	Description
識別碼	id	string	此工作的主管工作的識別碼字串。
工作狀態	jobStatus	string	該工作在本組織內的當前狀態。枚舉： `Past Job`， `Future Job`， `Ending Job`， `Current Job`.
名稱	name	string	主管職位的名稱/職位名稱。
連結	link	string	在公共 API 上鏈接以獲取有關此數據的更多資訊。

主管人員

此工作主管的人員資訊，如果沒有主管，則為空值。

名稱	路徑	類型	Description
識別碼	id	string	此工作的主管人員的識別碼字串。
顯示名稱	displayName	string	要在整個系統中顯示此人員的名稱。通常遵循模式preferredName （firstName） lastName，但可以在全租用戶的基礎上設定為不同的格式。
員工編號	employeeNumber	string	手動輸入的員工編號，用於識別 intelliHR 中的人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
autoIncrementIntellihrId	autoIncrementIntellihrId	double	自動產生的號碼，可在 intelliHR 中唯一識別人員。它可能會隱藏在系統的 UI 中，視租用戶的設定而定。
連結	link	string	在公共 API 上鏈接以獲取有關此數據的更多資訊。

Training

名稱	路徑	類型	Description
識別碼	id	string	訓練的識別碼字串。
名稱	name	string	為本培訓提供用戶友好的名稱。
人員7	person	Person7	進行培訓的人。
約伯7	job	Job7	進行培訓的人的工作。
協調員	coordinator	Coordinator	進行培訓的協調員。此資料是選擇性的，未儲存時為空值。
小時	hours	string	這次培訓花了多少小時。
貨幣	currency	string	用於此 [Training]（#tag/Trainings 的貨幣。國際貨幣代碼。通常澳元代表澳元，美元代表美元等。請參閱官方代碼列表。
成本	cost	string	本次培訓的費用。
Provider	provider	Provider	訓練的訓練提供者。
類型	type	Type	訓練的訓練類型。
完成日期	completionDate	string	訓練完成的時間戳記。此日期將遵循 RFC3339定義的格式。
創建於	createdAt	string	建立此記錄的時間。此日期將遵循 RFC3339定義的格式。
updatedAt	updatedAt	string	此記錄上次更新的時間。此日期將遵循 RFC3339定義的格式。

培訓提供者

名稱	路徑	類型	Description
識別碼	id	string	訓練提供者的識別碼字串。
名稱	name	string	提供給訓練提供者的使用者易記名稱。
isDefault	isDefault	boolean	指出建立訓練記錄時是否將此訓練提供者用作預設值。

訓練類型

名稱	路徑	類型	Description
識別碼	id	string	訓練類型的識別碼字串。
名稱	name	string	提供給訓練類型的使用者易記名稱。
isDefault	isDefault	boolean	指出建立訓練記錄時是否將此訓練類型用作預設值。

類型

訓練的訓練類型。

名稱	路徑	類型	Description
識別碼	id	string	訓練的訓練類型識別碼字串。
名稱	name	string	指定給訓練的訓練類型的使用者易記名稱。
連結	link	string	在公共 API 上鏈接以獲取有關此數據的更多資訊。

WebhookEvent

觸發此 Webhook 的 Webhook 事件。

名稱	路徑	類型	Description
識別碼	id	string	Webhook 事件的識別碼字串。
名稱	name	string	此 Webhook 事件的人類可讀唯一事件索引鍵。
事件	event	string	Webhook 事件的蛞蝓。
連結	link	string	在公共 API 上鏈接以獲取有關此數據的更多資訊。

工作類別結構描述

名稱	路徑	類型	Description
識別碼	id	string	工作類別的 ID 字串。
名稱	name	string	該工作類別的名稱。此名稱通常會顯示給系統的使用者。
工作類型2	workType	WorkType2	此工作類別的父項工作類型。
isEnabled	isEnabled	boolean	指定使用者是否可以在下拉式清單中選取此工作類型。

工作權2

名稱	路徑	類型	Description
識別碼	id	string	工作權限的識別碼字串。
名稱	name	string	賦予該工作權的名稱。此名稱通常會顯示給系統的使用者。
國家標識碼	countryId	string	國家/地區的識別碼字串。
country	country	string	指派的國家/地區的名稱值。

工作權利

顯示該人的工作權利

名稱	路徑	類型	Description
名稱	name	string	工作權利的類型
country	country	string	工作權有效的國家
到期日期	expirationDate	string	工作權到期日期

工作類型2

此工作類別的父項工作類型。

名稱	路徑	類型	Description
識別碼	id	string	此工作類別之「工作類型」的 ID 字串。
名稱	name	string	工作類型的名稱。枚舉： `Permanent`， `Fixed Contract`， `Unpaid`， `Temporary/Casual`，， `Independent Contract`.
連結	link	string	在公共 API 上鏈接以獲取有關此數據的更多資訊。

工作類型4

名稱	路徑	類型	Description
識別碼	id	string	工作類型的識別碼字串。
名稱	name	string	工作類型的名稱。枚舉： `Permanent`， `Fixed Contract`， `Unpaid`， `Temporary/Casual`，， `Independent Contract`.
isEnabled	isEnabled	boolean	指定使用者是否可以在下拉式清單中選取此工作類型。

字串

這是基本資料類型「string」。

共用方式為

intelliHR （預覽版）

先決條件

如何取得認證

開始使用連接器

已知問題與限制

常見錯誤和補救措施

正在建立連線

預設

節流限制

動作

依 ID 尋找 Webhook

參數

傳回

依 ID 尋找工作類別

參數

傳回

依 ID 尋找業務單位

參數

傳回

依 ID 尋找預設報酬元件

參數

傳回

依 ID 更新文件

參數

傳回

依ID尋找Webhook事件

參數

傳回

依識別碼刪除 Webhook

參數

傳回

依識別碼刪除業務單位

參數

傳回

依識別碼刪除訓練記錄

參數

傳回

依識別碼尋找自訂欄位定義

參數

傳回

依識別碼尋找訓練記錄

參數

傳回

依識別碼更新業務單位

參數

傳回

依識別碼更新訓練記錄

參數

傳回

依身分證件更新人員

參數

傳回

修補現有任務

參數

傳回

列出所有人員

參數

傳回

列出所有位置

參數

傳回

列出所有僱傭條件

參數

傳回

列出所有商業實體

參數

傳回

列出所有培訓提供者

參數

傳回

列出所有工作

參數

傳回

列出所有工作權利

參數

傳回

列出所有工作類別

參數

傳回