intelliHR (предварительная версия)

IntelliHR — это облачная платформа управления людьми с расширенными возможностями аналитики. Подключитесь к клиенту IntelliHR для автоматизации рабочих процессов, ориентированных на людей (например, подключение) и экспорта данных.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)

Контакт
Имя	Поддержка клиентов
URL	https://intellihr.zendesk.com/hc/en-us
Адрес электронной почты	support@intellihr.co

Метаданные соединителя
Publisher	IntelliHR
Веб-сайт	https://www.intellihr.com
Политика конфиденциальности	https://intellihr.co/privacy-policy/
Категории	Кадровые ресурсы; Бизнес-аналитика

IntelliHR — это простая платформа управления людьми и аналитики для централизованного управления производительностью, участия сотрудников, основных процессов управления персоналом и аналитики кадров в одном месте. Создавайте запланированные задачи и автоматизированные рабочие процессы с данными пользователей в Power Automate, Office 365, SharePoint, Microsoft Dynamics 365 и других службах без кода с помощью соединителя IntelliHR.

Предпосылки

Чтобы использовать этот соединитель, у вас должен быть клиент 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 xyz123". Сбой этого приведет к ошибкам "Недопустимый ключ API".

Известные проблемы и ограничения

Соединитель IntelliHR — это перевод общедоступного API IntelliHR, и таким образом он наследует те же ограничения и требует той же проверки по запросам.

Распространенные ошибки и средства устранения неполадок

Так как соединитель IntelliHR передает запросы к общедоступному API IntelliHR, большинство проблем могут возникнуть, ссылаясь на документацию по общедоступному API.

Ошибка с диапазоном 400 возвращается, если какая-то часть запроса неуместна и будет сопровождаться сообщением, описывающим проблему. Наиболее распространенная проблема заключается в том, что соединитель был настроен без ввода носителя в вводе ключа API.

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:


По умолчанию	Параметры для создания подключения.	Все регионы	Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя	Тип	Description	Обязательно
Ключ API	securestring	Ключ API для этого API, подготовленный с помощью носителя	True
Tenant	струна	Имя клиента IntelliHR	True

Ограничения регулирования

Имя	Вызовы	Период обновления
Вызовы API для каждого подключения	100	60 секунд

Действия

UpdateAWebhook	Исправление веб-перехватчика
Вывод списка всех бизнес-единиц	Возвращает список всех бизнес-единиц, записанных в системе.
Вывод списка всех заданий	Возвращает список всех записей сущностей задания по состоянию на текущую дату.
Вывод списка всех рабочих классов	Возвращает список всех рабочих классов, записанных в системе.
Вывод списка всех расположений	Возвращает список всех расположений.
Вывод списка всех типов обучения	Возвращает список всех типов обучения.
Задание даты окончания задания	Задание даты окончания задания
Исправление существующего задания	Исправление атрибутов существующей записи задания с предоставленными данными.
Обновление документа по идентификатору	Обновление документа
Обновление записи обучения по идентификатору	Обновление записи обучения
Обновление подразделения по идентификатору	Возвращает обновленный бизнес-единицу.
Обновление пользователя по идентификатору	Обновление пользователя
Перечисление всех бизнес-сущностей	Возвращает список всех бизнес-сущностей.
Перечисление всех источников набора	Возвращает список всех источников набора.
Перечисление всех компонентов вознаграждения по умолчанию	Возвращает список всех компонентов вознаграждения по умолчанию, записанных в системе.
Перечисление всех людей	Возвращает список всех пользователей по текущей дате.
Перечисление всех определений настраиваемых полей	Возвращает список всех определений настраиваемых полей.
Перечисление всех оценок оплаты	Возвращает список всех оценок оплаты.
Перечислить все учебные курсы	Возвращает список всех записей обучения.
Поиск бизнес-единицы по идентификатору	Возвращает один бизнес-единицу.
Поиск бизнес-сущности по идентификатору	Возвращает одну бизнес-сущность по идентификатору.
Поиск веб-перехватчика по идентификатору	Возвращает один веб-перехватчик.
Поиск задания по идентификатору	Получение одной записи задания по идентификатору UUIDv4.
Поиск записи обучения по идентификатору	Возвращает одну запись обучения.
Поиск источника набора по идентификатору	Возвращает один источник набора.
Поиск компонента вознаграждения по умолчанию по идентификатору	Возвращает один компонент вознаграждения по умолчанию.
Поиск определения настраиваемого поля по идентификатору	Возвращает одно пользовательское определение поля.
Поиск оценки оплаты по идентификатору	Возвращает один уровень оплаты.
Поиск поставщика обучения по идентификатору	Возвращает один поставщик обучения.
Поиск работы по идентификатору	Возвращает одно рабочее право.
Поиск рабочего класса по идентификатору	Возвращает один рабочий класс.
Поиск рабочего типа по идентификатору	Возвращает один рабочий тип.
Поиск расположения по идентификатору	Возвращает одно расположение.
Поиск события веб-перехватчика по идентификатору	Возвращает одно событие веб-перехватчика.
Поиск типа обучения по идентификатору	Возвращает один тип обучения.
Поиск условия занятости по идентификатору	Возвращает одно условие занятости.
Поиск человека по идентификатору	Получение одной записи Person по идентификатору UUIDv4.
Создание задания	Создайте запись задания с предоставленными данными.
Создание записи обучения	Создание новой записи обучения
Создание записи пользователя	Создание пользователя
Создание нового бизнес-подразделения	Возвращает созданный бизнес-единицу.
Создание предварительно назначенного URL-адреса отправки	Создание предварительно назначенного URL-адреса отправки
Список всех поставщиков обучения	Возвращает список всех поставщиков обучения.
Список всех рабочих прав	Возвращает список всех прав на работу, записанных в системе.
Список всех рабочих типов	Возвращает список всех рабочих типов, записанных в системе.
Список всех условий занятости	Возвращает список всех условий занятости.
Удаление бизнес-единицы по идентификатору	Удалите подразделение по указанному идентификатору.
Удаление веб-перехватчика по идентификатору	Удаляет предоставленный веб-перехватчик.
Удаление записи обучения по идентификатору	Удаляет предоставленную запись обучения.

UpdateAWebhook

Идентификатор операции:: UpdateAWebhook

Исправление веб-перехватчика

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор веб-перехватчика	id	True	string	Строка идентификатора ресурса
URL-адрес	url		string	Конечная точка веб-перехватчика , к которой будет отправлен запрос при активации события веб-перехватчика подписки.
webhookEvent	webhookEvent		string	Слизь события веб-перехватчика.
isEnabled	isEnabled		boolean	Указывает, могут ли пользователи выбрать этот веб-перехватчик. При отключении этот веб-перехватчик не будет отправлен.
source	source		string	Настраиваемая строка, которую можно использовать для определения системы, созданной этим веб-перехватчиком. Веб-перехватчики , созданные с помощью приложения IntelliHR, будут иметь источник: custom.

Возвращаемое значение

SingleWebhook: SingleWebhook

Вывод списка всех бизнес-единиц

Идентификатор операции:: ListallBusinessUnits

Возвращает список всех бизнес-единиц, записанных в системе.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Количество элементов на страницу	limit		integer	Количество элементов на страницу
Номер страницы	page		integer	Номер страницы

Возвращаемое значение

ListofBusinessUnits: ListofBusinessUnits

Вывод списка всех заданий

Идентификатор операции:: ListallJobs

Возвращает список всех записей сущностей задания по состоянию на текущую дату.

Параметры

Имя	Ключ	Тип	Описание
Количество элементов на страницу	limit	integer	Количество элементов на страницу
Номер страницы	page	integer	Номер страницы
Фильтры для применения к запросу	filters	string	Фильтры можно применить в строке запроса, чтобы ограничить данные, возвращаемые из этой конечной точки. Фильтры предоставляются в формате `filters[<filter_name>][<operation_type>]=<filter_value>`. Например, фильтр для получения элементов, соответствующих определенному идентификатору, будет `filters[id][eq]=8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9`.
Порядок сортировки для применения к запросу	sort	string	Сортировку можно применить в строке запроса, чтобы упорядочить данные, возвращаемые из этой конечной точки. Сортировка может быть предустановлена минусом для возврата данных в порядке убывания (-). Например, для получения последних записей сначала будет `-createdAt`сортировка.

Возвращаемое значение

Перечисление заданий: ListJobs

Вывод списка всех рабочих классов

Идентификатор операции:: Listallworkclasses

Возвращает список всех рабочих классов, записанных в системе.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Количество элементов на страницу	limit		integer	Количество элементов на страницу
Номер страницы	page		integer	Номер страницы

Возвращаемое значение

ListWorkClasses: ListWorkClasses

Вывод списка всех расположений

Идентификатор операции:: Listalllocations

Возвращает список всех расположений.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Количество элементов на страницу	limit		integer	Количество элементов на страницу
Номер страницы	page		integer	Номер страницы

Возвращаемое значение

Перечисления: Listlocations

Вывод списка всех типов обучения

Идентификатор операции:: ListallTrainingTypes

Возвращает список всех типов обучения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Количество элементов на страницу	limit		integer	Количество элементов на страницу
Номер страницы	page		integer	Номер страницы

Возвращаемое значение

ListallTrainingTypes: ListallTrainingTypes

Задание даты окончания задания

Идентификатор операции:: EndJob

Задание даты окончания задания

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор конечного задания	id	True	string	Идентификатор конечного задания
Дата окончания	endDate	True	string	Дата окончания
turnoverType	turnoverType	True	string	turnoverType
оборотReason	turnoverReason		string	оборотReason

Возвращаемое значение

SingleJob: SingleJob

Исправление существующего задания

Идентификатор операции:: PatchanexistingJob

Исправление атрибутов существующей записи задания с предоставленными данными.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор задания	id	True	string	Строка идентификатора ресурса
effectiveFrom	effectiveFrom	True	string	Дата, когда обновление заданий действует в рамках организации. Обратите внимание, что это не влияет на дату начала общего задания. `null` Значение указывает, что это обновление действует с начала задания. Эта дата будет соответствовать формату, определенному RFC3339. Формат YYY-MM-DD даты также поддерживается, хотя с помощью этого формата дата будет храниться в качестве начала дня в формате UTC, а не часовой пояс запрашивающих клиентов.
effectiveTo	effectiveTo		string	Дата действия этого обновления заданий действует в рамках организации. Обратите внимание, что это не влияет на дату окончания всего задания. Эта дата будет соответствовать формату, определенному RFC3339. Формат YYY-MM-DD даты также поддерживается, хотя с помощью этого формата дата будет храниться в качестве начала дня в формате UTC, а не часовой пояс запрашивающих клиентов.
имя	name		string	Имя задания для обновления
id	id		string	Строка идентификатора для бизнес-сущности , которой принадлежит это задание .
имя	name		string	Имя, заданное для этой бизнес-сущности. Обычно это имя будет отображаться пользователям системы.
legalName	legalName		string	Юридическое имя бизнес-сущности. Обычно используется для административных задач.
число/номер	number		string	Юридически зарегистрированный номер бизнес-сущности , например в Австралии, это может быть ABN или в Америке RN.
id	id		string	Строка идентификатора для подразделения , которому принадлежит это задание .
имя	name		string	Имя, заданное для этого подразделения. Обычно это имя будет отображаться пользователям системы.
id	id		string	Строка идентификатора для пользователя , который будет находиться в системе.
имя	name		string	Имя пользователя в intelliHR для поиска. Обратите внимание, что учетные записи поиска для различий в порядке имен автоматически.
первичныйадрес электронной почты	primaryEmailAddress		string	Адрес электронной почты, помеченный как основной для пользователя в системе.
номер сотрудника	employeeNumber		string	Введенный вручную номер сотрудника, определяющий человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
autoIncrementIntellihrId	autoIncrementIntellihrId		string	Автогенерированное число, которое однозначно идентифицирует человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
id	id		string	Строка идентификатора для задания руководителя этого задания.
имя	name		string	Название или должность задания руководителя.
id	id		string	Строка идентификатора расположения.
имя	name		string	Имя, заданное этому расположению. Обычно это имя будет отображаться пользователям системы.
address	address		string	Адрес этого расположения.
id	id		string	Строка идентификатора для рабочего класса , которому принадлежит это задание .
имя	name		string	Имя рабочего класса.
id	id		string	Строка идентификатора для рабочего типа , которому принадлежит это задание .
имя	name		string	Имя рабочего типа. Перечисление: `Permanent`, , `Fixed ContractUnpaid`, `Independent ContractTemporary/Casual`.
fte	fte		string	Полный рабочий день, эквивалентный этому заданию. Указывая рабочую нагрузку сотрудника, которая может быть сравнима с различными контекстами. Это значение null для людей без FTE.
id	id		string	Строка идентификатора для оценки оплаты.
код	code		string	Административный, короткий код, связанный с оценкой оплаты.
имя	name		string	Понятное имя, заданное для оценки оплаты.
type	type		string	Метод, в котором оплачивается этот график вознаграждения. Перечисление: `Annual Salary`, `Hourly Rate`, `No Remuneration Schedule`.
payCycle	payCycle	True	string	Цикл оплаты задания. Перечисление: `Weekly`, `Fortnightly`, `Monthly`.
currency	currency		string	Валюта, в которой оплачивается базовая и общая сумма, в которой выполняется эта работа. Международный код валюты. Как правило, AUD для австралийского доллара, USD для американского доллара и т. д. См. официальный список кодов.
id	id		string	Строка идентификатора условия занятости этого расписания вознаграждения.
имя	name		string	Имя, заданное этому условию занятости.
awardName	awardName		string	Имя награды может отличаться от имени, представленного пользователю. Обычно используется для юридического имени награды.
hoursPerCycle	hoursPerCycle	True	double	Сколько часов работало за payCycle.
baseAnnualSalary	baseAnnualSalary		double	Базовая зарплата, выплачиваемая ежегодно, это требуется только в том случае, если тип расписания вознаграждения — "Годовая зарплата".
baseHourlyRate	baseHourlyRate		double	Базовая ставка оплачивается почасово, это необходимо только в том случае, если тип расписания вознаграждения — "Почасовая ставка".
имя	name	True	string	Имя этого дополнения.
type	type	True	string	Как это вычисляется и применяется к базовой сумме, MultipleOfBase умножается на baseAnnualSalary, а затем добавляется к общей сумме, пока FixedAmount добавляется непосредственно к общей сумме. Перечисление: `MultipleOfBase`, `FixedAmount`.
value	value	True	string	Для MultipleOfBase это умножение (например, 9 = 9%) в то время как для фиксированной суммы это сумма, добавляемая непосредственно в общую сумму.
currency	currency		string	Валюта, используемая для этого дополнения. Международный код валюты. Как правило, AUD для австралийского доллара, USD для американского доллара и т. д. См. официальный список кодов.
id	id		string	Строка идентификатора компонента вознаграждения по умолчанию.
имя	name		string	Имя компонента вознаграждения по умолчанию.
имя	name	True	string	Имя этого дополнения.
type	type	True	string	Как это вычисляется и применяется к базовой сумме, MultipleOfBase умножается на baseAnnualSalary, а затем добавляется к общей сумме, пока FixedAmount добавляется непосредственно к общей сумме. Перечисление: `MultipleOfBase`, `FixedAmount`.
value	value	True	string	Для MultipleOfBase это умножение (например, 9 = 9%) в то время как для фиксированной суммы это сумма, добавляемая непосредственно в общую сумму.
currency	currency		string	Валюта, используемая для этого дополнения. Международный код валюты. Как правило, AUD для австралийского доллара, USD для американского доллара и т. д. См. официальный список кодов.
имя	name	True	string	Имя этого разбивки.
type	type	True	string	Как эта разбивка вычисляется и применяется к базовой сумме, MultipleOfBase умножается на baseAnnualSalary, а затем добавляется к общей сумме, пока FixedAmount добавляется непосредственно к общей сумме. Перечисление: `MultipleOfBase`, `FixedAmount`.
value	value	True	string	Для MultipleOfBase это умножение (например, 9 = 9%) в то время как для фиксированной суммы это сумма, добавляемая непосредственно в общую сумму.
currency	currency		string	Валюта, используемая для этого разбивки. Международный код валюты. Как правило, AUD для австралийского доллара, USD для американского доллара и т. д. См. официальный список кодов.
id	id		string	Строка идентификатора компонента вознаграждения по умолчанию.
имя	name		string	Имя компонента вознаграждения по умолчанию.

Возвращаемое значение

SingleJob: SingleJob

Обновление документа по идентификатору

Идентификатор операции:: PersonDocumentsById_PATCH

Обновление документа

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id	True	string	Строка идентификатора ресурса
personId	personId	True	string	Строка идентификатора пользователя , которому принадлежит этот документ .
uploadStatus	uploadStatus	True	string	Состояние отправки этого документа. Перечисление: `SUCCESS`, `PENDING`, `FAILED`.

Возвращаемое значение

PatchaPersonDocument: PatchaPersonDocument

Обновление записи обучения по идентификатору

Идентификатор операции:: UpdateTrainingByID

Обновление записи обучения

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор учебной записи	id	True	string	Строка идентификатора ресурса
id	id		string	Строка идентификатора для пользователя , который будет находиться в системе.
имя	name		string	Имя пользователя в intelliHR для поиска. Обратите внимание, что учетные записи поиска для различий в порядке имен автоматически.
первичныйадрес электронной почты	primaryEmailAddress		string	Адрес электронной почты, помеченный как основной для пользователя в системе.
номер сотрудника	employeeNumber		string	Введенный вручную номер сотрудника, определяющий человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
autoIncrementIntellihrId	autoIncrementIntellihrId		string	Автогенерированное число, которое однозначно идентифицирует человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
завершениеДата	completionDate		string	Метка времени обучения завершена. Эта дата будет соответствовать формату, определенному RFC3339. Формат YYY-MM-DD даты также поддерживается, хотя с помощью этого формата дата будет храниться в качестве начала дня в формате UTC, а не часовой пояс запрашивающих клиентов.
стоимость	cost		string	Стоимость этого обучения.
currency	currency		string	Валюта, используемая для этого обучения. По умолчанию используется валюта клиента по умолчанию, если она не указана. Международный код валюты. Как правило, AUD для австралийского доллара, USD для американского доллара и т. д. См. официальный список кодов.
Часов	hours		string	Сколько часов было потрачено на это обучение
id	id		string	Строка идентификатора задания , для которую было выполнено обучение .
имя	name		string	Понятное имя, заданное этому обучению для идентификации в системе.
id	id		string	Строка идентификатора для пользователя , который будет находиться в системе.
имя	name		string	Имя пользователя в intelliHR для поиска. Обратите внимание, что учетные записи поиска для различий в порядке имен автоматически.
первичныйадрес электронной почты	primaryEmailAddress		string	Адрес электронной почты, помеченный как основной для пользователя в системе.
номер сотрудника	employeeNumber		string	Введенный вручную номер сотрудника, определяющий человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
autoIncrementIntellihrId	autoIncrementIntellihrId		string	Автогенерированное число, которое однозначно идентифицирует человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
id	id		string	Строка идентификатора поставщика обучения для обучения .
имя	name		string	Понятное имя, заданное поставщику обучения для обучения.
id	id		string	Строка идентификатора для типа обучения обучения.
имя	name		string	Понятное имя, заданное типу обучения для обучения.
customFields	customFields			Значения настраиваемого поля для этого обучения

Возвращаемое значение

SingleTraining: SingleTraining

Обновление подразделения по идентификатору

Идентификатор операции:: UpdateaBusinessUnitbyID

Возвращает обновленный бизнес-единицу.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор бизнес-подразделения	id	True	string	Строка идентификатора ресурса
идентификатор	identifier		string	Необязательный идентификатор, который можно использовать для административных задач.
имя	name	True	string	Имя, заданное для этого подразделения. Обычно это имя будет отображаться пользователям системы.
заметки	notes		string	Заметки, присоединенные к бизнес-единице
parentId	parentId		string	Строка идентификатора родительской бизнес-единицы или null, если родительский элемент отсутствует (это бизнес-единица верхнего уровня).
isEnabled	isEnabled		boolean	Указывает, могут ли пользователи выбрать эту бизнес-единицу в раскрывающихся списках.

Возвращаемое значение

Ответ: Response

Обновление пользователя по идентификатору

Идентификатор операции:: UpdatePersonByID

Обновление пользователя

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор записи пользователя	id	True	string	Строка идентификатора ресурса
Имя	firstName		string	Имя пользователя .
второе имя	middleName		string	По промежуточному имени человека .
lastName	lastName		string	Фамилия человека .
preferredName;	preferredName		string	Предпочтительное имя пользователя . Как правило, можно настроить сотрудниками самостоятельно.
dateOfBirth	dateOfBirth		string	Дата рождения (гггг-MM-DD).
gender	gender		string	Удобочитаемая строка для пола человека , например `Male`. Поиск выполняется без учета регистра и "начинается с", например, передача `male` будет соответствовать полу под названием "Мужчина", как "m" или "M". Если первое соответствует нескольким полам , будет выбрано первое.
номер сотрудника	employeeNumber		string	Введенный вручную номер сотрудника, определяющий человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
title	title		string	Заголовок, ссылающийся на этого человека , например "Mr". Это значение null, если оно не указано и не учитывает регистр.
имя	name		string	Имя экстренного контакта.
Отношение	relationship		string	Связь с этим экстренным контактом с человеком.
phone	phone		string	Номер телефона экстренного контакта.
электронная почта	email		string	Электронная почта экстренного контакта.
электронная почта	email		string	Адрес электронной почты, связанный с этим человеком.
isPersonal	isPersonal		boolean	Указывает, является ли этот адрес личным или рабочим.
isPrimary	isPrimary		boolean	Указывает, является ли этот адрес основным контактным адресом.
число/номер	number		string	Номер телефона. Это число можно префиксировать с помощью кода области. В этом случае система будет автоматически пытаться определить страну происхождения для номера телефона.
isPersonal	isPersonal		boolean	Указывает, является ли этот телефон личным или рабочим номером телефона.
isPrimary	isPrimary		boolean	Указывает, является ли этот телефон основным контактным номером.
addressType	addressType		string	Перечисление: `Home`, `Postal`. Тип адреса.
fullAddress	fullAddress		string	Полный доступный для чтения адрес, минус почтовый индекс и страна
country	country		string	Страна, где находится адрес.
почтовый индекс	postcode		string	Почтовый индекс адреса.
государство	state		string	Состояние, в которое находится адрес. Это зависит от австралии и не всегда может быть предоставлено.
улица	street		string	Улица, на который находится адрес. Это зависит от австралии и не всегда может быть предоставлено.
пригород	suburb		string	Пригород, в который находится адрес. Это зависит от австралии и не всегда может быть предоставлено.
customFields	customFields		object	Значения настраиваемого поля для этого пользователя
id	id		string	Строка идентификатора права на работу , к которой принадлежит этот человек .
имя	name		string	Имя права на работу.
workRightExpiryDate	workRightExpiryDate		string	Срок действия этого права на работу истекает для этого человека (гггг-MM-DD).

Возвращаемое значение

SinglePerson: SinglePerson

Перечисление всех бизнес-сущностей

Идентификатор операции:: ListallBusinessEntities

Возвращает список всех бизнес-сущностей.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Количество элементов на страницу	limit		integer	Количество элементов на страницу
Номер страницы	page		integer	Номер страницы

Возвращаемое значение

ListofBusinessEntities: ListofBusinessEntities

Перечисление всех источников набора

Идентификатор операции:: Listallrecruitmentsources

Возвращает список всех источников набора.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Количество элементов на страницу	limit		integer	Количество элементов на страницу
Номер страницы	page		integer	Номер страницы

Возвращаемое значение

ListofRecruitmentSources: ListofRecruitmentSources

Перечисление всех компонентов вознаграждения по умолчанию

Идентификатор операции:: ListallDefaultRemunerationComponents

Возвращает список всех компонентов вознаграждения по умолчанию, записанных в системе.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Количество элементов на страницу	limit		integer	Количество элементов на страницу
Номер страницы	page		integer	Номер страницы

Возвращаемое значение

ListofDefaultRemunerationComponents: ListofDefaultRemunerationComponents

Перечисление всех людей

Идентификатор операции:: Listallpeople

Возвращает список всех пользователей по текущей дате.

Параметры

Имя	Ключ	Тип	Описание
Количество элементов на страницу	limit	integer	Количество элементов на страницу
Номер страницы	page	integer	Номер страницы
Фильтры для применения к запросу	filters	string	Фильтры можно применить в строке запроса, чтобы ограничить данные, возвращаемые из этой конечной точки. Фильтры предоставляются в формате `filters[<filter_name>][<operation_type>]=<filter_value>`. Например, фильтр для получения элементов, соответствующих определенному идентификатору, будет `filters[id][eq]=8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9`.
Порядок сортировки для применения к запросу	sort	string	Сортировку можно применить в строке запроса, чтобы упорядочить данные, возвращаемые из этой конечной точки. Сортировка может быть предустановлена минусом для возврата данных в порядке убывания (-). Например, для получения последних записей сначала будет `-createdAt`сортировка.

Возвращаемое значение

ListPeople: ListPeople

Перечисление всех определений настраиваемых полей

Идентификатор операции:: ListallCustomFieldDefinitions

Возвращает список всех определений настраиваемых полей.

Параметры

Имя	Ключ	Тип	Описание
Количество элементов на страницу	limit	integer	Количество элементов на страницу
Номер страницы	page	integer	Номер страницы
Фильтры для применения к запросу	filters	string	Фильтры можно применить в строке запроса, чтобы ограничить данные, возвращаемые из этой конечной точки. Фильтры предоставляются в формате `filters[<filter_name>][<operation_type>]=<filter_value>`. Например, фильтр для получения элементов, соответствующих определенному идентификатору, будет `filters[id][eq]=8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9`.

Возвращаемое значение

ListofCustomFieldDefinitions: ListofCustomFieldDefinitions

Перечисление всех оценок оплаты

Идентификатор операции:: Listallpaygrades

Возвращает список всех оценок оплаты.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Количество элементов на страницу	limit		integer	Количество элементов на страницу
Номер страницы	page		integer	Номер страницы

Возвращаемое значение

ListofPayGrades: ListofPayGrades

Перечислить все учебные курсы

Идентификатор операции:: ListallTrainings

Возвращает список всех записей обучения.

Параметры

Имя	Ключ	Тип	Описание
Количество элементов на страницу	limit	integer	Количество элементов на страницу
Номер страницы	page	integer	Номер страницы
Фильтры для применения к запросу	filters	string	Фильтры можно применить в строке запроса, чтобы ограничить данные, возвращаемые из этой конечной точки. Фильтры предоставляются в формате `filters[<filter_name>][<operation_type>]=<filter_value>`. Например, фильтр для получения элементов, соответствующих определенному идентификатору, будет `filters[id][eq]=8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9`.
Порядок сортировки для применения к запросу	sort	string	Сортировку можно применить в строке запроса, чтобы упорядочить данные, возвращаемые из этой конечной точки. Сортировка может быть предустановлена минусом для возврата данных в порядке убывания (-). Например, для получения последних записей сначала будет `-createdAt`сортировка.

Возвращаемое значение

ListofTrainings: ListofTrainings

Поиск бизнес-единицы по идентификатору

Идентификатор операции:: FindaBusinessUnitbyID

Возвращает один бизнес-единицу.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор бизнес-подразделения	id	True	string	Строка идентификатора ресурса

Возвращаемое значение

Ответ: Response

Поиск бизнес-сущности по идентификатору

Идентификатор операции:: FindaBusinessEntitybyID

Возвращает одну бизнес-сущность по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Строка идентификатора ресурса	id	True	string	Строка идентификатора ресурса

Возвращаемое значение

SingleBusinessEntity: SingleBusinessEntity

Поиск веб-перехватчика по идентификатору

Идентификатор операции:: FindaWebhookbyID

Возвращает один веб-перехватчик.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор веб-перехватчика	id	True	string	Строка идентификатора ресурса

Возвращаемое значение

SingleWebhook: SingleWebhook

Поиск задания по идентификатору

Идентификатор операции:: FindaJobbyID

Получение одной записи задания по идентификатору UUIDv4.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор возвращаемого задания	id	True	string	Строка идентификатора ресурса
Возвращать точные данные для задания на эту дату	asAt		string	Используется для настройки даты возврата данных задания в качестве RFC3339 даты и времени. Все данные, возвращаемые из конечных точек задания, представляют значения атрибутов задания Person в определенный момент времени. По умолчанию используется текущее время даты и времени, но этот параметр можно использовать для настройки другого времени даты и просмотра исторических данных.

Имя

Ключ

Обязательно

Тип

Описание

Идентификатор возвращаемого задания

True

string

Строка идентификатора ресурса

Возвращать точные данные для задания на эту дату

asAt

string

Используется для настройки даты возврата данных задания в качестве RFC3339 даты и времени.

Все данные, возвращаемые из конечных точек задания, представляют значения атрибутов задания Person в определенный момент времени.

По умолчанию используется текущее время даты и времени, но этот параметр можно использовать для настройки другого времени даты и просмотра исторических данных.

Возвращаемое значение

SingleJob: SingleJob

Поиск записи обучения по идентификатору

Идентификатор операции:: FindaTrainingbyID

Возвращает одну запись обучения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор учебной записи	id	True	string	Строка идентификатора ресурса

Возвращаемое значение

SingleTraining: SingleTraining

Поиск источника набора по идентификатору

Идентификатор операции:: FindaRecruitmentSourcebyID

Возвращает один источник набора.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор источника набора	id	True	string	Строка идентификатора ресурса

Возвращаемое значение

SingleRecruitmentSource: SingleRecruitmentSource

Поиск компонента вознаграждения по умолчанию по идентификатору

Идентификатор операции:: FindaDefaultRemunerationComponentbyID

Возвращает один компонент вознаграждения по умолчанию.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор компонента вознаграждения	id	True	string	Строка идентификатора ресурса

Возвращаемое значение

SingleDefaultRemunerationComponent: SingleDefaultRemunerationComponent

Поиск определения настраиваемого поля по идентификатору

Идентификатор операции:: FindaCustomFieldDefinitionbyID

Возвращает одно пользовательское определение поля.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор настраиваемого поля	id	True	string	Строка идентификатора ресурса

Возвращаемое значение

SingleCustomFieldDefinition: SingleCustomFieldDefinition

Поиск оценки оплаты по идентификатору

Идентификатор операции:: FindaPayGradebyID

Возвращает один уровень оплаты.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор класса оплаты	id	True	string	Строка идентификатора ресурса

Возвращаемое значение

SinglePayGrade: SinglePayGrade

Поиск поставщика обучения по идентификатору

Идентификатор операции:: FindaTrainingProviderbyID

Возвращает один поставщик обучения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор поставщика обучения	id	True	string	Строка идентификатора ресурса

Возвращаемое значение

SingleTrainingProvider: SingleTrainingProvider

Поиск работы по идентификатору

Идентификатор операции:: FindaWorkRightbyID

Возвращает одно рабочее право.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор правой работы	id	True	string	Строка идентификатора ресурса

Возвращаемое значение

SingleWorkRight: SingleWorkRight

Поиск рабочего класса по идентификатору

Идентификатор операции:: FindaWorkClassbyID

Возвращает один рабочий класс.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор рабочего класса	id	True	string	Строка идентификатора ресурса

Возвращаемое значение

SingleWorkClass: SingleWorkClass

Поиск рабочего типа по идентификатору

Идентификатор операции:: FindaWorkTypebyID

Возвращает один рабочий тип.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор рабочего типа	id	True	string	Строка идентификатора ресурса

Возвращаемое значение

SingleWorkType: SingleWorkType

Поиск расположения по идентификатору

Идентификатор операции:: FindaLocationbyID

Возвращает одно расположение.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор расположения	id	True	string	Строка идентификатора ресурса

Возвращаемое значение

SingleLocation: SingleLocation

Поиск события веб-перехватчика по идентификатору

Идентификатор операции:: FindaWebhookEventbyID

Возвращает одно событие веб-перехватчика.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор события веб-перехватчика	id	True	string	Строка идентификатора ресурса

Возвращаемое значение

Одно событие веб-перехватчика.

веб-перехватчик-события: webhook-events

Поиск типа обучения по идентификатору

Идентификатор операции:: FindaTrainingTypebyID

Возвращает один тип обучения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор типа обучения	id	True	string	Строка идентификатора ресурса

Возвращаемое значение

SingleTrainingTypes: SingleTrainingTypes

Поиск условия занятости по идентификатору

Идентификатор операции:: FindanEmploymentConditionbyID

Возвращает одно условие занятости.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор условия занятости	id	True	string	Строка идентификатора ресурса

Возвращаемое значение

SingleEmploymentCondition: SingleEmploymentCondition

Поиск человека по идентификатору

Идентификатор операции:: FindaPersonbyID

Получение одной записи Person по идентификатору UUIDv4.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор записи пользователя	id	True	string	Идентификатор записи пользователя

Возвращаемое значение

SinglePerson: SinglePerson

Создание задания

Идентификатор операции:: CreateanewJob

Создайте запись задания с предоставленными данными.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id		string	Строка идентификатора для пользователя , который будет находиться в системе.
имя	name		string	Имя пользователя в intelliHR для поиска. Обратите внимание, что учетные записи поиска для различий в порядке имен автоматически.
первичныйадрес электронной почты	primaryEmailAddress		string	Адрес электронной почты, помеченный как основной для пользователя в системе.
номер сотрудника	employeeNumber		string	Введенный вручную номер сотрудника, определяющий человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
autoIncrementIntellihrId	autoIncrementIntellihrId		string	Автогенерированное число, которое однозначно идентифицирует человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
companyStartDate	companyStartDate	True	string	Дата начала или начала работы в организации. Эта дата будет соответствовать формату, определенному RFC3339. Формат YYY-MM-DD даты также поддерживается, хотя с помощью этого формата дата будет храниться в качестве начала дня в формате UTC, а не часовой пояс запрашивающих клиентов.
companyEndDate	companyEndDate		string	Дата окончания этого задания или окончания в организации. Эта дата будет соответствовать формату, определенному RFC3339. Формат YYY-MM-DD даты также поддерживается, хотя с помощью этого формата дата будет храниться в качестве начала дня в формате UTC, а не часовой пояс запрашивающих клиентов.
имя	name	True	string	Имя создаваемого задания
id	id		string	Строка идентификатора для бизнес-сущности , которой принадлежит это задание .
имя	name		string	Имя, заданное для этой бизнес-сущности. Обычно это имя будет отображаться пользователям системы.
legalName	legalName		string	Юридическое имя бизнес-сущности. Обычно используется для административных задач.
число/номер	number		string	Юридически зарегистрированный номер бизнес-сущности , например в Австралии, это может быть ABN или в Америке RN.
id	id		string	Строка идентификатора для подразделения , которому принадлежит это задание .
имя	name		string	Имя, заданное для этого подразделения. Обычно это имя будет отображаться пользователям системы.
id	id		string	Строка идентификатора для пользователя , который будет находиться в системе.
имя	name		string	Имя пользователя в intelliHR для поиска. Обратите внимание, что учетные записи поиска для различий в порядке имен автоматически.
первичныйадрес электронной почты	primaryEmailAddress		string	Адрес электронной почты, помеченный как основной для пользователя в системе.
номер сотрудника	employeeNumber		string	Введенный вручную номер сотрудника, определяющий человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
autoIncrementIntellihrId	autoIncrementIntellihrId		string	Автогенерированное число, которое однозначно идентифицирует человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
id	id		string	Строка идентификатора для задания руководителя этого задания.
имя	name		string	Название или должность задания руководителя.
id	id		string	Строка идентификатора расположения.
имя	name		string	Имя, заданное этому расположению. Обычно это имя будет отображаться пользователям системы.
address	address		string	Адрес этого расположения.
id	id		string	Строка идентификатора для рабочего класса , которому принадлежит это задание .
имя	name		string	Имя рабочего класса.
id	id		string	Строка идентификатора для рабочего типа , которому принадлежит это задание .
имя	name		string	Имя рабочего типа. Перечисление: `Permanent`, , `Fixed ContractUnpaid`, `Independent ContractTemporary/Casual`.
fte	fte		string	Полный рабочий день, эквивалентный этому заданию. Указывая рабочую нагрузку сотрудника, которая может быть сравнима с различными контекстами. Это значение null для людей без FTE.
id	id		string	Строка идентификатора для оценки оплаты.
код	code		string	Административный, короткий код, связанный с оценкой оплаты.
имя	name		string	Понятное имя, заданное для оценки оплаты.
type	type		string	Метод, в котором оплачивается этот график вознаграждения. Перечисление: `Annual Salary`, `Hourly Rate`, `No Remuneration Schedule`.
payCycle	payCycle	True	string	Цикл оплаты задания. Перечисление: `Weekly`, `Fortnightly`, `Monthly`.
currency	currency		string	Валюта, в которой оплачивается базовая и общая сумма, в которой выполняется эта работа. Международный код валюты. Как правило, AUD для австралийского доллара, USD для американского доллара и т. д. См. официальный список кодов.
id	id		string	Строка идентификатора условия занятости этого расписания вознаграждения.
имя	name		string	Имя, заданное этому условию занятости.
awardName	awardName		string	Имя награды может отличаться от имени, представленного пользователю. Обычно используется для юридического имени награды.
hoursPerCycle	hoursPerCycle	True	double	Сколько часов работало за payCycle.
baseAnnualSalary	baseAnnualSalary		double	Базовая зарплата, выплачиваемая ежегодно, это требуется только в том случае, если тип расписания вознаграждения — "Годовая зарплата".
baseHourlyRate	baseHourlyRate		double	Базовая ставка оплачивается почасово, это необходимо только в том случае, если тип расписания вознаграждения — "Почасовая ставка".
имя	name	True	string	Имя этого дополнения.
type	type	True	string	Как это вычисляется и применяется к базовой сумме, MultipleOfBase умножается на baseAnnualSalary, а затем добавляется к общей сумме, пока FixedAmount добавляется непосредственно к общей сумме. Перечисление: `MultipleOfBase`, `FixedAmount`.
value	value	True	string	Для MultipleOfBase это умножение (например, 9 = 9%) в то время как для фиксированной суммы это сумма, добавляемая непосредственно в общую сумму.
currency	currency		string	Валюта, используемая для этого дополнения. Международный код валюты. Как правило, AUD для австралийского доллара, USD для американского доллара и т. д. См. официальный список кодов.
id	id		string	Строка идентификатора компонента вознаграждения по умолчанию.
имя	name		string	Имя компонента вознаграждения по умолчанию.
имя	name	True	string	Имя этого дополнения.
type	type	True	string	Как это вычисляется и применяется к базовой сумме, MultipleOfBase умножается на baseAnnualSalary, а затем добавляется к общей сумме, пока FixedAmount добавляется непосредственно к общей сумме. Перечисление: `MultipleOfBase`, `FixedAmount`.
value	value	True	string	Для MultipleOfBase это умножение (например, 9 = 9%) в то время как для фиксированной суммы это сумма, добавляемая непосредственно в общую сумму.
currency	currency		string	Валюта, используемая для этого дополнения. Международный код валюты. Как правило, AUD для австралийского доллара, USD для американского доллара и т. д. См. официальный список кодов.
имя	name	True	string	Имя этого разбивки.
type	type	True	string	Как эта разбивка вычисляется и применяется к базовой сумме, MultipleOfBase умножается на baseAnnualSalary, а затем добавляется к общей сумме, пока FixedAmount добавляется непосредственно к общей сумме. Перечисление: `MultipleOfBase`, `FixedAmount`.
value	value	True	string	Для MultipleOfBase это умножение (например, 9 = 9%) в то время как для фиксированной суммы это сумма, добавляемая непосредственно в общую сумму.
currency	currency		string	Валюта, используемая для этого разбивки. Международный код валюты. Как правило, AUD для австралийского доллара, USD для американского доллара и т. д. См. официальный список кодов.
id	id		string	Строка идентификатора компонента вознаграждения по умолчанию.
имя	name		string	Имя компонента вознаграждения по умолчанию.
id	id		string	Строка идентификатора источника набора данных.
имя	name		string	Имя, заданное этому источнику набора.
стоимость	cost		double	Стоимость набора.
currency	currency		string	Валюта, используемая для вербовки этого задания. Международный код валюты. Как правило, AUD для австралийского доллара, USD для американского доллара и т. д. См. официальный список кодов.

Возвращаемое значение

SingleJob: SingleJob

Создание записи обучения

Идентификатор операции:: CreateaTraining

Создание новой записи обучения

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id		string	Строка идентификатора для пользователя , который будет находиться в системе.
имя	name		string	Имя пользователя в intelliHR для поиска. Обратите внимание, что учетные записи поиска для различий в порядке имен автоматически.
первичныйадрес электронной почты	primaryEmailAddress		string	Адрес электронной почты, помеченный как основной для пользователя в системе.
номер сотрудника	employeeNumber		string	Введенный вручную номер сотрудника, определяющий человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
autoIncrementIntellihrId	autoIncrementIntellihrId		string	Автогенерированное число, которое однозначно идентифицирует человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
завершениеДата	completionDate	True	string	Метка времени обучения завершена. Эта дата будет соответствовать формату, определенному RFC3339. Формат YYY-MM-DD даты также поддерживается, хотя с помощью этого формата дата будет храниться в качестве начала дня в формате UTC, а не часовой пояс запрашивающих клиентов.
стоимость	cost		string	Стоимость этого обучения.
currency	currency		string	Валюта, используемая для этого обучения. По умолчанию используется валюта клиента по умолчанию, если она не указана. Международный код валюты. Как правило, AUD для австралийского доллара, USD для американского доллара и т. д. См. официальный список кодов.
Часов	hours		string	Сколько часов было потрачено на это обучение
id	id		string	Строка идентификатора задания , для которую было выполнено обучение .
имя	name	True	string	Понятное имя, заданное этому обучению для идентификации в системе.
id	id		string	Строка идентификатора для пользователя , который будет находиться в системе.
имя	name		string	Имя пользователя в intelliHR для поиска. Обратите внимание, что учетные записи поиска для различий в порядке имен автоматически.
первичныйадрес электронной почты	primaryEmailAddress		string	Адрес электронной почты, помеченный как основной для пользователя в системе.
номер сотрудника	employeeNumber		string	Введенный вручную номер сотрудника, определяющий человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
autoIncrementIntellihrId	autoIncrementIntellihrId		string	Автогенерированное число, которое однозначно идентифицирует человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
id	id		string	Строка идентификатора поставщика обучения для обучения .
имя	name		string	Понятное имя, заданное поставщику обучения для обучения.
id	id		string	Строка идентификатора для типа обучения обучения.
имя	name		string	Понятное имя, заданное типу обучения для обучения.
customFields	customFields			Значения настраиваемого поля для этого обучения

Возвращаемое значение

SingleTraining: SingleTraining

Создание записи пользователя

Идентификатор операции:: CreateaPerson

Создание пользователя

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	firstName		string	Имя пользователя .
второе имя	middleName		string	По промежуточному имени человека .
lastName	lastName	True	string	Фамилия человека .
preferredName;	preferredName		string	Предпочтительное имя пользователя . Как правило, можно настроить сотрудниками самостоятельно.
dateOfBirth	dateOfBirth		string	Дата рождения (гггг-MM-DD).
gender	gender		string	Удобочитаемая строка для пола человека , например `Male`. Поиск выполняется без учета регистра и "начинается с", например, передача `male` будет соответствовать полу под названием "Мужчина", как "m" или "M". Если первое соответствует нескольким полам , будет выбрано первое.
номер сотрудника	employeeNumber		string	Введенный вручную номер сотрудника, определяющий человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
title	title		string	Заголовок, ссылающийся на этого человека , например "Mr". Это значение null, если оно не указано и не учитывает регистр.
имя	name		string	Имя экстренного контакта.
Отношение	relationship		string	Связь с этим экстренным контактом с человеком.
phone	phone		string	Номер телефона экстренного контакта.
электронная почта	email		string	Электронная почта экстренного контакта.
электронная почта	email		string	Фактический адрес электронной почты.
isPersonal	isPersonal		boolean	Указывает, является ли этот адрес личным или рабочим.
число/номер	number		string	Фактический номер телефона. Это число можно префиксировать с помощью кода области. В этом случае система будет автоматически пытаться определить страну происхождения для номера телефона.
isPersonal	isPersonal		boolean	Указывает, является ли этот телефон личным или рабочим номером телефона.
customFields	customFields		object	Значения настраиваемого поля для этого пользователя
id	id		string	Строка идентификатора права на работу , к которой принадлежит этот человек .
имя	name		string	Имя права на работу.
workRightExpiryDate	workRightExpiryDate		string	Срок действия этого права на работу истекает для этого человека (гггг-MM-DD).

Возвращаемое значение

SinglePerson: SinglePerson

Создание нового бизнес-подразделения

Идентификатор операции:: CreateanewBusinessUnit

Возвращает созданный бизнес-единицу.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
идентификатор	identifier		string	Необязательный идентификатор, который можно использовать для административных задач.
имя	name	True	string	Имя, заданное для этого подразделения. Обычно это имя будет отображаться пользователям системы.
заметки	notes		string	Заметки, присоединенные к бизнес-единице
parentId	parentId		string	Строка идентификатора родительской бизнес-единицы или null, если родительский элемент отсутствует (это бизнес-единица верхнего уровня).
isEnabled	isEnabled		boolean	Указывает, могут ли пользователи выбрать эту бизнес-единицу в раскрывающихся списках.

Возвращаемое значение

Ответ: Response

Создание предварительно назначенного URL-адреса отправки

Идентификатор операции:: PersonDocuments_POST

Создание предварительно назначенного URL-адреса отправки

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id		string	Строка идентификатора для пользователя , который будет находиться в системе.
имя	name		string	Имя пользователя в intelliHR для поиска. Обратите внимание, что учетные записи поиска для различий в порядке имен автоматически.
первичныйадрес электронной почты	primaryEmailAddress		string	Адрес электронной почты, помеченный как основной для пользователя в системе.
номер сотрудника	employeeNumber		string	Введенный вручную номер сотрудника, определяющий человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
autoIncrementIntellihrId	autoIncrementIntellihrId		string	Автогенерированное число, которое однозначно идентифицирует человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
filename	filename	True	string	Исходное имя файла документа. Это будет использоваться для отображаемого имени. Включает расширение.
mime	mime	True	string	Тип mime документа
size	size	True	integer	Предполагаемый размер документа в байтах
Расширение	extension	True	string	Расширение документа, не включая точку

Возвращаемое значение

SinglePersonDocument: SinglePersonDocument

Список всех поставщиков обучения

Идентификатор операции:: ListallTrainingProviders

Возвращает список всех поставщиков обучения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Количество элементов на страницу	limit		integer	Количество элементов на страницу
Номер страницы	page		integer	Номер страницы

Возвращаемое значение

ListallTrainingProviders: ListallTrainingProviders

Список всех рабочих прав

Идентификатор операции:: ListallWorkRights

Возвращает список всех прав на работу, записанных в системе.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Количество элементов на страницу	limit		integer	Количество элементов на страницу
Номер страницы	page		integer	Номер страницы

Возвращаемое значение

ListofWorkRights: ListofWorkRights

Список всех рабочих типов

Идентификатор операции:: ListallWorkTypes

Возвращает список всех рабочих типов, записанных в системе.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Количество элементов на страницу	limit		integer	Количество элементов на страницу
Номер страницы	page		integer	Номер страницы

Возвращаемое значение

ListWorkTypes: ListWorkTypes

Список всех условий занятости

Идентификатор операции:: Listallemploymentconditions

Возвращает список всех условий занятости.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Количество элементов на страницу	limit		integer	Количество элементов на страницу
Номер страницы	page		integer	Номер страницы

Возвращаемое значение

ListofEmploymentConditions: ListofEmploymentConditions

Удаление бизнес-единицы по идентификатору

Идентификатор операции:: DeleteaBusinessUnitbyID

Удалите подразделение по указанному идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор бизнес-подразделения	id	True	string	Строка идентификатора ресурса

Возвращаемое значение

response: string

Удаление веб-перехватчика по идентификатору

Идентификатор операции:: DeleteaWebhookbyID

Удаляет предоставленный веб-перехватчик.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор веб-перехватчика	id	True	string	Строка идентификатора ресурса

Возвращаемое значение

response: string

Удаление записи обучения по идентификатору

Идентификатор операции:: DeleteaTrainingbyID

Удаляет предоставленную запись обучения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор учебной записи	id	True	string	Строка идентификатора ресурса

Возвращаемое значение

response: string

Триггеры

Создание веб-перехватчика и подписка на тип события в клиенте

Идентификатор операции:: CreateWebhook

Создание веб-перехватчика и подписка на тип события в клиенте

Параметры

Имя	Ключ	Обязательно	Тип	Описание
webhookEvent	webhookEvent	True	string	webhookEvent
isEnabled	isEnabled		boolean	isEnabled
source	source		string	source

Возвращаемое значение

Имя	Путь	Тип	Описание
id	id	string	id
событие	event	string	событие
отметка времени	timestamp	string	отметка времени
сам	links.self	string	сам

Определения

SingleBusinessEntity

Имя	Путь	Тип	Описание
BusinessEntity	data	BusinessEntity

ListofBusinessEntities

Имя	Путь	Тип	Описание
данные	data	array of BusinessEntity
Meta	meta	Meta	Содержит другие метаданные о ответе.
Links	links	Links	Ссылки на другие связанные ресурсы.

Ответ

Имя	Путь	Тип	Описание
BusinessUnit3	data	BusinessUnit3
Мета1	meta	Meta1	Содержит другие метаданные о ответе.

ListofBusinessUnits

Имя	Путь	Тип	Описание
данные	data	array of BusinessUnit3
Meta2	meta	Meta2	Содержит другие метаданные о ответе.
Links	links	Links	Ссылки на другие связанные ресурсы.

SingleCustomFieldDefinition

Имя	Путь	Тип	Описание
CustomFieldDefinition	data	CustomFieldDefinition

ListofCustomFieldDefinitions

Имя	Путь	Тип	Описание
данные	data	array of CustomFieldDefinition
Meta	meta	Meta	Содержит другие метаданные о ответе.
Links	links	Links	Ссылки на другие связанные ресурсы.

SingleDefaultRemunerationComponent

Имя	Путь	Тип	Описание
DefaultRemunerationComponent	data	DefaultRemunerationComponent

ListofDefaultRemunerationComponents

Имя	Путь	Тип	Описание
данные	data	array of DefaultRemunerationComponent
Meta	meta	Meta	Содержит другие метаданные о ответе.
Links	links	Links	Ссылки на другие связанные ресурсы.

SingleEmploymentCondition

Имя	Путь	Тип	Описание
EmploymentCondition	data	EmploymentCondition

ListofEmploymentConditions

Имя	Путь	Тип	Описание
данные	data	array of EmploymentCondition
Meta	meta	Meta	Содержит другие метаданные о ответе.
Links	links	Links	Ссылки на другие связанные ресурсы.

SingleJob

Имя	Путь	Тип	Описание
Мета1	meta	Meta1	Содержит другие метаданные о ответе.
Job	data	Job

Перечисление заданий

Имя	Путь	Тип	Описание
данные	data	array of Job
Meta8	meta	Meta8	Содержит другие метаданные о ответе.
Links	links	Links	Ссылки на другие связанные ресурсы.

SingleLocation

Имя	Путь	Тип	Описание
location5	data	location5

Перечисления

Имя	Путь	Тип	Описание
данные	data	array of location5
Meta	meta	Meta	Содержит другие метаданные о ответе.
Links	links	Links	Ссылки на другие связанные ресурсы.

SinglePayGrade

Имя	Путь	Тип	Описание
payGrade5	data	payGrade5

ListofPayGrades

Имя	Путь	Тип	Описание
данные	data	array of payGrade5
Meta	meta	Meta	Содержит другие метаданные о ответе.
Links	links	Links	Ссылки на другие связанные ресурсы.

ListPeople

Имя	Путь	Тип	Описание
данные	data	array of data1
Meta	meta	Meta	Содержит другие метаданные о ответе.
Links	links	Links	Ссылки на другие связанные ресурсы.

SinglePerson

Имя	Путь	Тип	Описание
data1	data	data1

SinglePersonDocument

Имя	Путь	Тип	Описание
Data3	data	Data3

PatchaPersonDocument

Имя	Путь	Тип	Описание
Data4	data	Data4

SingleRecruitmentSource

Имя	Путь	Тип	Описание
recruitmentSource	data	recruitmentSource

ListofRecruitmentSources

Имя	Путь	Тип	Описание
данные	data	array of recruitmentSource	Сведения о источнике набора.
Meta	meta	Meta	Содержит другие метаданные о ответе.
Links	links	Links	Ссылки на другие связанные ресурсы.

SingleTrainingProvider

Имя	Путь	Тип	Описание
trainingProviders	data	trainingProviders

ListallTrainingProviders

Имя	Путь	Тип	Описание
данные	data	array of trainingProviders
Meta	meta	Meta	Содержит другие метаданные о ответе.
Links	links	Links	Ссылки на другие связанные ресурсы.

SingleTraining

Имя	Путь	Тип	Описание
Обучение	data	Training

ListofTrainings

Имя	Путь	Тип	Описание
данные	data	array of Training
Meta	meta	Meta	Содержит другие метаданные о ответе.
Links	links	Links	Ссылки на другие связанные ресурсы.

SingleTrainingTypes

Имя	Путь	Тип	Описание
trainingTypes	data	trainingTypes

ListallTrainingTypes

Имя	Путь	Тип	Описание
данные	data	array of trainingTypes
Meta	meta	Meta	Содержит другие метаданные о ответе.
Links	links	Links	Ссылки на другие связанные ресурсы.

SingleWorkClass

Имя	Путь	Тип	Описание
WorkClassesSchema	data	WorkClassesSchema

ListWorkClasses

Имя	Путь	Тип	Описание
данные	data	array of WorkClassesSchema
Meta	meta	Meta	Содержит другие метаданные о ответе.
Links	links	Links	Ссылки на другие связанные ресурсы.

SingleWorkRight

Имя	Путь	Тип	Описание
WorkRight2	data	WorkRight2

ListofWorkRights

Имя	Путь	Тип	Описание
данные	data	array of WorkRight2
Meta	meta	Meta	Содержит другие метаданные о ответе.
Links	links	Links	Ссылки на другие связанные ресурсы.

SingleWorkType

Имя	Путь	Тип	Описание
workType4	data	workType4

ListWorkTypes

Имя	Путь	Тип	Описание
данные	data	array of workType4
Meta	meta	Meta	Содержит другие метаданные о ответе.
Links	links	Links	Ссылки на другие связанные ресурсы.

веб-перехватчик-события

Одно событие веб-перехватчика.

Имя	Путь	Тип	Описание
Data5	data	Data5

SingleWebhook

Имя	Путь	Тип	Описание
Data7	data	Data7

Дополнение

Имя	Путь	Тип	Описание
имя	name	string	Имя этого дополнения.
type	type	string	Как это добавление вычисляется и применяется к базовой сумме, несколькоOfBase умножается на baseAnnualSalary, а затем добавляется к общей сумме, а фиксированная сумма добавляется непосредственно к общей сумме. Перечисление: `MultipleOfBase`, `FixedAmount`.
value	value	double	Для несколькихOfBase это умножение (например, 9 = 9%) в то время как для фиксированной суммы это сумма, добавляемая непосредственно в общую сумму.
currency	currency	string	Валюта, используемая для этого дополнения. Международный код валюты. Как правило, AUD для австралийского доллара, USD для американского доллара и т. д. См. официальный список кодов.

AdditionsTotal

Имя	Путь	Тип	Описание
имя	name	string	Имя этого общего дополнения.
type	type	string	Как это общее добавление вычисляется и применяется к базовой сумме, несколькоOfBase умножается на baseAnnualSalary, а затем добавляется к общей сумме, а фиксированная сумма добавляется непосредственно к общей сумме. Перечисление: `MultipleOfBase`, `FixedAmount`.
value	value	double	Для несколькихOfBase это умножение (например, 9 = 9%) в то время как для фиксированной суммы это сумма, добавляемая непосредственно в общую сумму.
currency	currency	string	Валюта, используемая для этого дополнения. Международный код валюты. Как правило, AUD для австралийского доллара, USD для американского доллара и т. д. См. официальный список кодов.

Address

Имя	Путь	Тип	Описание
addressType	addressType	string	Тип адреса.
fullAddress	fullAddress	string	Полный адрес.
country	country	string	Страна адреса.
почтовый индекс	postcode	string	Почтовый индекс адреса.
государство	state	string	Регион в адресе.
улица	street	string	Улица, на которую находится адрес.
пригород	suburb	string	Пригород адреса.

Поломка

Имя	Путь	Тип	Описание
имя	name	string	Имя этого дополнения.
type	type	string	Как записано это дополнение, оно не используется для вычисления общего пакета из-за других компонентов вознаграждения. Перечисление: `MultipleOfBase`, `FixedAmount`.
value	value	double	Для несколькихOfBase это умножение (например, 9 = 9%) в то время как для фиксированной суммы это сумма, добавляемая непосредственно в общую сумму.
currency	currency	string	Валюта, используемая для этого дополнения. Международный код валюты. Как правило, AUD для австралийского доллара, USD для американского доллара и т. д. См. официальный список кодов.

BusinessEntity

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для бизнес-сущности.
имя	name	string	Имя, заданное для этой бизнес-сущности. Обычно это имя будет отображаться пользователям системы.
legalName	legalName	string	Юридическое имя может отличаться от имени, представленного пользователю. Обычно используется для административных задач.
число/номер	number	string	Юридически зарегистрированный номер бизнес-сущности , например в Австралии, это может быть ABN или в Америке RN.
isEnabled	isEnabled	boolean	Указывает, могут ли пользователи выбрать эту бизнес-сущность в раскрывающихся списках.

BusinessUnit3

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для бизнес-единицы.
идентификатор	identifier	string	Необязательный идентификатор, который можно использовать для административных задач.
имя	name	string	Имя, заданное для этого подразделения. Обычно это имя будет отображаться пользователям системы.
заметки	notes	string	Заметки, присоединенные к бизнес-единице
parentId	parentId	string	Строка идентификатора родительской бизнес-единицы или null, если родительский элемент отсутствует (это бизнес-единица верхнего уровня).
isEnabled	isEnabled	boolean	Указывает, могут ли пользователи выбрать эту бизнес-единицу в раскрывающихся списках.

BusinessEntity2

Текущая бизнес-сущность задания в системе.

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для бизнес-сущности этого задания.
имя	name	string	Имя, заданное для этой бизнес-сущности. Обычно это имя будет отображаться пользователям системы.
link	link	string	Ссылка на общедоступный API, чтобы получить дополнительные сведения об этом фрагменте данных.

BusinessUnit4

Текущая бизнес-единица задания в системе.

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для бизнес-единицы этого задания.
имя	name	string	Имя, заданное для этого подразделения. Обычно это имя будет отображаться пользователям системы.
link	link	string	Ссылка на общедоступный API, чтобы получить дополнительные сведения об этом фрагменте данных.

координатор

Координатор, который сделал обучение. Эти данные являются необязательными и будут иметь значение NULL, если он не хранится.

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для координатора обучения.
отображаемое имя	displayName	string	Имя человека , который координировал обучение.
номер сотрудника	employeeNumber	string	Введенный вручную номер сотрудника, определяющий человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
autoIncrementIntellihrId	autoIncrementIntellihrId	double	Автогенерированное число, которое однозначно идентифицирует человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
link	link	string	Ссылка на общедоступный API, чтобы получить дополнительные сведения об этом фрагменте данных.

CustomFieldDefinition

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для определения настраиваемого поля.
имя	name	string	Имя, заданное этому определению настраиваемого поля. Обычно это имя будет отображаться пользователям системы.
apiName	apiName	string	Имя API, заданное этому определению настраиваемого поля. Это имя используется для уникальной идентификации настраиваемого поля в API и используется в качестве ключа при изменении настраиваемого поля в записи.
описание	description	string	Описание этого определения настраиваемого поля. Это средство используется в качестве подсказки на страницах создания и обновления.
modelType	modelType	string	Модель, к которому относится настраиваемое поле, и к ней можно подключиться. Перечисление: `TRAINING`, `PERSON`.
type	type	string	Тип данных, записей этого поля. Перечисление: `SINGLE_SELECT`, , `MULTI_SELECTTEXT`, `PEOPLE_DROPDOWNNUMBER`.
definitions	definitions	object	Значения этого ключа изменяются в зависимости от ключа type. Он используется для хранения дополнительных сведений, относящихся к этому ключу. Дополнительные сведения о конфигурациях настраиваемых полей см. в статье базы знаний о настраиваемых полях.

data1

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для person.
отображаемое имя	displayName	string	Имя, отображаемое в системе для этого пользователя. Как правило, следует шаблону предпочтительного имени (firstName) lastName, но его можно настроить на основе всего клиента, чтобы он был другим форматом.
Имя	firstName	string	Имя пользователя .
второе имя	middleName	string	По промежуточному имени человека .
lastName	lastName	string	Фамилия человека .
preferredName;	preferredName	string	Предпочтительное имя пользователя . Как правило, можно настроить сотрудниками самостоятельно.
dateOfBirth	dateOfBirth	string	Дата рождения (гггг-MM-DD).
gender	gender	string	Читаемая человеком строка для пола человека , например мужчины.
номер сотрудника	employeeNumber	string	Введенный вручную номер сотрудника, определяющий человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
autoIncrementIntellihrId	autoIncrementIntellihrId	double	Автогенерированное число, которое однозначно идентифицирует человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
title	title	string	Заголовок, ссылающийся на этого человека , например "Mr". Это значение null, если оно не указано.
emailАдреса	emailAddresses	array of EmailAddress	Массив адресов электронной почты, принадлежащих этому пользователю.
Аварийныйcontact	emergencyContact	EmergencyContact	Сведения об экстренном контакте этого человека .
employmentStatus	employmentStatus	string	Текущее состояние этого лица в организации. Перечисление: `Current Staff`, `Exiting Staff`, `Past StaffNo Job Records`, `Returning Staff`, `Upcoming Staff`.
jobs	jobs	array of Job4	Массив простых записей задания , связанных с этим человеком в обратном хронологическом порядке начальной даты.
WorkRights	workRights	WorkRights	Показать права на работу человека
PrimaryEmailAddress1	primaryEmailAddress	PrimaryEmailAddress1	Сведения об основном адресе электронной почты этого пользователя или значение NULL, если у них нет сведений электронной почты.
PrimaryPhoneNumber1	primaryPhoneNumber	PrimaryPhoneNumber1	Сведения о основном номере телефона этого пользователя или значение NULL, если у них нет номеров телефонов.
addresses	addresses	array of Address	Массив адресов, принадлежащих этому человеку.
Телефонные номера	phoneNumbers	array of PhoneNumber	Массив номеров телефонов, принадлежащих этому человеку.
createdAt	createdAt	string	После создания этой записи. Эта дата будет соответствовать формату, определенному RFC3339.
обновлено	updatedAt	string	После последнего обновления этой записи. Эта дата будет соответствовать формату, определенному RFC3339.

Data3

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для документа Person.
personId	personId	string	Строка идентификатора пользователя , которому принадлежит этот документ .
presignedUploadUrl	presignedUploadUrl	string	URL-адрес предварительной отправки, который позволяет отправлять документ person в S3. Эта ссылка истекает через 20 минут после создания. Инструкции по отправке объекта с предварительно заданным URL-адресом S3 см. здесь.

Data4

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для документа Person.
personId	personId	string	Строка идентификатора пользователя , которому принадлежит этот документ .
uploadStatus	uploadStatus	string	Состояние отправки этого документа. Перечисление: `SUCCESS`, `PENDING`, `FAILED`.

Data5

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для события веб-перехватчика.
имя	name	string	Удобочитаемый уникальный ключ события для этого события веб-перехватчика.
событие	event	string	Слизь события веб-перехватчика.
examplePayload	examplePayload	object	Пример полезных данных, которые будут отправляться в веб-перехватчики , которые подписываются на это конкретное событие веб-перехватчика.

Data7

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора веб-перехватчика.
URL-адрес	url	string	Конечная точка веб-перехватчика , к которой будет отправлен запрос при активации события веб-перехватчика подписки.
WebhookEvent	webhookEvent	WebhookEvent	Событие веб-перехватчика, активировающее этот веб-перехватчик.
isEnabled	isEnabled	boolean	Указывает, могут ли пользователи выбрать этот веб-перехватчик. При отключении этот веб-перехватчик не будет отправлен.
source	source	string	Настраиваемая строка, которую можно использовать для определения системы, созданной этим веб-перехватчиком. Веб-перехватчики , созданные с помощью приложения IntelliHR, будут иметь источник: custom.
createdAt	createdAt	string	После создания этой записи. Эта дата будет соответствовать формату, определенному RFC3339.
обновлено	updatedAt	string	После последнего обновления этой записи. Эта дата будет соответствовать формату, определенному RFC3339.

Вычет

Имя	Путь	Тип	Описание
имя	name	string	Имя этого вычета.
type	type	string	Как этот вычет вычисляется и применяется к базовой сумме, несколькоOfBase умножается на baseAnnualSalary, а затем вычитается из суммы, а фиксированная сумма вычитается непосредственно из общей суммы. Перечисление: `MultipleOfBase`, `FixedAmount`.
value	value	double	Для несколькихOfBase это умножение, в то время как для фиксированной суммы это сумма, которую можно вычитать непосредственно из общей суммы.
currency	currency	string	Валюта, используемая для этого вычета. Международный код валюты. Как правило, AUD для австралийского доллара, USD для американского доллара и т. д. См. официальный список кодов.

DefaultRemunerationComponent

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора компонента вознаграждения по умолчанию.
имя	name	string	Имя, заданное этому компоненту вознаграждения по умолчанию. Обычно это имя будет отображаться пользователям системы.
value	value	string	Значение этого компонента вознаграждения. Для несколькихOfBase это умножение, в то время как для фиксированной суммы это сумма, чтобы напрямую добавить в общую сумму.
isInUse	isInUse	boolean	Используется ли этот компонент вознаграждения по умолчанию в качестве любого компонента вознаграждения.
автоматическиAddToJobs	automaticallyAddToJobs	boolean	Будет ли этот компонент вознаграждения по умолчанию автоматически добавлен в только что созданные или обновленные задания.
isEnabled	isEnabled	boolean	Если этот компонент вознаграждения по умолчанию включен для использования в системе.
currency	currency	string	Валюта, используемая для этого компонента вознаграждения по умолчанию. Международный код валюты. Как правило, AUD для австралийского доллара, USD для американского доллара и т. д. См. официальный список кодов.
type	type	string	Тип этого компонента вознаграждения по умолчанию. Перечисление: `AdditionToBase`, , `BreakdownAdditionToTotalDeductionToBase`.
valueType	valueType	string	Тип значения этого компонента вознаграждения по умолчанию. Перечисление: `MultipleOfBase`, `FixedAmount`.

Электронный адрес

Имя	Путь	Тип	Описание
электронная почта	email	string	Фактический адрес электронной почты.
isPrimary	isPrimary	boolean	Если это основной адрес электронной почты.
isPersonal	isPersonal	boolean	Если это личный адрес электронной почты.

Аварийныйcontact

Сведения об экстренном контакте этого человека .

Имя	Путь	Тип	Описание
имя	name	string	Имя экстренного контакта.
Отношение	relationship	string	Связь с этим экстренным контактом с человеком.
phone	phone	string	Номер телефона экстренного контакта.
электронная почта	email	string	Электронная почта экстренного контакта.

EmploymentCondition

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора условия занятости.
имя	name	string	Имя, заданное этому условию занятости. Обычно это имя будет отображаться пользователям системы.
awardName	awardName	string	Имя награды может отличаться от имени, представленного пользователю. Обычно используется для юридического имени награды.
isEnabled	isEnabled	boolean	Указывает, могут ли пользователи выбрать это условие занятости в раскрывающихся списках.

EmploymentCondition2

Условие занятости, по которой оплачивается эта работа.

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора условия занятости этого расписания вознаграждения.
имя	name	string	Имя, заданное этому условию занятости. Обычно это имя будет отображаться пользователям системы.
awardName	awardName	string	Имя награды может отличаться от имени, представленного пользователю. Обычно используется для юридического имени награды.
link	link	string	Ссылка на общедоступный API, чтобы получить дополнительные сведения об этом фрагменте данных.

Job

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора задания.
Персона	person	Person	Человек, которому принадлежит это задание.
Вербовка	recruitment	Recruitment	Сведения о наборе, хранящиеся для этого задания.
Местоположение	location	Location	Географическое расположение этого задания.
PayGrade	payGrade	PayGrade	Текущий уровень оплаты задания в системе.
BusinessUnit4	businessUnit	BusinessUnit4	Текущая бизнес-единица задания в системе.
BusinessEntity2	businessEntity	BusinessEntity2	Текущая бизнес-сущность задания в системе.
РуководительJob	supervisorJob	SupervisorJob	Сведения о задании для руководителя этого задания или null, если у них нет руководителя.
РуководительPerson	supervisorPerson	SupervisorPerson	Сведения о человеке для руководителя этого задания или null, если у них нет руководителя.
ВознаграждениеSchedule	remunerationSchedule	RemunerationSchedule	Текущие сведения о вознаграждении для этой работы, включая информацию, например зарплату и почасовую оплату, все рабочие места имеют расписание вознаграждения, но для неоплачиваемых сотрудников они будут иметь специальный `No Remuneration Schedule` график.
имя	name	string	Название или должность этого задания.
fte	fte	number	Полный рабочий день, эквивалентный этому заданию. Указывая рабочую нагрузку сотрудника, которая может быть сравнима с различными контекстами. Это значение null для людей без FTE.
workClass	workClass	string	Рабочий класс этого задания. Это дополнительные сведения о рабочем типе.
workType	workType	string	Это классификация трудоемких работ для этого задания, она используется для различения сотрудников с неполным временем и неоплачиваемых добровольцев. Перечисление: `Permanent`, , `Fixed ContractUnpaid`, `Independent ContractTemporary/Casual`.
jobStatus	jobStatus	string	Текущее состояние этой работы в этой организации. Перечисление: `Past Job`, , `Current JobFuture JobEnding Job`.
companyStartDate	companyStartDate	string	Дата начала или начала работы в организации. Эта дата будет соответствовать формату, определенному RFC3339.
companyEndDate	companyEndDate	string	Дата окончания или окончания задания в организации или null, если дата окончания отсутствует. Эта дата будет соответствовать формату, определенному RFC3339.
isEndDateConfirmed	isEndDateConfirmed	boolean	Будет ли дата окончания завершена в приложении IntelliHR.
turnoverType	turnoverType	string	Тип оборотов этот конец задания классифицируется как.
оборотReason	turnoverReason	string	Имя причины оборота.
createdAt	createdAt	string	После создания этой записи. Эта дата будет соответствовать формату, определенному RFC3339.

Задание4

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора задания.
имя	name	string	Название или должность этого задания.
startDate	startDate	string	Дата начала или начала работы в организации. Эта дата будет соответствовать формату, определенному RFC3339.
Дата окончания	endDate	string	Дата окончания или окончания задания в организации или null, если дата окончания отсутствует. Эта дата будет соответствовать формату, определенному RFC3339.
jobStatus	jobStatus	string	Текущее состояние этого задания в этой организации. Перечисление: `Past Job`, , `Current JobFuture JobEnding Job`.
link	link	string	Ссылка на общедоступный API, чтобы получить дополнительные сведения об этом фрагменте данных.

Job7

Задание человека, который сделал обучение.

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для задания обучения.
имя	name	string	Имя задания лиц, которые сделали обучение.
startDate	startDate	string	Дата начала заданий . Эта дата будет соответствовать формату, определенному RFC3339.
Дата окончания	endDate	string	Дата окончания заданий . Эта дата будет соответствовать формату, определенному RFC3339.
jobStatus	jobStatus	string	Схема состояния. Перечисление: `Past Job`, , `Current JobFuture JobEnding Job`.
link	link	string	Ссылка на общедоступный API, чтобы получить дополнительные сведения об этом фрагменте данных.

Links

Ссылки на другие связанные ресурсы.

Имя	Путь	Тип	Описание
сам	self	string	URL-адрес текущей страницы
первый	first	string	URL-адрес первой страницы
Предыдущая	prev	string	URL-адрес предыдущей страницы
next	next	string	URL-адрес следующей страницы
последний	last	string	URL-адрес последней страницы

Местоположение

Географическое расположение этого задания.

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для расположения этого задания.
имя	name	string	Имя, заданное этому расположению. Обычно это имя будет отображаться пользователям системы.
address	address	string	Адрес этого расположения.
link	link	string	Ссылка на общедоступный API, чтобы получить дополнительные сведения об этом фрагменте данных.

location5

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора расположения.
parentId	parentId	string	Строка идентификатора родительского расположения или null, если родительский объект отсутствует (это расположение верхнего уровня).
имя	name	string	Имя, заданное этому расположению. Обычно это имя будет отображаться пользователям системы.
address	address	string	Адрес этого расположения.
isEnabled	isEnabled	boolean	Указывает, могут ли пользователи выбрать это расположение в раскрывающихся списках.

Мета1

Содержит другие метаданные о ответе.

Имя	Путь	Тип	Описание
asAt	asAt	string	Момент времени, для которого этот ответ предназначен. Эта дата будет соответствовать формату, определенному RFC3339.

Meta2

Содержит другие метаданные о ответе.

Имя	Путь	Тип	Описание
asAt	asAt	string	Момент времени, для которого этот ответ предназначен. Эта дата будет соответствовать формату, определенному RFC3339.
Постраничная разбивка	pagination	Pagination	Содержит сведения, связанные с разбивкой на страницы ответа

Meta8

Содержит другие метаданные о ответе.

Имя	Путь	Тип	Описание
asAt	asAt	string	Момент времени, в течение которого данные в этом ответе точны. Эта дата будет соответствовать формату, определенному RFC3339.
Постраничная разбивка	pagination	Pagination	Содержит сведения, связанные с разбивкой на страницы ответа

Постраничная разбивка

Содержит сведения, связанные с разбивкой на страницы ответа

Имя	Путь	Тип	Описание
итог	total	integer	Общее число элементов
count	count	integer	Количество элементов для текущей страницы
per_page	per_page	integer	Элементы на предел страницы
current_page	current_page	integer	Текущая страница
total_pages	total_pages	integer	Общее количество страниц

PayGrade

Текущий уровень оплаты задания в системе.

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для оценки оплаты этого задания.
имя	name	string	Понятное имя, заданное для оценки оплаты.
код	code	string	Административный, короткий код, связанный с оценкой оплаты.
link	link	string	Ссылка на общедоступный API, чтобы получить дополнительные сведения об этом фрагменте данных.

payGrade5

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для оценки оплаты.
код	code	string	Административный, короткий код, связанный с оценкой оплаты.
имя	name	string	Понятное имя, заданное для оценки оплаты.
isEnabled	isEnabled	boolean	Указывает, могут ли пользователи выбрать этот уровень оплаты в раскрывающихся списках.

Персона

Человек, которому принадлежит это задание.

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора пользователя , которому принадлежит это задание .
отображаемое имя	displayName	string	Имя, отображаемое в системе для этого пользователя. Как правило, следует шаблону предпочтительного имени (firstName) lastName, но его можно настроить на основе всего клиента, чтобы он был другим форматом.
номер сотрудника	employeeNumber	string	Введенный вручную номер сотрудника, определяющий человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
autoIncrementIntellihrId	autoIncrementIntellihrId	double	Автогенерированное число, которое однозначно идентифицирует человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
link	link	string	Ссылка на общедоступный API, чтобы получить дополнительные сведения об этом фрагменте данных.

Person7

Человек, который сделал обучение.

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для пользователя обучения.
отображаемое имя	displayName	string	Имя человека , который сделал обучение.
номер сотрудника	employeeNumber	string	Введенный вручную номер сотрудника, определяющий человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
autoIncrementIntellihrId	autoIncrementIntellihrId	double	Автогенерированное число, которое однозначно идентифицирует человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
link	link	string	Ссылка на общедоступный API, чтобы получить дополнительные сведения об этом фрагменте данных.

Номер телефона

Имя	Путь	Тип	Описание
число/номер	number	string	Фактический номер телефона.
fullNumber	fullNumber	string	Фактический номер телефона с кодом области (если зарегистрирован).
isPrimary	isPrimary	boolean	Если это основной номер телефона.
isPersonal	isPersonal	boolean	Если это личный номер телефона.

PrimaryEmailAddress1

Сведения об основном адресе электронной почты этого пользователя или значение NULL, если у них нет сведений электронной почты.

Имя	Путь	Тип	Описание
электронная почта	email	string	Фактический адрес электронной почты.
isPersonal	isPersonal	boolean	Указывает, является ли этот адрес личным или рабочим.

PrimaryPhoneNumber1

Сведения о основном номере телефона этого пользователя или значение NULL, если у них нет номеров телефонов.

Имя	Путь	Тип	Описание
число/номер	number	string	Фактический номер телефона.
fullNumber	fullNumber	string	Фактический номер телефона с кодом области (если зарегистрирован).
isPersonal	isPersonal	boolean	Указывает, является ли этот номер телефона личным или рабочим номером.

Provider

Поставщик обучения для обучения.

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора поставщика обучения для обучения .
имя	name	string	Понятное имя, заданное поставщику обучения для обучения.
link	link	string	Ссылка на общедоступный API, чтобы получить дополнительные сведения об этом фрагменте данных.

Вербовка

Сведения о наборе, хранящиеся для этого задания.

Имя	Путь	Тип	Описание
стоимость	cost	number	Стоимость набирать эту работу. Если значение равно NULL, стоимость не была записана.
currency	currency	string	Валюта, используемая для вербовки этого задания. Международный код валюты. Как правило, AUD для австралийского доллара, USD для американского доллара и т. д. См. официальный список кодов.
Исходный материал	source	Source	Источник набора для этой работы был получен или имеет значение NULL, если он не был записан.

recruitmentSource

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора источника набора данных.
имя	name	string	Имя, заданное этому источнику набора.
parentId	parentId	string	Строка идентификатора для родительского источника набора или null, если родительский источник отсутствует (это источник набора верхнего уровня).
isEnabled	isEnabled	boolean	Указывает, могут ли пользователи выбрать этот источник набора в раскрывающихся списках.

ВознаграждениеSchedule

Текущие сведения о вознаграждении для этой работы, включая информацию, например зарплату и почасовую оплату, все рабочие места имеют расписание вознаграждения, но для неоплачиваемых сотрудников они будут иметь специальный No Remuneration Schedule график.

Имя	Путь	Тип	Описание
type	type	string	Метод, в котором оплачивается этот график вознаграждения, если человек неоплачен, то это будет `No Remuneration Schedule`. Перечисление: `Annual Salary`, `Hourly Rate`, `No Remuneration Schedule`.
baseAnnualSalary	baseAnnualSalary	double	Базовая зарплата выплачивается ежегодно, это приблизительное значение, если они оплачиваются почасово. Обратите внимание, что если baseAnnualSalary и baseHourlyRate предоставляются в запросе на создание или исправление, baseHourlyRate будет игнорироваться.
baseHourlyRate	baseHourlyRate	double	Базовая ставка оплачивается почасово, это приблизительное значение, если они оплачиваются ежегодно. Обратите внимание, что если baseAnnualSalary и baseHourlyRate предоставляются в запросе на создание или исправление, baseHourlyRate будет игнорироваться.
currency	currency	string	Валюта, в которой оплачивается базовая и общая сумма, в которой выполняется эта работа. Международный код валюты. Как правило, AUD для австралийского доллара, USD для американского доллара и т. д. См. официальный список кодов.
hoursPerCycle	hoursPerCycle	double	Сколько часов работало за payCycle.
payCycle	payCycle	string	Цикл оплаты задания. Перечисление: `Weekly`, `Fortnightly`, `Monthly`.
annualPackage	annualPackage	double	Общий пакет, оплачиваемый ежегодно, включая дополнения и вычеты. Эта сумма вычисляется путем добавления базовой годовой заработной платы и дополнений минус вычетов.
hourlyPackage	hourlyPackage	double	Общий пакет оплачивается почасово, включая дополнения и вычеты. Эта сумма вычисляется путем деления ежегодного пакета на общее количество часов в год.
currencyConversionOccurred	currencyConversionOccurred	boolean	Если при расчете ежегодного пакета необходимо выполнить любое преобразование между добавлением и вычетом валют.
EmploymentCondition2	employmentCondition	EmploymentCondition2	Условие занятости, по которой оплачивается эта работа.
Дополнения	additions	array of Addition	Массив дополнений для этого расписания вознаграждения.
Вычеты	deductions	array of Deduction	Массив вычетов для этого расписания вознаграждения.
additionsTotal	additionsToTotal	array of AdditionsToTotal	Массив дополнений, примененных к пакету после всех остальных компонентов для этого расписания вознаграждения.
Поломки	breakdowns	array of Breakdown	Массив разбивки по этому расписанию вознаграждения. Разбивки не будут использоваться для вычисления общего пакета.

Исходный материал

Источник набора для этой работы был получен или имеет значение NULL, если он не был записан.

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для источника набора данных этого задания.
имя	name	string	Имя, заданное этому источнику набора.
link	link	string	Ссылка на общедоступный API, чтобы получить дополнительные сведения об этом фрагменте данных.

РуководительJob

Сведения о задании для руководителя этого задания или null, если у них нет руководителя.

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для задания руководителя этого задания.
jobStatus	jobStatus	string	Текущее состояние этой работы в этой организации. Перечисление: `Past Job`, , `Current JobFuture JobEnding Job`.
имя	name	string	Название или должность задания руководителя.
link	link	string	Ссылка на общедоступный API, чтобы получить дополнительные сведения об этом фрагменте данных.

РуководительPerson

Сведения о человеке для руководителя этого задания или null, если у них нет руководителя.

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для пользователя руководителя этого задания.
отображаемое имя	displayName	string	Имя, отображаемое в системе для этого пользователя. Как правило, следует шаблону предпочтительного имени (firstName) lastName, но его можно настроить на основе всего клиента, чтобы он был другим форматом.
номер сотрудника	employeeNumber	string	Введенный вручную номер сотрудника, определяющий человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
autoIncrementIntellihrId	autoIncrementIntellihrId	double	Автогенерированное число, которое однозначно идентифицирует человека в intelliHR. Он может быть скрыт в пользовательском интерфейсе системы в зависимости от конфигурации клиента.
link	link	string	Ссылка на общедоступный API, чтобы получить дополнительные сведения об этом фрагменте данных.

Обучение

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для обучения.
имя	name	string	Понятное имя, заданное этому обучению.
Person7	person	Person7	Человек, который сделал обучение.
Job7	job	Job7	Задание человека, который сделал обучение.
координатор	coordinator	Coordinator	Координатор, который сделал обучение. Эти данные являются необязательными и будут иметь значение NULL, если он не хранится.
Часов	hours	string	Сколько часов было потрачено на это обучение.
currency	currency	string	Валюта, используемая для этого [обучения](#tag/обучения. Международный код валюты. Как правило, AUD для австралийского доллара, USD для американского доллара и т. д. См. официальный список кодов.
стоимость	cost	string	Стоимость этого обучения.
Provider	provider	Provider	Поставщик обучения для обучения.
Тип	type	Type	Тип обучения для обучения.
завершениеДата	completionDate	string	Метка времени обучения завершена. Эта дата будет соответствовать формату, определенному RFC3339.
createdAt	createdAt	string	После создания этой записи. Эта дата будет соответствовать формату, определенному RFC3339.
обновлено	updatedAt	string	После последнего обновления этой записи. Эта дата будет соответствовать формату, определенному RFC3339.

trainingProviders

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора поставщика обучения.
имя	name	string	Понятное имя поставщика обучения.
isDefault	isDefault	boolean	Указывает, будет ли этот поставщик обучения использоваться в качестве значения по умолчанию при создании записи обучения .

trainingTypes

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для типа обучения.
имя	name	string	Понятное имя, заданное типу обучения.
isDefault	isDefault	boolean	Указывает, будет ли этот тип обучения использоваться в качестве значения по умолчанию при создании записи обучения .

Тип

Тип обучения для обучения.

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для типа обучения обучения.
имя	name	string	Понятное имя, заданное типу обучения для обучения.
link	link	string	Ссылка на общедоступный API, чтобы получить дополнительные сведения об этом фрагменте данных.

WebhookEvent

Событие веб-перехватчика, активировающее этот веб-перехватчик.

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для события веб-перехватчика.
имя	name	string	Удобочитаемый уникальный ключ события для этого события веб-перехватчика.
событие	event	string	Слизь события веб-перехватчика.
link	link	string	Ссылка на общедоступный API, чтобы получить дополнительные сведения об этом фрагменте данных.

WorkClassesSchema

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для рабочего класса.
имя	name	string	Имя, заданное этому рабочему классу. Обычно это имя будет отображаться пользователям системы.
WorkType2	workType	WorkType2	Родительский тип работы этого рабочего класса.
isEnabled	isEnabled	boolean	Указывает, могут ли пользователи выбрать этот рабочий тип в раскрывающихся списках.

WorkRight2

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для work Right.
имя	name	string	Имя, заданное этому рабочему праву. Обычно это имя будет отображаться пользователям системы.
countryId	countryId	string	Строка идентификатора для страны.
country	country	string	Значение имени назначенной страны.

WorkRights

Показать права на работу человека

Имя	Путь	Тип	Описание
имя	name	string	Тип рабочих прав
country	country	string	Страна, в которой действительны права на работу
дата окончания срока действия	expirationDate	string	Дата истечения срока действия рабочих прав

WorkType2

Родительский тип работы этого рабочего класса.

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для рабочего типа этого рабочего класса.
имя	name	string	Имя рабочего типа. Перечисление: `Permanent`, , `Fixed ContractUnpaid`, `Independent ContractTemporary/Casual`.
link	link	string	Ссылка на общедоступный API, чтобы получить дополнительные сведения об этом фрагменте данных.

workType4

Имя	Путь	Тип	Описание
id	id	string	Строка идентификатора для рабочего типа.
имя	name	string	Имя рабочего типа. Перечисление: `Permanent`, , `Fixed ContractUnpaid`, `Independent ContractTemporary/Casual`.
isEnabled	isEnabled	boolean	Указывает, могут ли пользователи выбрать этот рабочий тип в раскрывающихся списках.

струна

Это базовый тип данных string.