intelliHR (Pré-visualização)

intelliHR é uma plataforma de gestão de pessoas baseada na nuvem com recursos avançados de análise. Conecte-se ao seu locatário intelliHR para automatizar fluxos de trabalho orientados a pessoas (como integração) e exportação de dados.

Este conector está disponível nos seguintes produtos e regiões:

Serviço	Class	Regiões
Estúdio Copiloto	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Aplicações Power	Premium	Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Automatize o poder	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Apoio ao Cliente
URL	https://intellihr.zendesk.com/hc/en-us
Email	support@intellihr.co

Metadados do conector
Editora	intelliHR
Sítio Web	https://www.intellihr.com
Política de privacidade	https://intellihr.co/privacy-policy/
Categorias	Recursos Humanos; Inteligência de Negócios

intelliHR é uma plataforma de Gestão de Pessoas e Análise fácil de usar para gestão centralizada de desempenho, engajamento de funcionários, processos centrais de Recursos Humanos e análise de RH, tudo em um só lugar. Crie tarefas agendadas e fluxos de trabalho automatizados com os seus dados pessoais no Power Automate, Office 365, SharePoint, Microsoft Dynamics 365 e outros serviços sem código com o intelliHR Connector.

Pré-requisitos

Para usar esse conector, você deve ter um locatário intelliHR. Para ter um inquilino provisionado para o seu grupo ou organização, visite esta página.

Como obter credenciais

Para configurar o conector, você precisará de uma chave de API e seu nome de locatário.

O nome do seu inquilino corresponderá ao subdomínio da sua conta (por exemplo). https://this-is-your-tenant-name.intellihr.net

Para criar uma chave de API:

Inicie sessão no seu inquilino com uma conta de administrador
Navegue até a página Configurações
Procure por 'API' e clique em 'Public API Access Keys'
Siga as instruções nesta página para criar uma chave.

Você também pode encontrar a interface correta em https://your-tenant.intellihr.net/spa/settings/access-keys

Introdução ao conector

Ao adicionar o conector intelliHR, você será solicitado a inserir o nome do locatário e a chave da API, bem como um nome de exibição para a conexão.

Importante: Ao inserir sua chave de API, certifique-se de anexar a chave com 'Portador', de modo que a entrada deve ler 'Portador xyz123'. Se não o fizer, resultará em erros de 'Chave API inválida'.

Problemas conhecidos e limitações

O conector intelliHR é uma tradução da API pública do intelliHR e, como tal, herda as mesmas limitações e requer a mesma validação nas solicitações.

Erros e soluções comuns

À medida que o conector intelliHR passa solicitações para a API pública do intelliHR, a maioria dos problemas pode ser solucionada fazendo referência à documentação pública da API.

Um erro de intervalo 400 é retornado se alguma parte da solicitação for inadequada e será acompanhado por uma mensagem descrevendo o problema. O problema mais comum é que o conector foi configurado sem 'Portador' na entrada da chave da API.

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:


Predefinição	Parâmetros para criar conexão.	Todas as regiões	Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Description	Obrigatório
Chave de API	securestring	A chave de API para esta api, precedida de 'Portador'	Verdade
Tenant	cadeia (de caracteres)	Seu nome de locatário intelliHR	Verdade

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de API por conexão	100	60 segundos

Ações

Atualizar um documento por id	Atualizar um documento
Atualizar um registro de treinamento por ID	Atualizar um registro de treinamento
Atualizar uma pessoa por ID	Atualizar uma pessoa
Atualizar uma Unidade de Negócios por ID	Retorna a Unidade de Negócios atualizada.
Corrigir um trabalho existente	Corrigir atributos de um registro de trabalho existente com os dados fornecidos.
Criar um novo registo de pessoa	Criar uma pessoa
Criar um novo trabalho	Crie um novo registro de trabalho com os dados fornecidos.
Criar um registro de treinamento	Criar um novo registro de treinamento
Criar um URL de carregamento pré-assinado	Criar um URL de carregamento pré-assinado
Criar uma nova Unidade de Negócio	Retorna a Unidade de Negócios criada.
Definir a data de término de um trabalho	Definir a data de término de um trabalho
Encontrar um emprego por ID	Obtenha um único registro de trabalho pelo identificador UUIDv4.
Encontrar um registo de formação por ID	Retorna um único registro de treinamento.
Encontrar um tipo de trabalho por ID	Retorna um único tipo de trabalho.
Encontrar uma classe de trabalho por ID	Retorna uma única classe de trabalho.
Encontrar uma componente de remuneração por incumprimento por ID	Devolve uma única componente de remuneração por defeito.
Encontrar uma entidade comercial por ID	Devolve uma única Entidade Empresarial pelo respetivo identificador.
Encontrar uma pessoa por ID	Obtenha um único registro de Pessoa pelo identificador UUIDv4.
Encontre um evento Webhook por ID	Retorna um único evento Webhook.
Encontre um Fornecedor de Formação por ID	Devolve um único Fornecedor de Formação.
Encontre um local por ID	Retorna um único local.
Encontre um tipo de treinamento por ID	Retorna um único tipo de treinamento.
Encontre um trabalho certo por ID	Retorna um único trabalho direito.
Encontre um Webhook por ID	Retorna um único webhook.
Encontre uma condição de emprego por ID	Devolve uma única condição de emprego.
Encontre uma fonte de recrutamento por ID	Devolve uma única fonte de recrutamento.
Encontre uma nota de pagamento por ID	Devolve uma única nota salarial.
Encontre uma Unidade de Negócio por ID	Devolve uma única Unidade de Negócio.
Excluir um registro de treinamento por ID	Exclui o registro de treinamento fornecido.
Excluir um Webhook por ID	Exclui o webhook fornecido.
Excluir uma Unidade de Negócios por ID	Exclua uma Unidade de Negócios pelo ID fornecido.
Lista de todas as condições de emprego	Devolve uma lista de todas as condições de emprego.
Listar todas as classes de trabalho	Retorna uma lista de todas as classes de trabalho registradas no sistema.
Listar todas as definições de campo personalizado	Retorna uma lista de todas as definições de campo personalizado.
Listar todas as Entidades Comerciais	Retorna uma lista de todas as Entidades Comerciais.
Listar todas as fontes de recrutamento	Devolve uma lista de todas as fontes de recrutamento.
Listar todas as pessoas	Retorna uma lista de todas as Pessoas na data atual.
Listar todas as Unidades de Negócio	Devolve uma lista de todas as Unidades de Negócio registadas no sistema.
Listar todas as vagas	Retorna uma lista de todos os registros da entidade Job na data atual.
Listar todos os componentes da remuneração padrão	Devolve uma lista de todas as Componentes de Remuneração por Incumprimento registadas no sistema.
Listar todos os direitos trabalhistas	Retorna uma lista de todos os Direitos Trabalhistas registrados no sistema.
Listar todos os graus salariais	Devolve uma lista de todas as notas salariais.
Listar todos os locais	Retorna uma lista de todos os locais.
Listar todos os Provedores de Treinamento	Devolve uma lista de todos os Fornecedores de Formação.
Listar todos os tipos de trabalho	Retorna uma lista de todos os tipos de trabalho registrados no sistema.
Listar todos os tipos de treinamento	Retorna uma lista de todos os tipos de treinamento.
Listar todos os treinamentos	Retorna uma lista de todos os registros de treinamento.
Localizar uma definição de campo personalizada por ID	Retorna uma única definição de campo personalizado.
UpdateAWebhook	Corrigir um Webhook

Atualizar um documento por id

ID da Operação:: PersonDocumentsById_PATCH

Atualizar um documento

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do documento	id	True	string	A cadeia de caracteres do identificador de recurso
personId	personId	True	string	A cadeia de caracteres de identificador para a Pessoa a quem este documento pertence.
uploadStatus	uploadStatus	True	string	O status de carregamento deste documento. Enum: `SUCCESS`, `PENDING`, `FAILED`.

Devoluções

PatchaPersonDocument: PatchaPersonDocument

Atualizar um registro de treinamento por ID

ID da Operação:: UpdateTrainingByID

Atualizar um registro de treinamento

Parâmetros

Name	Chave	Necessário	Tipo	Description
A ID do registo de formação	id	True	string	A cadeia de caracteres do identificador de recurso
id	id		string	A cadeia de caracteres de identificador para a Pessoa localizar no sistema.
nome	name		string	O nome da Pessoa em intelliHR para pesquisar. Observe que a pesquisa contabiliza as diferenças na ordem dos nomes automaticamente.
primaryEmailAddress	primaryEmailAddress		string	O endereço de e-mail sinalizado como principal para a Pessoa dentro do sistema.
Número do empregado	employeeNumber		string	Um número de funcionário inserido manualmente que identifica uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
autoIncrementIntellihrId	autoIncrementIntellihrId		string	Um número gerado automaticamente que identifica exclusivamente uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
Data de conclusão	completionDate		string	O carimbo de data/hora do treinamento foi concluído. Esta data seguirá o formato definido por RFC3339. YYYY-MM-DD formatação de data também é suportada, embora usando este formato a data será armazenada como o início do dia na hora UTC, não o fuso horário dos locatários solicitantes.
custo	cost		string	O custo desta Formação.
moeda	currency		string	A moeda utilizada para esta Formação. O padrão será a moeda padrão do locatário quando não for fornecido. Um código de moeda internacional. Normalmente AUD para dólar australiano, USD para dólar americano, etc. Consulte a lista oficial de códigos.
Horas	hours		string	Quantas horas foram gastas nesta Formação
id	id		string	A cadeia de caracteres de identificador para o trabalho para o qual este treinamento foi concluído.
nome	name		string	Nome amigável dado a este treinamento para identificá-lo no sistema.
id	id		string	A cadeia de caracteres de identificador para a Pessoa localizar no sistema.
nome	name		string	O nome da Pessoa em intelliHR para pesquisar. Observe que a pesquisa contabiliza as diferenças na ordem dos nomes automaticamente.
primaryEmailAddress	primaryEmailAddress		string	O endereço de e-mail sinalizado como principal para a Pessoa dentro do sistema.
Número do empregado	employeeNumber		string	Um número de funcionário inserido manualmente que identifica uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
autoIncrementIntellihrId	autoIncrementIntellihrId		string	Um número gerado automaticamente que identifica exclusivamente uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
id	id		string	A cadeia de caracteres identificador para o Provedor de Treinamento do Treinamento.
nome	name		string	Nome amigável dado ao Provedor de Treinamento do Treinamento.
id	id		string	A cadeia de caracteres identificador para o Tipo de treinamento do treinamento.
nome	name		string	Nome amigável dado ao Tipo de Treinamento do Treinamento.
customFields	customFields			Os valores de campo personalizado para este treinamento

Devoluções

SingleTraining: SingleTraining

Atualizar uma pessoa por ID

ID da Operação:: UpdatePersonByID

Atualizar uma pessoa

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do registo da pessoa	id	True	string	A cadeia de caracteres do identificador de recurso
primeiroNome	firstName		string	O primeiro nome da pessoa .
Nome do meio	middleName		string	O nome do meio da pessoa .
sobrenome	lastName		string	O sobrenome da pessoa.
preferredName	preferredName		string	O nome preferido da pessoa . Geralmente pode ser configurado por funcionários para si mesmos.
dateOfBirth	dateOfBirth		string	Data de nascimento (AAAA-MM-DD).
Género	gender		string	Corda legível por humanos para o sexo da Pessoa, por exemplo. `Male` A pesquisa é feita de forma insensível a maiúsculas e minúsculas e 'começa com', por exemplo, a passagem `male` corresponderá a um Género chamado "Masculino", assim como "m" ou "M". Se vários Gêneros corresponderem, o primeiro será escolhido.
Número do empregado	employeeNumber		string	Um número de funcionário inserido manualmente que identifica uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
title	title		string	O título para se referir a esta Pessoa como, por exemplo, "Sr". Isso é nulo se não for fornecido e não diferencia maiúsculas de minúsculas.
nome	name		string	O nome do contacto de emergência.
relação	relationship		string	A relação que este contacto de emergência tem com a Pessoa.
phone	phone		string	Número de telefone do contacto de emergência.
e-mail	email		string	E-mail do contato de emergência.
e-mail	email		string	O endereço de e-mail associado a esta pessoa.
isPessoal	isPersonal		boolean	Indica se este e-mail é pessoal ou profissional.
isPrimário	isPrimary		boolean	Indica se este e-mail é o e-mail de contato principal.
número	number		string	O número de telefone. Este número pode ser prefixado com um código de área. Quando isso acontece, o sistema tentará determinar automaticamente o país de origem do número de telefone
isPessoal	isPersonal		boolean	Indica se este telefone é pessoal ou um número de telefone de trabalho.
isPrimário	isPrimary		boolean	Indica se este telefone é o número de telefone de contato principal.
addressType	addressType		string	Enum: `Home`, `Postal`. O tipo de endereço.
Endereço completo	fullAddress		string	O endereço completo legível, menos o código postal e o país
country	country		string	O país em que o endereço se encontra.
código postal	postcode		string	O código postal do endereço.
state	state		string	O estado em que o endereço se encontra. Isso é específico da Austrália e nem sempre pode ser fornecido.
rua	street		string	A rua em que o endereço está. Isso é específico da Austrália e nem sempre pode ser fornecido.
subúrbio	suburb		string	O subúrbio em que o endereço está. Isso é específico da Austrália e nem sempre pode ser fornecido.
customFields	customFields		object	Os valores de campo personalizado para esta Pessoa
id	id		string	A cadeia de caracteres identificador para o Direito de Trabalho ao qual essa Pessoa pertence.
nome	name		string	O nome do Direito de Trabalho.
workRightExpiryDate	workRightExpiryDate		string	A data em que este Direito de Trabalho expirará para esta Pessoa (AAAA-MM-DD).

Devoluções

Solteiro: SinglePerson

Atualizar uma Unidade de Negócios por ID

ID da Operação:: UpdateaBusinessUnitbyID

Retorna a Unidade de Negócios atualizada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID da unidade de negócios	id	True	string	A cadeia de caracteres do identificador de recurso
identificador	identifier		string	Identificador opcional que pode ser usado para tarefas administrativas.
nome	name	True	string	Nome dado a esta Unidade de Negócio. Este nome seria normalmente mostrado aos utilizadores do sistema.
Observações	notes		string	Notas anexas a uma Unidade de Negócio
parentId	parentId		string	A cadeia de caracteres de identificador para a Unidade de Negócios pai, ou null se não houver pai (esta é uma unidade de negócios de nível superior).
isEnabled	isEnabled		boolean	Especifica se os usuários podem selecionar essa Unidade de Negócios em menus suspensos.

Devoluções

Resposta: Response

Corrigir um trabalho existente

ID da Operação:: PatchanexistingJob

Corrigir atributos de um registro de trabalho existente com os dados fornecidos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
A ID do trabalho	id	True	string	A cadeia de caracteres do identificador de recurso
effectiveFrom	effectiveFrom	True	string	A data em que esta atualização de emprego entra em vigor dentro da organização. Observe que isso não afeta a data de início do trabalho geral em si. Um `null` valor indicará que esta atualização está em vigor desde o início do trabalho. Esta data seguirá o formato definido por RFC3339. YYYY-MM-DD formatação de data também é suportada, embora usando este formato a data será armazenada como o início do dia na hora UTC, não o fuso horário dos locatários solicitantes.
eficazPara	effectiveTo		string	A data em que esta atualização de emprego entra em vigor dentro da organização. Observe que isso não afeta a data de término do trabalho geral em si. Esta data seguirá o formato definido por RFC3339. YYYY-MM-DD formatação de data também é suportada, embora usando este formato a data será armazenada como o início do dia na hora UTC, não o fuso horário dos locatários solicitantes.
nome	name		string	O nome do trabalho a ser atualizado
id	id		string	A cadeia de caracteres de identificador para a Entidade Comercial à qual este Trabalho pertence.
nome	name		string	Nome dado a esta Entidade Comercial. Este nome seria normalmente mostrado aos utilizadores do sistema.
legalNome	legalName		string	Denominação legal da Entidade Comercial. Geralmente usado para tarefas administrativas.
número	number		string	Número de Entidade Comercial legalmente registado, por exemplo, na Austrália pode ser o ABN, ou na América o RN.
id	id		string	A cadeia de caracteres de identificador para a Unidade de Negócios à qual este Trabalho pertence.
nome	name		string	Nome dado a esta Unidade de Negócio. Este nome seria normalmente mostrado aos utilizadores do sistema.
id	id		string	A cadeia de caracteres de identificador para a Pessoa localizar no sistema.
nome	name		string	O nome da Pessoa em intelliHR para pesquisar. Observe que a pesquisa contabiliza as diferenças na ordem dos nomes automaticamente.
primaryEmailAddress	primaryEmailAddress		string	O endereço de e-mail sinalizado como principal para a Pessoa dentro do sistema.
Número do empregado	employeeNumber		string	Um número de funcionário inserido manualmente que identifica uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
autoIncrementIntellihrId	autoIncrementIntellihrId		string	Um número gerado automaticamente que identifica exclusivamente uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
id	id		string	A cadeia de caracteres identificador para o Trabalho do Supervisor deste Trabalho.
nome	name		string	O nome/cargo do Cargo de Supervisor.
id	id		string	A cadeia de caracteres do identificador para o Local.
nome	name		string	Nome dado a este local. Este nome seria normalmente mostrado aos utilizadores do sistema.
address	address		string	O endereço deste local.
id	id		string	A cadeia de caracteres de identificador para a classe de trabalho à qual este trabalho pertence.
nome	name		string	O nome da Classe de Trabalho.
id	id		string	A cadeia de caracteres de identificador para o Tipo de Trabalho ao qual este Trabalho pertence.
nome	name		string	O nome do Tipo de Trabalho. Enum: `Permanent`, `Fixed Contract`, , `Unpaid`, `Independent ContractTemporary/Casual`.
ETI	fte		string	O equivalente a tempo inteiro deste Trabalho. Indicar a carga de trabalho de um funcionário que pode ser comparável em diferentes contextos. Isto é nulo para as pessoas sem um ETC.
id	id		string	A cadeia de caracteres do identificador para a Nota de Pagamento.
código	code		string	Código curto administrativo associado ao Grau de Remuneração.
nome	name		string	Nome amigável dado ao Pay Grade.
tipo	type		string	O método de pagamento desta tabela de remuneração. Enum: `Annual Salary`, `Hourly Rate`, `No Remuneration Schedule`.
payCycle [en]	payCycle	True	string	O ciclo em que o trabalho é pago. Enum: `Weekly`, `Fortnightly`, `Monthly`.
moeda	currency		string	A moeda em que a base e os valores totais que este trabalho está sendo pago. Um código de moeda internacional. Normalmente AUD para dólar australiano, USD para dólar americano, etc. Consulte a lista oficial de códigos.
id	id		string	A cadeia de caracteres identificador para a Condição de Emprego desta Tabela de Remuneração.
nome	name		string	Nome dado a esta Condição de Emprego.
awardName	awardName		string	O nome do prêmio pode ser diferente do nome apresentado a um usuário. Geralmente usado para o nome legal do prêmio.
horasPerCycle	hoursPerCycle	True	double	Quantas horas trabalhadas por salário.
baseAnualSalário	baseAnnualSalary		double	O Salário Base pago anualmente, este só é exigido se o Tipo de Tabela de Remunerações for "Salário Anual".
baseHourlyRate	baseHourlyRate		double	A Taxa Base paga por hora, esta só é necessária se o Tipo de Tabela de Remuneração for "Taxa Horária".
nome	name	True	string	O nome desta adição.
tipo	type	True	string	Como essa adição é calculada e aplicada ao valor base, MultipleOfBase é multiplicado por baseAnnualSalary e, em seguida, adicionado ao total, enquanto FixedAmount é adicionado diretamente ao total. Enum: `MultipleOfBase`, `FixedAmount`.
valor	value	True	string	Para MultipleOfBase, este é o multiplicador (por exemplo, 9 = 9%), enquanto para o montante fixo este é o montante a adicionar diretamente ao total.
moeda	currency		string	A moeda utilizada para esta adição. Um código de moeda internacional. Normalmente AUD para dólar australiano, USD para dólar americano, etc. Consulte a lista oficial de códigos.
id	id		string	A cadeia de caracteres do identificador para o componente de remuneração padrão.
nome	name		string	Nome da componente de remuneração por defeito.
nome	name	True	string	O nome desta adição.
tipo	type	True	string	Como essa adição é calculada e aplicada ao valor base, MultipleOfBase é multiplicado por baseAnnualSalary e, em seguida, adicionado ao total, enquanto FixedAmount é adicionado diretamente ao total. Enum: `MultipleOfBase`, `FixedAmount`.
valor	value	True	string	Para MultipleOfBase, este é o multiplicador (por exemplo, 9 = 9%), enquanto para o montante fixo este é o montante a adicionar diretamente ao total.
moeda	currency		string	A moeda utilizada para esta adição. Um código de moeda internacional. Normalmente AUD para dólar australiano, USD para dólar americano, etc. Consulte a lista oficial de códigos.
nome	name	True	string	O nome deste Breakdowns.
tipo	type	True	string	Como essa desagregação é calculada e aplicada ao valor base, MultipleOfBase é multiplicado por baseAnnualSalary e, em seguida, adicionado ao total, enquanto FixedAmount é adicionado diretamente ao total. Enum: `MultipleOfBase`, `FixedAmount`.
valor	value	True	string	Para MultipleOfBase, este é o multiplicador (por exemplo, 9 = 9%), enquanto para o montante fixo este é o montante a adicionar diretamente ao total.
moeda	currency		string	A moeda utilizada para esta desagregação. Um código de moeda internacional. Normalmente AUD para dólar australiano, USD para dólar americano, etc. Consulte a lista oficial de códigos.
id	id		string	A cadeia de caracteres do identificador para o componente de remuneração padrão.
nome	name		string	Nome da componente de remuneração por defeito.

Devoluções

SingleJob: SingleJob

Criar um novo registo de pessoa

ID da Operação:: CreateaPerson

Criar uma pessoa

Parâmetros

Name	Chave	Necessário	Tipo	Description
primeiroNome	firstName		string	O primeiro nome da pessoa .
Nome do meio	middleName		string	O nome do meio da pessoa .
sobrenome	lastName	True	string	O sobrenome da pessoa.
preferredName	preferredName		string	O nome preferido da pessoa . Geralmente pode ser configurado por funcionários para si mesmos.
dateOfBirth	dateOfBirth		string	Data de nascimento (AAAA-MM-DD).
Género	gender		string	Corda legível por humanos para o sexo da Pessoa, por exemplo. `Male` A pesquisa é feita de forma insensível a maiúsculas e minúsculas e 'começa com', por exemplo, a passagem `male` corresponderá a um Género chamado "Masculino", assim como "m" ou "M". Se vários Gêneros corresponderem, o primeiro será escolhido.
Número do empregado	employeeNumber		string	Um número de funcionário inserido manualmente que identifica uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
title	title		string	O título para se referir a esta Pessoa como, por exemplo, "Sr". Isso é nulo se não for fornecido e não diferencia maiúsculas de minúsculas.
nome	name		string	O nome do contacto de emergência.
relação	relationship		string	A relação que este contacto de emergência tem com a Pessoa.
phone	phone		string	Número de telefone do contacto de emergência.
e-mail	email		string	E-mail do contato de emergência.
e-mail	email		string	O endereço de e-mail real.
isPessoal	isPersonal		boolean	Indica se este e-mail é pessoal ou profissional.
número	number		string	O número de telefone real. Este número pode ser prefixado com um código de área. Quando isso acontece, o sistema tentará determinar automaticamente o país de origem do número de telefone
isPessoal	isPersonal		boolean	Indica se este telefone é pessoal ou um número de telefone de trabalho.
customFields	customFields		object	Os valores de campo personalizado para esta Pessoa
id	id		string	A cadeia de caracteres identificador para o Direito de Trabalho ao qual essa Pessoa pertence.
nome	name		string	O nome do Direito de Trabalho.
workRightExpiryDate	workRightExpiryDate		string	A data em que este Direito de Trabalho expirará para esta Pessoa (AAAA-MM-DD).

Devoluções

Solteiro: SinglePerson

Criar um novo trabalho

ID da Operação:: CreateanewJob

Crie um novo registro de trabalho com os dados fornecidos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id		string	A cadeia de caracteres de identificador para a Pessoa localizar no sistema.
nome	name		string	O nome da Pessoa em intelliHR para pesquisar. Observe que a pesquisa contabiliza as diferenças na ordem dos nomes automaticamente.
primaryEmailAddress	primaryEmailAddress		string	O endereço de e-mail sinalizado como principal para a Pessoa dentro do sistema.
Número do empregado	employeeNumber		string	Um número de funcionário inserido manualmente que identifica uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
autoIncrementIntellihrId	autoIncrementIntellihrId		string	Um número gerado automaticamente que identifica exclusivamente uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
empresaStartDate	companyStartDate	True	string	A data em que este trabalho começou ou começará dentro da organização. Esta data seguirá o formato definido por RFC3339. YYYY-MM-DD formatação de data também é suportada, embora usando este formato a data será armazenada como o início do dia na hora UTC, não o fuso horário dos locatários solicitantes.
empresaData de Fim	companyEndDate		string	A data em que este trabalho terminou ou terminará dentro da organização. Esta data seguirá o formato definido por RFC3339. YYYY-MM-DD formatação de data também é suportada, embora usando este formato a data será armazenada como o início do dia na hora UTC, não o fuso horário dos locatários solicitantes.
nome	name	True	string	O nome do trabalho a ser criado
id	id		string	A cadeia de caracteres de identificador para a Entidade Comercial à qual este Trabalho pertence.
nome	name		string	Nome dado a esta Entidade Comercial. Este nome seria normalmente mostrado aos utilizadores do sistema.
legalNome	legalName		string	Denominação legal da Entidade Comercial. Geralmente usado para tarefas administrativas.
número	number		string	Número de Entidade Comercial legalmente registado, por exemplo, na Austrália pode ser o ABN, ou na América o RN.
id	id		string	A cadeia de caracteres de identificador para a Unidade de Negócios à qual este Trabalho pertence.
nome	name		string	Nome dado a esta Unidade de Negócio. Este nome seria normalmente mostrado aos utilizadores do sistema.
id	id		string	A cadeia de caracteres de identificador para a Pessoa localizar no sistema.
nome	name		string	O nome da Pessoa em intelliHR para pesquisar. Observe que a pesquisa contabiliza as diferenças na ordem dos nomes automaticamente.
primaryEmailAddress	primaryEmailAddress		string	O endereço de e-mail sinalizado como principal para a Pessoa dentro do sistema.
Número do empregado	employeeNumber		string	Um número de funcionário inserido manualmente que identifica uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
autoIncrementIntellihrId	autoIncrementIntellihrId		string	Um número gerado automaticamente que identifica exclusivamente uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
id	id		string	A cadeia de caracteres identificador para o Trabalho do Supervisor deste Trabalho.
nome	name		string	O nome/cargo do Cargo de Supervisor.
id	id		string	A cadeia de caracteres do identificador para o Local.
nome	name		string	Nome dado a este local. Este nome seria normalmente mostrado aos utilizadores do sistema.
address	address		string	O endereço deste local.
id	id		string	A cadeia de caracteres de identificador para a classe de trabalho à qual este trabalho pertence.
nome	name		string	O nome da Classe de Trabalho.
id	id		string	A cadeia de caracteres de identificador para o Tipo de Trabalho ao qual este Trabalho pertence.
nome	name		string	O nome do Tipo de Trabalho. Enum: `Permanent`, `Fixed Contract`, , `Unpaid`, `Independent ContractTemporary/Casual`.
ETI	fte		string	O equivalente a tempo inteiro deste Trabalho. Indicar a carga de trabalho de um funcionário que pode ser comparável em diferentes contextos. Isto é nulo para as pessoas sem um ETC.
id	id		string	A cadeia de caracteres do identificador para a Nota de Pagamento.
código	code		string	Código curto administrativo associado ao Grau de Remuneração.
nome	name		string	Nome amigável dado ao Pay Grade.
tipo	type		string	O método de pagamento desta tabela de remuneração. Enum: `Annual Salary`, `Hourly Rate`, `No Remuneration Schedule`.
payCycle [en]	payCycle	True	string	O ciclo em que o trabalho é pago. Enum: `Weekly`, `Fortnightly`, `Monthly`.
moeda	currency		string	A moeda em que a base e os valores totais que este trabalho está sendo pago. Um código de moeda internacional. Normalmente AUD para dólar australiano, USD para dólar americano, etc. Consulte a lista oficial de códigos.
id	id		string	A cadeia de caracteres identificador para a Condição de Emprego desta Tabela de Remuneração.
nome	name		string	Nome dado a esta Condição de Emprego.
awardName	awardName		string	O nome do prêmio pode ser diferente do nome apresentado a um usuário. Geralmente usado para o nome legal do prêmio.
horasPerCycle	hoursPerCycle	True	double	Quantas horas trabalhadas por salário.
baseAnualSalário	baseAnnualSalary		double	O Salário Base pago anualmente, este só é exigido se o Tipo de Tabela de Remunerações for "Salário Anual".
baseHourlyRate	baseHourlyRate		double	A Taxa Base paga por hora, esta só é necessária se o Tipo de Tabela de Remuneração for "Taxa Horária".
nome	name	True	string	O nome desta adição.
tipo	type	True	string	Como essa adição é calculada e aplicada ao valor base, MultipleOfBase é multiplicado por baseAnnualSalary e, em seguida, adicionado ao total, enquanto FixedAmount é adicionado diretamente ao total. Enum: `MultipleOfBase`, `FixedAmount`.
valor	value	True	string	Para MultipleOfBase, este é o multiplicador (por exemplo, 9 = 9%), enquanto para o montante fixo este é o montante a adicionar diretamente ao total.
moeda	currency		string	A moeda utilizada para esta adição. Um código de moeda internacional. Normalmente AUD para dólar australiano, USD para dólar americano, etc. Consulte a lista oficial de códigos.
id	id		string	A cadeia de caracteres do identificador para o componente de remuneração padrão.
nome	name		string	Nome da componente de remuneração por defeito.
nome	name	True	string	O nome desta adição.
tipo	type	True	string	Como essa adição é calculada e aplicada ao valor base, MultipleOfBase é multiplicado por baseAnnualSalary e, em seguida, adicionado ao total, enquanto FixedAmount é adicionado diretamente ao total. Enum: `MultipleOfBase`, `FixedAmount`.
valor	value	True	string	Para MultipleOfBase, este é o multiplicador (por exemplo, 9 = 9%), enquanto para o montante fixo este é o montante a adicionar diretamente ao total.
moeda	currency		string	A moeda utilizada para esta adição. Um código de moeda internacional. Normalmente AUD para dólar australiano, USD para dólar americano, etc. Consulte a lista oficial de códigos.
nome	name	True	string	O nome deste Breakdowns.
tipo	type	True	string	Como essa desagregação é calculada e aplicada ao valor base, MultipleOfBase é multiplicado por baseAnnualSalary e, em seguida, adicionado ao total, enquanto FixedAmount é adicionado diretamente ao total. Enum: `MultipleOfBase`, `FixedAmount`.
valor	value	True	string	Para MultipleOfBase, este é o multiplicador (por exemplo, 9 = 9%), enquanto para o montante fixo este é o montante a adicionar diretamente ao total.
moeda	currency		string	A moeda utilizada para esta desagregação. Um código de moeda internacional. Normalmente AUD para dólar australiano, USD para dólar americano, etc. Consulte a lista oficial de códigos.
id	id		string	A cadeia de caracteres do identificador para o componente de remuneração padrão.
nome	name		string	Nome da componente de remuneração por defeito.
id	id		string	A cadeia de caracteres do identificador para a Fonte de Recrutamento.
nome	name		string	O nome dado a esta fonte de recrutamento.
custo	cost		double	O custo do recrutamento.
moeda	currency		string	A moeda utilizada para recrutar este emprego. Um código de moeda internacional. Normalmente AUD para dólar australiano, USD para dólar americano, etc. Consulte a lista oficial de códigos.

Devoluções

SingleJob: SingleJob

Criar um registro de treinamento

ID da Operação:: CreateaTraining

Criar um novo registro de treinamento

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id		string	A cadeia de caracteres de identificador para a Pessoa localizar no sistema.
nome	name		string	O nome da Pessoa em intelliHR para pesquisar. Observe que a pesquisa contabiliza as diferenças na ordem dos nomes automaticamente.
primaryEmailAddress	primaryEmailAddress		string	O endereço de e-mail sinalizado como principal para a Pessoa dentro do sistema.
Número do empregado	employeeNumber		string	Um número de funcionário inserido manualmente que identifica uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
autoIncrementIntellihrId	autoIncrementIntellihrId		string	Um número gerado automaticamente que identifica exclusivamente uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
Data de conclusão	completionDate	True	string	O carimbo de data/hora do treinamento foi concluído. Esta data seguirá o formato definido por RFC3339. YYYY-MM-DD formatação de data também é suportada, embora usando este formato a data será armazenada como o início do dia na hora UTC, não o fuso horário dos locatários solicitantes.
custo	cost		string	O custo desta Formação.
moeda	currency		string	A moeda utilizada para esta Formação. O padrão será a moeda padrão do locatário quando não for fornecido. Um código de moeda internacional. Normalmente AUD para dólar australiano, USD para dólar americano, etc. Consulte a lista oficial de códigos.
Horas	hours		string	Quantas horas foram gastas nesta Formação
id	id		string	A cadeia de caracteres de identificador para o trabalho para o qual este treinamento foi concluído.
nome	name	True	string	Nome amigável dado a este treinamento para identificá-lo no sistema.
id	id		string	A cadeia de caracteres de identificador para a Pessoa localizar no sistema.
nome	name		string	O nome da Pessoa em intelliHR para pesquisar. Observe que a pesquisa contabiliza as diferenças na ordem dos nomes automaticamente.
primaryEmailAddress	primaryEmailAddress		string	O endereço de e-mail sinalizado como principal para a Pessoa dentro do sistema.
Número do empregado	employeeNumber		string	Um número de funcionário inserido manualmente que identifica uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
autoIncrementIntellihrId	autoIncrementIntellihrId		string	Um número gerado automaticamente que identifica exclusivamente uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
id	id		string	A cadeia de caracteres identificador para o Provedor de Treinamento do Treinamento.
nome	name		string	Nome amigável dado ao Provedor de Treinamento do Treinamento.
id	id		string	A cadeia de caracteres identificador para o Tipo de treinamento do treinamento.
nome	name		string	Nome amigável dado ao Tipo de Treinamento do Treinamento.
customFields	customFields			Os valores de campo personalizado para este treinamento

Devoluções

SingleTraining: SingleTraining

Criar um URL de carregamento pré-assinado

ID da Operação:: PersonDocuments_POST

Criar um URL de carregamento pré-assinado

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id		string	A cadeia de caracteres de identificador para a Pessoa localizar no sistema.
nome	name		string	O nome da Pessoa em intelliHR para pesquisar. Observe que a pesquisa contabiliza as diferenças na ordem dos nomes automaticamente.
primaryEmailAddress	primaryEmailAddress		string	O endereço de e-mail sinalizado como principal para a Pessoa dentro do sistema.
Número do empregado	employeeNumber		string	Um número de funcionário inserido manualmente que identifica uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
autoIncrementIntellihrId	autoIncrementIntellihrId		string	Um número gerado automaticamente que identifica exclusivamente uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
filename	filename	True	string	O nome do arquivo original do documento. Isso será usado para o nome de exibição. Inclui extensão.
mime	mime	True	string	O tipo mime do documento
size	size	True	integer	O tamanho estimado do documento em bytes
extensão	extension	True	string	A extensão do documento, não incluindo o ponto

Devoluções

SinglePersonDocument: SinglePersonDocument

Criar uma nova Unidade de Negócio

ID da Operação:: CreateanewBusinessUnit

Retorna a Unidade de Negócios criada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
identificador	identifier		string	Identificador opcional que pode ser usado para tarefas administrativas.
nome	name	True	string	Nome dado a esta Unidade de Negócio. Este nome seria normalmente mostrado aos utilizadores do sistema.
Observações	notes		string	Notas anexas a uma Unidade de Negócio
parentId	parentId		string	A cadeia de caracteres de identificador para a Unidade de Negócios pai, ou null se não houver pai (esta é uma unidade de negócios de nível superior).
isEnabled	isEnabled		boolean	Especifica se os usuários podem selecionar essa Unidade de Negócios em menus suspensos.

Devoluções

Resposta: Response

Definir a data de término de um trabalho

ID da Operação:: EndJob

Definir a data de término de um trabalho

Parâmetros

Name	Chave	Necessário	Tipo	Description
A ID do trabalho a ser finalizado	id	True	string	A ID do trabalho a ser finalizado
data de término	endDate	True	string	data de término
volume de negóciosTipo	turnoverType	True	string	volume de negóciosTipo
volume de negóciosRazão	turnoverReason		string	volume de negóciosRazão

Devoluções

SingleJob: SingleJob

Encontrar um emprego por ID

ID da Operação:: FindaJobbyID

Obtenha um único registro de trabalho pelo identificador UUIDv4.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do trabalho a ser devolvido	id	True	string	A cadeia de caracteres do identificador de recurso
Retornar dados precisos para o trabalho nesta data	asAt		string	Usado para configurar a data para a qual retornar esses dados de trabalho, como um RFC3339 datetime. Todos os dados retornados dos pontos de extremidade de trabalho representam os valores dos atributos de trabalho da Pessoa em um ponto específico no tempo. Por padrão, o datetime atual é usado, mas esse parâmetro pode ser usado para configurar um datetime diferente para ver dados históricos.

Name

Chave

Necessário

Tipo

Description

O ID do trabalho a ser devolvido

True

string

A cadeia de caracteres do identificador de recurso

Retornar dados precisos para o trabalho nesta data

asAt

string

Usado para configurar a data para a qual retornar esses dados de trabalho, como um RFC3339 datetime.

Todos os dados retornados dos pontos de extremidade de trabalho representam os valores dos atributos de trabalho da Pessoa em um ponto específico no tempo.

Por padrão, o datetime atual é usado, mas esse parâmetro pode ser usado para configurar um datetime diferente para ver dados históricos.

Devoluções

SingleJob: SingleJob

Encontrar um registo de formação por ID

ID da Operação:: FindaTrainingbyID

Retorna um único registro de treinamento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
A ID do registo de formação	id	True	string	A cadeia de caracteres do identificador de recurso

Devoluções

SingleTraining: SingleTraining

Encontrar um tipo de trabalho por ID

ID da Operação:: FindaWorkTypebyID

Retorna um único tipo de trabalho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
A ID do tipo de trabalho	id	True	string	A cadeia de caracteres do identificador de recurso

Devoluções

SingleWorkType: SingleWorkType

Encontrar uma classe de trabalho por ID

ID da Operação:: FindaWorkClassbyID

Retorna uma única classe de trabalho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID da classe de trabalho	id	True	string	A cadeia de caracteres do identificador de recurso

Devoluções

SingleWorkClass: SingleWorkClass

Encontrar uma componente de remuneração por incumprimento por ID

ID da Operação:: FindaDefaultRemunerationComponentbyID

Devolve uma única componente de remuneração por defeito.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da componente remuneratória	id	True	string	A cadeia de caracteres do identificador de recurso

Devoluções

SingleDefaultRemunerationComponent: SingleDefaultRemunerationComponent

Encontrar uma entidade comercial por ID

ID da Operação:: FindaBusinessEntitybyID

Devolve uma única Entidade Empresarial pelo respetivo identificador.

Parâmetros

Name	Chave	Necessário	Tipo	Description
A cadeia de caracteres do identificador de recurso	id	True	string	A cadeia de caracteres do identificador de recurso

Devoluções

SingleBusinessEntity: SingleBusinessEntity

Encontrar uma pessoa por ID

ID da Operação:: FindaPersonbyID

Obtenha um único registro de Pessoa pelo identificador UUIDv4.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do registo da pessoa	id	True	string	O ID do registo da pessoa

Devoluções

Solteiro: SinglePerson

Encontre um evento Webhook por ID

ID da Operação:: FindaWebhookEventbyID

Retorna um único evento Webhook.

Parâmetros

Name	Chave	Necessário	Tipo	Description
A ID do evento webhook	id	True	string	A cadeia de caracteres do identificador de recurso

Devoluções

Evento Webhook único.

Webhook-Eventos: webhook-events

Encontre um Fornecedor de Formação por ID

ID da Operação:: FindaTrainingProviderbyID

Devolve um único Fornecedor de Formação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do organismo de formação	id	True	string	A cadeia de caracteres do identificador de recurso

Devoluções

SingleTrainingProvider: SingleTrainingProvider

Encontre um local por ID

ID da Operação:: FindaLocationbyID

Retorna um único local.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do local	id	True	string	A cadeia de caracteres do identificador de recurso

Devoluções

Localização única: SingleLocation

Encontre um tipo de treinamento por ID

ID da Operação:: FindaTrainingTypebyID

Retorna um único tipo de treinamento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do tipo de formação	id	True	string	A cadeia de caracteres do identificador de recurso

Devoluções

SingleTrainingTypes: SingleTrainingTypes

Encontre um trabalho certo por ID

ID da Operação:: FindaWorkRightbyID

Retorna um único trabalho direito.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do direito de trabalho	id	True	string	A cadeia de caracteres do identificador de recurso

Devoluções

SingleWorkRight: SingleWorkRight

Encontre um Webhook por ID

ID da Operação:: FindaWebhookbyID

Retorna um único webhook.

Parâmetros

Name	Chave	Necessário	Tipo	Description
A ID do webhook	id	True	string	A cadeia de caracteres do identificador de recurso

Devoluções

SingleWebhook: SingleWebhook

Encontre uma condição de emprego por ID

ID da Operação:: FindanEmploymentConditionbyID

Devolve uma única condição de emprego.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID da condição de emprego	id	True	string	A cadeia de caracteres do identificador de recurso

Devoluções

Condição de Emprego Único: SingleEmploymentCondition

Encontre uma fonte de recrutamento por ID

ID da Operação:: FindaRecruitmentSourcebyID

Devolve uma única fonte de recrutamento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID da fonte de recrutamento	id	True	string	A cadeia de caracteres do identificador de recurso

Devoluções

SingleRecruitmentSource: SingleRecruitmentSource

Encontre uma nota de pagamento por ID

ID da Operação:: FindaPayGradebyID

Devolve uma única nota salarial.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do grau salarial	id	True	string	A cadeia de caracteres do identificador de recurso

Devoluções

SinglePayGrade: SinglePayGrade

Encontre uma Unidade de Negócio por ID

ID da Operação:: FindaBusinessUnitbyID

Devolve uma única Unidade de Negócio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID da unidade de negócios	id	True	string	A cadeia de caracteres do identificador de recurso

Devoluções

Resposta: Response

Excluir um registro de treinamento por ID

ID da Operação:: DeleteaTrainingbyID

Exclui o registro de treinamento fornecido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
A ID do registo de formação	id	True	string	A cadeia de caracteres do identificador de recurso

Devoluções

response: string

Excluir um Webhook por ID

ID da Operação:: DeleteaWebhookbyID

Exclui o webhook fornecido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
A ID do webhook	id	True	string	A cadeia de caracteres do identificador de recurso

Devoluções

response: string

Excluir uma Unidade de Negócios por ID

ID da Operação:: DeleteaBusinessUnitbyID

Exclua uma Unidade de Negócios pelo ID fornecido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID da unidade de negócios	id	True	string	A cadeia de caracteres do identificador de recurso

Devoluções

response: string

Lista de todas as condições de emprego

ID da Operação:: Listallemploymentconditions

Devolve uma lista de todas as condições de emprego.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O número de itens por página	limit		integer	O número de itens por página
O número da página	page		integer	O número da página

Devoluções

Lista de Condições de Emprego: ListofEmploymentConditions

Listar todas as classes de trabalho

ID da Operação:: Listallworkclasses

Retorna uma lista de todas as classes de trabalho registradas no sistema.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O número de itens por página	limit		integer	O número de itens por página
O número da página	page		integer	O número da página

Devoluções

ListWorkClasses: ListWorkClasses

Listar todas as definições de campo personalizado

ID da Operação:: ListallCustomFieldDefinitions

Retorna uma lista de todas as definições de campo personalizado.

Parâmetros

Name	Chave	Tipo	Description
O número de itens por página	limit	integer	O número de itens por página
O número da página	page	integer	O número da página
Filtros a aplicar à consulta	filters	string	Os filtros podem ser aplicados na cadeia de caracteres de consulta para limitar os dados retornados desse ponto de extremidade. Os filtros são fornecidos no formato `filters[<filter_name>][<operation_type>]=<filter_value>`. Por exemplo, um filtro para obter itens correspondentes a um ID específico seria `filters[id][eq]=8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9`.

Devoluções

ListofCustomFieldDefinitions: ListofCustomFieldDefinitions

Listar todas as Entidades Comerciais

ID da Operação:: ListallBusinessEntities

Retorna uma lista de todas as Entidades Comerciais.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O número de itens por página	limit		integer	O número de itens por página
O número da página	page		integer	O número da página

Devoluções

Lista deEntidades Comerciais: ListofBusinessEntities

Listar todas as fontes de recrutamento

ID da Operação:: Listallrecruitmentsources

Devolve uma lista de todas as fontes de recrutamento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O número de itens por página	limit		integer	O número de itens por página
O número da página	page		integer	O número da página

Devoluções

ListadeRecrutamentoFontes: ListofRecruitmentSources

Listar todas as pessoas

ID da Operação:: Listallpeople

Retorna uma lista de todas as Pessoas na data atual.

Parâmetros

Name	Chave	Tipo	Description
O número de itens por página	limit	integer	O número de itens por página
O número da página	page	integer	O número da página
Filtros a aplicar à consulta	filters	string	Os filtros podem ser aplicados na cadeia de caracteres de consulta para limitar os dados retornados desse ponto de extremidade. Os filtros são fornecidos no formato `filters[<filter_name>][<operation_type>]=<filter_value>`. Por exemplo, um filtro para obter itens correspondentes a um ID específico seria `filters[id][eq]=8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9`.
Ordem de classificação a ser aplicada à consulta	sort	string	A classificação pode ser aplicada na cadeia de caracteres de consulta para ordenar os dados retornados desse ponto de extremidade. A classificação pode ser precedida de um menos para retornar os dados em ordem decrescente (-). Por exemplo, uma classificação para obter os registros mais recentes primeiro seria `-createdAt`.

Devoluções

ListaPessoas: ListPeople

Listar todas as Unidades de Negócio

ID da Operação:: ListallBusinessUnits

Devolve uma lista de todas as Unidades de Negócio registadas no sistema.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O número de itens por página	limit		integer	O número de itens por página
O número da página	page		integer	O número da página

Devoluções

Lista deUnidades de Negócio: ListofBusinessUnits

Listar todas as vagas

ID da Operação:: ListallJobs

Retorna uma lista de todos os registros da entidade Job na data atual.

Parâmetros

Name	Chave	Tipo	Description
O número de itens por página	limit	integer	O número de itens por página
O número da página	page	integer	O número da página
Filtros a aplicar à consulta	filters	string	Os filtros podem ser aplicados na cadeia de caracteres de consulta para limitar os dados retornados desse ponto de extremidade. Os filtros são fornecidos no formato `filters[<filter_name>][<operation_type>]=<filter_value>`. Por exemplo, um filtro para obter itens correspondentes a um ID específico seria `filters[id][eq]=8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9`.
Ordem de classificação a ser aplicada à consulta	sort	string	A classificação pode ser aplicada na cadeia de caracteres de consulta para ordenar os dados retornados desse ponto de extremidade. A classificação pode ser precedida de um menos para retornar os dados em ordem decrescente (-). Por exemplo, uma classificação para obter os registros mais recentes primeiro seria `-createdAt`.

Devoluções

ListJobs: ListJobs

Listar todos os componentes da remuneração padrão

ID da Operação:: ListallDefaultRemunerationComponents

Devolve uma lista de todas as Componentes de Remuneração por Incumprimento registadas no sistema.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O número de itens por página	limit		integer	O número de itens por página
O número da página	page		integer	O número da página

Devoluções

Lista deDefaultRemunerationComponents: ListofDefaultRemunerationComponents

Listar todos os direitos trabalhistas

ID da Operação:: ListallWorkRights

Retorna uma lista de todos os Direitos Trabalhistas registrados no sistema.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O número de itens por página	limit		integer	O número de itens por página
O número da página	page		integer	O número da página

Devoluções

Lista de Direitos de Trabalho: ListofWorkRights

Listar todos os graus salariais

ID da Operação:: Listallpaygrades

Devolve uma lista de todas as notas salariais.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O número de itens por página	limit		integer	O número de itens por página
O número da página	page		integer	O número da página

Devoluções

Lista de PayGrades: ListofPayGrades

Listar todos os locais

ID da Operação:: Listalllocations

Retorna uma lista de todos os locais.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O número de itens por página	limit		integer	O número de itens por página
O número da página	page		integer	O número da página

Devoluções

Listagens: Listlocations

Listar todos os Provedores de Treinamento

ID da Operação:: ListallTrainingProviders

Devolve uma lista de todos os Fornecedores de Formação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O número de itens por página	limit		integer	O número de itens por página
O número da página	page		integer	O número da página

Devoluções

ListallTrainingProviders: ListallTrainingProviders

Listar todos os tipos de trabalho

ID da Operação:: ListallWorkTypes

Retorna uma lista de todos os tipos de trabalho registrados no sistema.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O número de itens por página	limit		integer	O número de itens por página
O número da página	page		integer	O número da página

Devoluções

ListWorkTypes: ListWorkTypes

Listar todos os tipos de treinamento

ID da Operação:: ListallTrainingTypes

Retorna uma lista de todos os tipos de treinamento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
O número de itens por página	limit		integer	O número de itens por página
O número da página	page		integer	O número da página

Devoluções

ListallTrainingTypes: ListallTrainingTypes

Listar todos os treinamentos

ID da Operação:: ListallTrainings

Retorna uma lista de todos os registros de treinamento.

Parâmetros

Name	Chave	Tipo	Description
O número de itens por página	limit	integer	O número de itens por página
O número da página	page	integer	O número da página
Filtros a aplicar à consulta	filters	string	Os filtros podem ser aplicados na cadeia de caracteres de consulta para limitar os dados retornados desse ponto de extremidade. Os filtros são fornecidos no formato `filters[<filter_name>][<operation_type>]=<filter_value>`. Por exemplo, um filtro para obter itens correspondentes a um ID específico seria `filters[id][eq]=8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9`.
Ordem de classificação a ser aplicada à consulta	sort	string	A classificação pode ser aplicada na cadeia de caracteres de consulta para ordenar os dados retornados desse ponto de extremidade. A classificação pode ser precedida de um menos para retornar os dados em ordem decrescente (-). Por exemplo, uma classificação para obter os registros mais recentes primeiro seria `-createdAt`.

Devoluções

Lista deTreinamentos: ListofTrainings

Localizar uma definição de campo personalizada por ID

ID da Operação:: FindaCustomFieldDefinitionbyID

Retorna uma única definição de campo personalizado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
A ID do campo personalizado	id	True	string	A cadeia de caracteres do identificador de recurso

Devoluções

SingleCustomFieldDefinition: SingleCustomFieldDefinition

UpdateAWebhook

ID da Operação:: UpdateAWebhook

Corrigir um Webhook

Parâmetros

Name	Chave	Necessário	Tipo	Description
A ID do webhook	id	True	string	A cadeia de caracteres do identificador de recurso
URL	url		string	O ponto de extremidade Webhook para o qual a solicitação será enviada quando o evento Webhook inscrito for acionado.
webhookEvento	webhookEvent		string	A lesma do evento Webhook.
isEnabled	isEnabled		boolean	Especifica se os usuários podem selecionar esse Webhook. Quando desativado, este Webhook não será enviado.
origem	source		string	Uma string personalizável que pode ser usada para identificar qual sistema criou este Webhook. Webhooks criados através do aplicativo intelliHR terão fonte: 'custom'.

Devoluções

SingleWebhook: SingleWebhook

Acionadores

Crie um webhook e inscreva-se em um tipo de evento em seu locatário

ID da Operação:: CreateWebhook

Crie um webhook e inscreva-se em um tipo de evento em seu locatário

Parâmetros

Name	Chave	Necessário	Tipo	Description
webhookEvento	webhookEvent	True	string	webhookEvento
isEnabled	isEnabled		boolean	isEnabled
origem	source		string	origem

Devoluções

Name	Caminho	Tipo	Description
id	id	string	id
evento	event	string	evento
carimbo de data/hora	timestamp	string	carimbo de data/hora
Eu mesmo	links.self	string	Eu mesmo

Definições

SingleBusinessEntity

Name	Caminho	Tipo	Description
Entidade Empresarial	data	BusinessEntity

Lista deEntidades Comerciais

Name	Caminho	Tipo	Description
dados	data	array of BusinessEntity
Meta	meta	Meta	Contém meta-informações diversas sobre a resposta.
Links	links	Links	Links para outros recursos relacionados.

Resposta

Name	Caminho	Tipo	Description
Unidade de Negócio3	data	BusinessUnit3
Meta1	meta	Meta1	Contém meta-informações diversas sobre a resposta.

Lista deUnidades de Negócio

Name	Caminho	Tipo	Description
dados	data	array of BusinessUnit3
Meta2	meta	Meta2	Contém meta-informações diversas sobre a resposta.
Links	links	Links	Links para outros recursos relacionados.

SingleCustomFieldDefinition

Name	Caminho	Tipo	Description
CustomFieldDefinition	data	CustomFieldDefinition

ListofCustomFieldDefinitions

Name	Caminho	Tipo	Description
dados	data	array of CustomFieldDefinition
Meta	meta	Meta	Contém meta-informações diversas sobre a resposta.
Links	links	Links	Links para outros recursos relacionados.

SingleDefaultRemunerationComponent

Name	Caminho	Tipo	Description
DefaultRemunerationComponent	data	DefaultRemunerationComponent

Lista deDefaultRemunerationComponents

Name	Caminho	Tipo	Description
dados	data	array of DefaultRemunerationComponent
Meta	meta	Meta	Contém meta-informações diversas sobre a resposta.
Links	links	Links	Links para outros recursos relacionados.

Condição de Emprego Único

Name	Caminho	Tipo	Description
Condição de Emprego	data	EmploymentCondition

Lista de Condições de Emprego

Name	Caminho	Tipo	Description
dados	data	array of EmploymentCondition
Meta	meta	Meta	Contém meta-informações diversas sobre a resposta.
Links	links	Links	Links para outros recursos relacionados.

SingleJob

Name	Caminho	Tipo	Description
Meta1	meta	Meta1	Contém meta-informações diversas sobre a resposta.
Tarefa	data	Job

ListJobs

Name	Caminho	Tipo	Description
dados	data	array of Job
Meta8	meta	Meta8	Contém meta-informações diversas sobre a resposta.
Links	links	Links	Links para outros recursos relacionados.

Localização única

Name	Caminho	Tipo	Description
localização5	data	location5

Listagens

Name	Caminho	Tipo	Description
dados	data	array of location5
Meta	meta	Meta	Contém meta-informações diversas sobre a resposta.
Links	links	Links	Links para outros recursos relacionados.

SinglePayGrade

Name	Caminho	Tipo	Description
payGrade5	data	payGrade5

Lista de PayGrades

Name	Caminho	Tipo	Description
dados	data	array of payGrade5
Meta	meta	Meta	Contém meta-informações diversas sobre a resposta.
Links	links	Links	Links para outros recursos relacionados.

ListaPessoas

Name	Caminho	Tipo	Description
dados	data	array of data1
Meta	meta	Meta	Contém meta-informações diversas sobre a resposta.
Links	links	Links	Links para outros recursos relacionados.

Solteiro

Name	Caminho	Tipo	Description
dados1	data	data1

SinglePersonDocument

Name	Caminho	Tipo	Description
Dados3	data	Data3

PatchaPersonDocument

Name	Caminho	Tipo	Description
Dados4	data	Data4

SingleRecruitmentSource

Name	Caminho	Tipo	Description
recrutamentoFonte	data	recruitmentSource

ListadeRecrutamentoFontes

Name	Caminho	Tipo	Description
dados	data	array of recruitmentSource	Detalhes da fonte de recrutamento.
Meta	meta	Meta	Contém meta-informações diversas sobre a resposta.
Links	links	Links	Links para outros recursos relacionados.

SingleTrainingProvider

Name	Caminho	Tipo	Description
formaçãoFornecedores	data	trainingProviders

ListallTrainingProviders

Name	Caminho	Tipo	Description
dados	data	array of trainingProviders
Meta	meta	Meta	Contém meta-informações diversas sobre a resposta.
Links	links	Links	Links para outros recursos relacionados.

SingleTraining

Name	Caminho	Tipo	Description
Formação	data	Training

Lista deTreinamentos

Name	Caminho	Tipo	Description
dados	data	array of Training
Meta	meta	Meta	Contém meta-informações diversas sobre a resposta.
Links	links	Links	Links para outros recursos relacionados.

SingleTrainingTypes

Name	Caminho	Tipo	Description
formaçãoTipos	data	trainingTypes

ListallTrainingTypes

Name	Caminho	Tipo	Description
dados	data	array of trainingTypes
Meta	meta	Meta	Contém meta-informações diversas sobre a resposta.
Links	links	Links	Links para outros recursos relacionados.

SingleWorkClass

Name	Caminho	Tipo	Description
WorkClassesSchema	data	WorkClassesSchema

ListWorkClasses

Name	Caminho	Tipo	Description
dados	data	array of WorkClassesSchema
Meta	meta	Meta	Contém meta-informações diversas sobre a resposta.
Links	links	Links	Links para outros recursos relacionados.

SingleWorkRight

Name	Caminho	Tipo	Description
WorkRight2	data	WorkRight2

Lista de Direitos de Trabalho

Name	Caminho	Tipo	Description
dados	data	array of WorkRight2
Meta	meta	Meta	Contém meta-informações diversas sobre a resposta.
Links	links	Links	Links para outros recursos relacionados.

SingleWorkType

Name	Caminho	Tipo	Description
tipo de trabalho4	data	workType4

ListWorkTypes

Name	Caminho	Tipo	Description
dados	data	array of workType4
Meta	meta	Meta	Contém meta-informações diversas sobre a resposta.
Links	links	Links	Links para outros recursos relacionados.

Webhook-Eventos

Evento Webhook único.

Name	Caminho	Tipo	Description
Dados5	data	Data5

SingleWebhook

Name	Caminho	Tipo	Description
Dados7	data	Data7

Adição

Name	Caminho	Tipo	Description
nome	name	string	O nome desta adição.
tipo	type	string	Como essa adição é calculada e aplicada ao valor base, multipleOfBase é multiplicado por baseAnnualSalary e, em seguida, adicionado ao total, enquanto o valor fixo é adicionado diretamente ao total. Enum: `MultipleOfBase`, `FixedAmount`.
valor	value	double	Para multipleOfBase, este é o multiplicador (por exemplo, 9 = 9%), enquanto para o montante fixo este é o montante a adicionar diretamente ao total.
moeda	currency	string	A moeda utilizada para esta adição. Um código de moeda internacional. Normalmente AUD para dólar australiano, USD para dólar americano, etc. Consulte a lista oficial de códigos.

AdiçõesToTotal

Name	Caminho	Tipo	Description
nome	name	string	O nome desta Adição Total.
tipo	type	string	Como essa adição total é calculada e aplicada ao valor base, multipleOfBase é multiplicado por baseAnnualSalary e, em seguida, adicionado ao total, enquanto o valor fixo é adicionado diretamente ao total. Enum: `MultipleOfBase`, `FixedAmount`.
valor	value	double	Para multipleOfBase, este é o multiplicador (por exemplo, 9 = 9%), enquanto para o montante fixo este é o montante a adicionar diretamente ao total.
moeda	currency	string	A moeda utilizada para esta adição. Um código de moeda internacional. Normalmente AUD para dólar australiano, USD para dólar americano, etc. Consulte a lista oficial de códigos.

Address

Name	Caminho	Tipo	Description
addressType	addressType	string	O tipo de endereço.
Endereço completo	fullAddress	string	O endereço completo.
country	country	string	O país do endereço.
código postal	postcode	string	O código postal do endereço.
state	state	string	O estado do endereço.
rua	street	string	A rua em que o endereço está.
subúrbio	suburb	string	O subúrbio do endereço.

Desagregação

Name	Caminho	Tipo	Description
nome	name	string	O nome desta adição.
tipo	type	string	Como este acréscimo é registado, não é utilizado para calcular o pacote total devido, ao contrário de outras componentes da remuneração. Enum: `MultipleOfBase`, `FixedAmount`.
valor	value	double	Para multipleOfBase, este é o multiplicador (por exemplo, 9 = 9%), enquanto para o montante fixo este é o montante a adicionar diretamente ao total.
moeda	currency	string	A moeda utilizada para esta adição. Um código de moeda internacional. Normalmente AUD para dólar australiano, USD para dólar americano, etc. Consulte a lista oficial de códigos.

Entidade Empresarial

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres de identificador para a Entidade Comercial.
nome	name	string	Nome dado a esta Entidade Comercial. Este nome seria normalmente mostrado aos utilizadores do sistema.
legalNome	legalName	string	O nome legal pode ser diferente do nome apresentado a um utilizador. Geralmente usado para tarefas administrativas.
número	number	string	Número de Entidade Comercial legalmente registado, por exemplo, na Austrália pode ser o ABN, ou na América o RN.
isEnabled	isEnabled	boolean	Especifica se os usuários podem selecionar essa Entidade Comercial em listas suspensas.

Unidade de Negócio3

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres de identificador para a Unidade de Negócios.
identificador	identifier	string	Identificador opcional que pode ser usado para tarefas administrativas.
nome	name	string	Nome dado a esta Unidade de Negócio. Este nome seria normalmente mostrado aos utilizadores do sistema.
Observações	notes	string	Notas anexas a uma Unidade de Negócio
parentId	parentId	string	A cadeia de caracteres de identificador para a Unidade de Negócios pai, ou null se não houver pai (esta é uma unidade de negócios de nível superior).
isEnabled	isEnabled	boolean	Especifica se os usuários podem selecionar essa Unidade de Negócios em menus suspensos.

Entidade Comercial2

A Entidade Empresarial atual do Job no sistema.

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres de identificador para a Entidade Comercial deste Trabalho.
nome	name	string	Nome dado a esta Entidade Comercial. Este nome seria normalmente mostrado aos utilizadores do sistema.
ligação	link	string	Link na api pública para obter mais informações sobre este pedaço de dados.

Unidade de Negócio4

A atual Unidade de Negócios do Job no sistema.

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres de identificador para a Unidade de Negócios deste trabalho.
nome	name	string	Nome dado a esta Unidade de Negócio. Este nome seria normalmente mostrado aos utilizadores do sistema.
ligação	link	string	Link na api pública para obter mais informações sobre este pedaço de dados.

Coordenador

O Coordenador que fez a Formação. Esses dados são opcionais e serão nulos quando não forem armazenados.

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres identificador para o Coordenador do Treinamento.
nome de exibição	displayName	string	O nome da Pessoa que coordenou a Formação.
Número do empregado	employeeNumber	string	Um número de funcionário inserido manualmente que identifica uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
autoIncrementIntellihrId	autoIncrementIntellihrId	double	Um número gerado automaticamente que identifica exclusivamente uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
ligação	link	string	Link na api pública para obter mais informações sobre este pedaço de dados.

CustomFieldDefinition

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres de identificador para a definição de campo personalizado.
nome	name	string	Nome dado a esta definição de campo personalizado. Este nome seria normalmente mostrado aos utilizadores do sistema.
apiName	apiName	string	O nome da api dado a esta definição de campo personalizado. Esse nome é usado para identificar exclusivamente o campo personalizado na api e é usado como a chave ao modificar o campo personalizado em um registro.
descrição	description	string	A descrição desta definição de campo personalizado. Isso é usado como uma dica de ferramenta nas páginas de criação e atualização.
modelType	modelType	string	O modelo ao qual este campo personalizado se relaciona e ao qual pode ser anexado. Enum: `TRAINING`, `PERSON`.
tipo	type	string	O tipo de dados que este campo regista. Enum: `SINGLE_SELECT`, `MULTI_SELECT`, , `TEXT`, `PEOPLE_DROPDOWNNUMBER`.
definitions	definitions	object	Os valores desta chave mudam dependendo da chave "type". Ele é usado para armazenar informações adicionais pertinentes a essa chave. Para obter mais informações sobre configurações de campos personalizados, consulte nosso artigo da base de dados de conhecimento sobre campos personalizados

dados1

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres do identificador para a Pessoa.
nome de exibição	displayName	string	Nome a ser exibido em todo o sistema para esta Pessoa. Geralmente segue o padrão preferredName (firstName) lastName, mas pode ser configurado em toda a base de locatário para ser um formato diferente.
primeiroNome	firstName	string	O primeiro nome da pessoa .
Nome do meio	middleName	string	O nome do meio da pessoa .
sobrenome	lastName	string	O sobrenome da pessoa.
preferredName	preferredName	string	O nome preferido da pessoa . Geralmente pode ser configurado por funcionários para si mesmos.
dateOfBirth	dateOfBirth	string	Data de nascimento (AAAA-MM-DD).
Género	gender	string	Corda legível por humanos para o sexo da Pessoa , por exemplo, Masculino.
Número do empregado	employeeNumber	string	Um número de funcionário inserido manualmente que identifica uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
autoIncrementIntellihrId	autoIncrementIntellihrId	double	Um número gerado automaticamente que identifica exclusivamente uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
title	title	string	O título para se referir a esta Pessoa como, por exemplo, "Sr". Isso é nulo se não for fornecido.
endereços de e-mail	emailAddresses	array of EmailAddress	Uma matriz de endereços de e-mail que pertencem a esta Pessoa.
EmergênciaContato	emergencyContact	EmergencyContact	Os detalhes do contacto de emergência desta Pessoa .
situação laboral	employmentStatus	string	O estado atual destas Pessoas dentro da organização. Enum: `Current Staff`, `Exiting Staff`, , `No Job Records`, `Past Staff`, `Upcoming StaffReturning Staff`.
jobs	jobs	array of Job4	Uma matriz de entradas de trabalho simples associadas a esta Pessoa em ordem cronológica inversa da data de início.
Direitos laborais	workRights	WorkRights	Mostrar os direitos laborais da pessoa
PrincipalEmailAddress1	primaryEmailAddress	PrimaryEmailAddress1	Informações sobre o endereço de e-mail principal desta Pessoa, ou nulas se não tiverem informações de e-mail.
Número de telefone primário1	primaryPhoneNumber	PrimaryPhoneNumber1	Informações sobre o número de telefone principal desta Pessoa, ou nulo se ela não tiver números de telefone.
addresses	addresses	array of Address	Uma matriz de endereços que pertencem a esta Pessoa.
Números de telefone	phoneNumbers	array of PhoneNumber	Uma matriz de números de telefone que pertencem a esta Pessoa.
criadosAt	createdAt	string	Quando este registo foi criado. Esta data seguirá o formato definido por RFC3339.
atualizadoem	updatedAt	string	Quando este registo foi atualizado pela última vez. Esta data seguirá o formato definido por RFC3339.

Dados3

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres de identificador para o Documento de Pessoa.
personId	personId	string	A cadeia de caracteres de identificador para a Pessoa a quem este documento pertence.
pré-assinadoUploadUrl	presignedUploadUrl	string	O URL de carregamento pré-assinado que lhe permite carregar um Documento Pessoal para o S3. Este link expirará 20 minutos após a criação. Instruções sobre como carregar um objeto com um URL S3 pré-assinado podem ser encontradas aqui

Dados4

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres de identificador para o Documento de Pessoa.
personId	personId	string	A cadeia de caracteres de identificador para a Pessoa a quem este documento pertence.
uploadStatus	uploadStatus	string	O status de carregamento deste documento. Enum: `SUCCESS`, `PENDING`, `FAILED`.

Dados5

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres de identificador para o evento Webhook.
nome	name	string	A chave de evento única legível por humanos para este Evento Webhook.
evento	event	string	A lesma do evento Webhook.
exemploCarga útil	examplePayload	object	Um exemplo da carga útil que será enviada para Webhooks que subscrevem este Evento Webhook específico.

Dados7

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres de identificador para o Webhook.
URL	url	string	O ponto de extremidade Webhook para o qual a solicitação será enviada quando o evento Webhook inscrito for acionado.
WebhookEvento	webhookEvent	WebhookEvent	O evento Webhook que acionou este Webhook.
isEnabled	isEnabled	boolean	Especifica se os usuários podem selecionar esse Webhook. Quando desativado, este Webhook não será enviado.
origem	source	string	Uma string personalizável que pode ser usada para identificar qual sistema criou este Webhook. Webhooks criados através do aplicativo intelliHR terão fonte: 'custom'.
criadosAt	createdAt	string	Quando este registo foi criado. Esta data seguirá o formato definido por RFC3339.
atualizadoem	updatedAt	string	Quando este registo foi atualizado pela última vez. Esta data seguirá o formato definido por RFC3339.

Dedução

Name	Caminho	Tipo	Description
nome	name	string	O nome desta dedução.
tipo	type	string	Como esta dedução é calculada e aplicada ao valor base, multipleOfBase é multiplicado por baseAnnualSalary e, em seguida, deduzido do total, enquanto o montante fixo é deduzido diretamente do total. Enum: `MultipleOfBase`, `FixedAmount`.
valor	value	double	Para multipleOfBase, este é o multiplicador, enquanto para o montante fixo este é o montante a deduzir diretamente do total.
moeda	currency	string	A moeda utilizada para esta dedução. Um código de moeda internacional. Normalmente AUD para dólar australiano, USD para dólar americano, etc. Consulte a lista oficial de códigos.

DefaultRemunerationComponent

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres identificador para o componente de remuneração padrão.
nome	name	string	Nome dado a esta Componente de Remuneração por Incumprimento. Este nome seria normalmente mostrado aos utilizadores do sistema.
valor	value	string	O valor desta componente remuneratória. Para multipleOfBase, este é o multiplicador, enquanto para o montante fixo este é o montante a adicionar diretamente ao total.
isInUse	isInUse	boolean	Se esta Componente de Remuneração por Incumprimento é utilizada como qualquer componente de remuneração.
automaticamenteAddToJobs	automaticallyAddToJobs	boolean	Se este Componente de Remuneração Inadimplente é adicionado automaticamente aos trabalhos recém-criados/atualizados.
isEnabled	isEnabled	boolean	Se este Componente de Remuneração Padrão estiver habilitado para uso no sistema.
moeda	currency	string	A moeda utilizada para esta componente de remuneração por defeito. Um código de moeda internacional. Normalmente AUD para dólar australiano, USD para dólar americano, etc. Consulte a lista oficial de códigos.
tipo	type	string	O tipo desta Componente de Remuneração por Incumprimento. Enum: `AdditionToBase`, `AdditionToTotal`, `DeductionToBase`, `Breakdown`.
valueType	valueType	string	O tipo de valor desta Componente de Remuneração por Incumprimento. Enum: `MultipleOfBase`, `FixedAmount`.

Endereço de Email

Name	Caminho	Tipo	Description
e-mail	email	string	O endereço de e-mail real.
isPrimário	isPrimary	boolean	Se este for um endereço de e-mail principal.
isPessoal	isPersonal	boolean	Se este for um endereço de e-mail pessoal.

EmergênciaContato

Os detalhes do contacto de emergência desta Pessoa .

Name	Caminho	Tipo	Description
nome	name	string	O nome do contacto de emergência.
relação	relationship	string	A relação que este contacto de emergência tem com a Pessoa.
phone	phone	string	Número de telefone do contacto de emergência.
e-mail	email	string	E-mail do contato de emergência.

Condição de Emprego

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres identificador para a Condição de Emprego.
nome	name	string	Nome dado a esta Condição de Emprego. Este nome seria normalmente mostrado aos utilizadores do sistema.
awardName	awardName	string	O nome do prêmio pode ser diferente do nome apresentado a um usuário. Geralmente usado para o nome legal do prêmio.
isEnabled	isEnabled	boolean	Especifica se os usuários podem selecionar essa Condição de Emprego em listas suspensas.

Condição de emprego2

A condição de emprego sob a qual este trabalho está sendo pago.

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres identificador para a Condição de Emprego desta Tabela de Remuneração.
nome	name	string	Nome dado a esta Condição de Emprego. Este nome seria normalmente mostrado aos utilizadores do sistema.
awardName	awardName	string	O nome do prêmio pode ser diferente do nome apresentado a um usuário. Geralmente usado para o nome legal do prêmio.
ligação	link	string	Link na api pública para obter mais informações sobre este pedaço de dados.

Tarefa

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres de identificador para o trabalho.
Pessoa	person	Person	A Pessoa a quem pertence este Trabalho .
Recrutamento	recruitment	Recruitment	Os detalhes de recrutamento armazenados para este Trabalho.
Localização	location	Location	A localização geográfica deste Trabalho.
Classificação Remuneratória	payGrade	PayGrade	A Classificação Salarial atual do Emprego no sistema.
Unidade de Negócio4	businessUnit	BusinessUnit4	A atual Unidade de Negócios do Job no sistema.
Entidade Comercial2	businessEntity	BusinessEntity2	A Entidade Empresarial atual do Job no sistema.
SupervisorJob	supervisorJob	SupervisorJob	As informações de trabalho para o supervisor deste trabalho ou nulas se eles não tiverem supervisor.
SupervisorPessoa	supervisorPerson	SupervisorPerson	As informações da Pessoa para o supervisor deste trabalho ou nulas se não tiverem supervisor.
RemuneraçãoCalendário	remunerationSchedule	RemunerationSchedule	Os detalhes de remuneração atuais para este Trabalho, incluindo informações como salário e pagamento por hora, todos os Empregos têm um cronograma de remuneração, mas para funcionários não remunerados eles terão um horário especial `No Remuneration Schedule` .
nome	name	string	O nome/cargo deste Cargo.
ETI	fte	number	O equivalente a tempo inteiro deste Trabalho. Indicar a carga de trabalho de um funcionário que pode ser comparável em diferentes contextos. Isto é nulo para as pessoas sem um ETC.
Classe de trabalho	workClass	string	A Classe Operária deste Trabalho. Estes são detalhes adicionais sobre o Tipo de Trabalho.
tipo de trabalho	workType	string	Esta é a Classificação de Trabalho para este Trabalho, é usada para diferenciar entre funcionários a tempo inteiro e a tempo parcial vs voluntários não remunerados. Enum: `Permanent`, `Fixed Contract`, , `Unpaid`, `Independent ContractTemporary/Casual`.
situação do emprego	jobStatus	string	O estado atual deste trabalho dentro desta organização. Enum: `Past Job`, `Future Job`, `Ending Job`, `Current Job`.
empresaStartDate	companyStartDate	string	A data em que este trabalho começou ou começará dentro da organização. Esta data seguirá o formato definido por RFC3339.
empresaData de Fim	companyEndDate	string	A data em que este Trabalho terminou ou terminará dentro da organização ou será nula se não houver uma data de término. Esta data seguirá o formato definido por RFC3339.
isEndDateConfirmed	isEndDateConfirmed	boolean	Se a data final foi finalizada dentro do aplicativo intelliHR.
volume de negóciosTipo	turnoverType	string	O tipo de volume de negócios em que este fim de trabalho é classificado.
volume de negóciosRazão	turnoverReason	string	O nome do motivo do volume de negócios.
criadosAt	createdAt	string	Quando este registo foi criado. Esta data seguirá o formato definido por RFC3339.

Emprego4

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres de identificador para o trabalho.
nome	name	string	O nome/cargo deste Cargo.
startDate	startDate	string	A data em que este trabalho começou ou começará dentro da organização. Esta data seguirá o formato definido por RFC3339.
data de término	endDate	string	A data em que este Trabalho terminou ou terminará dentro da organização ou será nula se não houver uma data de término. Esta data seguirá o formato definido por RFC3339.
situação do emprego	jobStatus	string	O estado atual deste trabalho dentro desta organização. Enum: `Past Job`, `Future Job`, `Ending Job`, `Current Job`.
ligação	link	string	Link na api pública para obter mais informações sobre este pedaço de dados.

Emprego7

O Trabalho da Pessoa que fez o Treinamento.

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres de identificador para o trabalho do treinamento.
nome	name	string	O nome do Persons Job que fez o Treinamento.
startDate	startDate	string	A data de início efetivo dos trabalhos . Esta data seguirá o formato definido por RFC3339.
data de término	endDate	string	A data de término efetiva dos Jobs . Esta data seguirá o formato definido por RFC3339.
situação do emprego	jobStatus	string	O esquema de status. Enum: `Past Job`, `Future Job`, `Ending Job`, `Current Job`.
ligação	link	string	Link na api pública para obter mais informações sobre este pedaço de dados.

Links

Links para outros recursos relacionados.

Name	Caminho	Tipo	Description
Eu mesmo	self	string	O URL da página atual
primeiro	first	string	O URL da primeira página
anterior	prev	string	O URL da página anterior
next	next	string	O URL da página seguinte
último	last	string	O URL da última página

Localização

A localização geográfica deste Trabalho.

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres de identificador para o local deste trabalho.
nome	name	string	Nome dado a este local. Este nome seria normalmente mostrado aos utilizadores do sistema.
address	address	string	O endereço deste local.
ligação	link	string	Link na api pública para obter mais informações sobre este pedaço de dados.

localização5

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres do identificador para o Local.
parentId	parentId	string	A cadeia de caracteres identificador para o Local pai, ou null se não houver pai (este é um local de nível superior).
nome	name	string	Nome dado a este local. Este nome seria normalmente mostrado aos utilizadores do sistema.
address	address	string	O endereço deste local.
isEnabled	isEnabled	boolean	Especifica se os usuários podem selecionar esse local em listas suspensas.

Meta1

Contém meta-informações diversas sobre a resposta.

Name	Caminho	Tipo	Description
asAt	asAt	string	O momento para o qual esta resposta se destina. Esta data seguirá o formato definido por RFC3339.

Meta2

Contém meta-informações diversas sobre a resposta.

Name	Caminho	Tipo	Description
asAt	asAt	string	O momento para o qual esta resposta se destina. Esta data seguirá o formato definido por RFC3339.
Paginação	pagination	Pagination	Contém informações relacionadas com a paginação da resposta

Meta8

Contém meta-informações diversas sobre a resposta.

Name	Caminho	Tipo	Description
asAt	asAt	string	O momento em que os dados desta resposta são precisos. Esta data seguirá o formato definido por RFC3339.
Paginação	pagination	Pagination	Contém informações relacionadas com a paginação da resposta

Paginação

Contém informações relacionadas com a paginação da resposta

Name	Caminho	Tipo	Description
total	total	integer	Contagem total de itens
count	count	integer	Número de itens para a página atual
per_page	per_page	integer	Limite de itens por página
current_page	current_page	integer	Página atual
total_pages	total_pages	integer	Número total de páginas

Classificação Remuneratória

A Classificação Salarial atual do Emprego no sistema.

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres identificador para a Classificação Salarial deste Trabalho.
nome	name	string	Nome amigável dado ao Pay Grade.
código	code	string	Código curto administrativo associado ao Grau de Remuneração.
ligação	link	string	Link na api pública para obter mais informações sobre este pedaço de dados.

payGrade5

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres do identificador para a Nota de Pagamento.
código	code	string	Código curto administrativo associado ao Grau de Remuneração.
nome	name	string	Nome amigável dado ao Pay Grade.
isEnabled	isEnabled	boolean	Especifica se os usuários podem selecionar essa Nota de pagamento em listas suspensas.

Pessoa

A Pessoa a quem pertence este Trabalho .

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres de identificador para a Pessoa a quem este Trabalho pertence.
nome de exibição	displayName	string	Nome a ser exibido em todo o sistema para esta Pessoa. Geralmente segue o padrão preferredName (firstName) lastName, mas pode ser configurado em toda a base de locatário para ser um formato diferente.
Número do empregado	employeeNumber	string	Um número de funcionário inserido manualmente que identifica uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
autoIncrementIntellihrId	autoIncrementIntellihrId	double	Um número gerado automaticamente que identifica exclusivamente uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
ligação	link	string	Link na api pública para obter mais informações sobre este pedaço de dados.

Pessoa7

A Pessoa que fez o Treinamento.

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres identificador para a Pessoa do Treinamento.
nome de exibição	displayName	string	O nome da Pessoa que fez o Treinamento.
Número do empregado	employeeNumber	string	Um número de funcionário inserido manualmente que identifica uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
autoIncrementIntellihrId	autoIncrementIntellihrId	double	Um número gerado automaticamente que identifica exclusivamente uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
ligação	link	string	Link na api pública para obter mais informações sobre este pedaço de dados.

Número de telefone

Name	Caminho	Tipo	Description
número	number	string	O número de telefone real.
Número completo	fullNumber	string	O número de telefone real com o código de área (se registrado).
isPrimário	isPrimary	boolean	Se este for um número de telefone principal.
isPessoal	isPersonal	boolean	Se este for um número de telefone pessoal.

PrincipalEmailAddress1

Informações sobre o endereço de e-mail principal desta Pessoa, ou nulas se não tiverem informações de e-mail.

Name	Caminho	Tipo	Description
e-mail	email	string	O endereço de e-mail real.
isPessoal	isPersonal	boolean	Indica se este e-mail é pessoal ou profissional.

Número de telefone primário1

Informações sobre o número de telefone principal desta Pessoa, ou nulo se ela não tiver números de telefone.

Name	Caminho	Tipo	Description
número	number	string	O número de telefone real.
Número completo	fullNumber	string	O número de telefone real com o código de área (se registrado).
isPessoal	isPersonal	boolean	Indica se este número de telefone é pessoal ou profissional.

Provider

A entidade formadora da formação.

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres identificador para o Provedor de Treinamento do Treinamento.
nome	name	string	Nome amigável dado ao Provedor de Treinamento do Treinamento.
ligação	link	string	Link na api pública para obter mais informações sobre este pedaço de dados.

Recrutamento

Os detalhes de recrutamento armazenados para este Trabalho.

Name	Caminho	Tipo	Description
custo	cost	number	O custo para recrutar este emprego. Se for nulo, o custo não foi registado.
moeda	currency	string	A moeda utilizada para recrutar este emprego. Um código de moeda internacional. Normalmente AUD para dólar australiano, USD para dólar americano, etc. Consulte a lista oficial de códigos.
Fonte	source	Source	A Fonte de Recrutamento da qual este trabalho foi originado ou nulo se não tiver sido registrado.

recrutamentoFonte

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres do identificador para a Fonte de Recrutamento.
nome	name	string	O nome dado a esta fonte de recrutamento.
parentId	parentId	string	A cadeia de caracteres identificador para a Fonte de Recrutamento pai, ou nula se não houver pai (esta é uma fonte de recrutamento de nível superior).
isEnabled	isEnabled	boolean	Especifica se os usuários podem selecionar essa Fonte de recrutamento em listas suspensas.

RemuneraçãoCalendário

Os detalhes de remuneração atuais para este Trabalho, incluindo informações como salário e pagamento por hora, todos os Empregos têm um cronograma de remuneração, mas para funcionários não remunerados eles terão um horário especial No Remuneration Schedule .

Name	Caminho	Tipo	Description
tipo	type	string	O método em que esta tabela de remuneração é paga, se uma pessoa não é paga, então isso será `No Remuneration Schedule`. Enum: `Annual Salary`, `Hourly Rate`, `No Remuneration Schedule`.
baseAnualSalário	baseAnnualSalary	double	O Salário Base pago anualmente, esta é uma aproximação se forem pagos por hora. Observe que se baseAnnualSalary e baseHourlyRate forem fornecidos em uma solicitação de criação ou patch, a baseHourlyRate será ignorada.
baseHourlyRate	baseHourlyRate	double	A Taxa Base paga por hora, esta é uma aproximação se forem pagas anualmente. Observe que se baseAnnualSalary e baseHourlyRate forem fornecidos em uma solicitação de criação ou patch, a baseHourlyRate será ignorada.
moeda	currency	string	A moeda em que a base e os valores totais que este trabalho está sendo pago. Um código de moeda internacional. Normalmente AUD para dólar australiano, USD para dólar americano, etc. Consulte a lista oficial de códigos.
horasPerCycle	hoursPerCycle	double	Quantas horas trabalhadas por salário.
payCycle [en]	payCycle	string	O ciclo em que o trabalho é pago. Enum: `Weekly`, `Fortnightly`, `Monthly`.
pacote anual	annualPackage	double	O pacote total pago anualmente, incluindo adições e deduções. Este valor é calculado adicionando o Salário Base Anual e os acréscimos menos as deduções.
hourlyPackage	hourlyPackage	double	O pacote total pago por hora, incluindo adições e deduções. Este valor é calculado dividindo o Pacote Anual pelo número total de horas por ano.
currencyConversionOccurred	currencyConversionOccurred	boolean	Se tiver de ser efetuada qualquer conversão entre as moedas de adição e de dedução no cálculo do pacote anual.
Condição de emprego2	employmentCondition	EmploymentCondition2	A condição de emprego sob a qual este trabalho está sendo pago.
adições	additions	array of Addition	Uma série de Adições para esta Tabela de Remuneração.
deduções	deductions	array of Deduction	Uma série de deduções para esta tabela de remuneração.
adiçõesToTotal	additionsToTotal	array of AdditionsToTotal	Uma matriz de Adições aplicadas ao pacote após todos os outros componentes desta Tabela de Remuneração.
avarias	breakdowns	array of Breakdown	Uma série de detalhamentos para esta Tabela de Remuneração. As avarias não serão utilizadas para calcular o pacote total.

Fonte

A Fonte de Recrutamento da qual este trabalho foi originado ou nulo se não tiver sido registrado.

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres identificador para a Fonte de Recrutamento deste Trabalho.
nome	name	string	O nome dado a esta Fonte de Recrutamento.
ligação	link	string	Link na api pública para obter mais informações sobre este pedaço de dados.

SupervisorJob

As informações de trabalho para o supervisor deste trabalho ou nulas se eles não tiverem supervisor.

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres identificador para o Trabalho do Supervisor deste Trabalho.
situação do emprego	jobStatus	string	O estado atual deste trabalho dentro desta organização. Enum: `Past Job`, `Future Job`, `Ending Job`, `Current Job`.
nome	name	string	O nome/cargo do Cargo de Supervisor.
ligação	link	string	Link na api pública para obter mais informações sobre este pedaço de dados.

SupervisorPessoa

As informações da Pessoa para o supervisor deste trabalho ou nulas se não tiverem supervisor.

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres identificador para a Pessoa do Supervisor deste Trabalho.
nome de exibição	displayName	string	Nome a ser exibido em todo o sistema para esta Pessoa. Geralmente segue o padrão preferredName (firstName) lastName, mas pode ser configurado em toda a base de locatário para ser um formato diferente.
Número do empregado	employeeNumber	string	Um número de funcionário inserido manualmente que identifica uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
autoIncrementIntellihrId	autoIncrementIntellihrId	double	Um número gerado automaticamente que identifica exclusivamente uma Pessoa no intelliHR. Ele pode estar oculto na interface do usuário do sistema, dependendo da configuração do seu locatário.
ligação	link	string	Link na api pública para obter mais informações sobre este pedaço de dados.

Formação

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres de identificador para o Treinamento.
nome	name	string	Nome amigável dado a este Treinamento.
Pessoa7	person	Person7	A Pessoa que fez o Treinamento.
Emprego7	job	Job7	O Trabalho da Pessoa que fez o Treinamento.
Coordenador	coordinator	Coordinator	O Coordenador que fez a Formação. Esses dados são opcionais e serão nulos quando não forem armazenados.
Horas	hours	string	Quantas horas foram gastas nesta Formação.
moeda	currency	string	A moeda utilizada para este [Treinamento](#tag/Treinamentos. Um código de moeda internacional. Normalmente AUD para dólar australiano, USD para dólar americano, etc. Consulte a lista oficial de códigos.
custo	cost	string	O custo desta Formação.
Provider	provider	Provider	A entidade formadora da formação.
Tipo	type	Type	O tipo de formação da formação.
Data de conclusão	completionDate	string	O carimbo de data/hora do treinamento foi concluído. Esta data seguirá o formato definido por RFC3339.
criadosAt	createdAt	string	Quando este registo foi criado. Esta data seguirá o formato definido por RFC3339.
atualizadoem	updatedAt	string	Quando este registo foi atualizado pela última vez. Esta data seguirá o formato definido por RFC3339.

formaçãoFornecedores

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres de identificador para o Provedor de Treinamento.
nome	name	string	Nome amigável dado ao Provedor de Treinamento.
isDefault	isDefault	boolean	Indica se esse Provedor de Treinamento será usado como padrão ao criar um registro de Treinamento .

formaçãoTipos

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres identificador para o Tipo de treinamento.
nome	name	string	Nome amigável dado ao Tipo de Treinamento.
isDefault	isDefault	boolean	Indica se esse Tipo de treinamento será usado como padrão ao criar um registro de treinamento .

Tipo

O tipo de formação da formação.

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres identificador para o Tipo de treinamento do treinamento.
nome	name	string	Nome amigável dado ao Tipo de Treinamento do Treinamento.
ligação	link	string	Link na api pública para obter mais informações sobre este pedaço de dados.

WebhookEvento

O evento Webhook que acionou este Webhook.

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres de identificador para o evento Webhook.
nome	name	string	A chave de evento única legível por humanos para este Evento Webhook.
evento	event	string	A lesma do evento Webhook.
ligação	link	string	Link na api pública para obter mais informações sobre este pedaço de dados.

WorkClassesSchema

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres identificador para a Classe de Trabalho.
nome	name	string	Nome dado a esta Classe de Trabalho. Este nome seria normalmente mostrado aos utilizadores do sistema.
Tipo de Trabalho2	workType	WorkType2	O Tipo de Trabalho pai desta Classe de Trabalho.
isEnabled	isEnabled	boolean	Especifica se os usuários podem selecionar esse Tipo de Trabalho em menus suspensos.

WorkRight2

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres de identificador para o Direito de Trabalho.
nome	name	string	Nome dado a este Direito de Trabalho. Este nome seria normalmente mostrado aos utilizadores do sistema.
paísId	countryId	string	A cadeia de caracteres do identificador para o País.
country	country	string	O valor do nome do País atribuído.

Direitos laborais

Mostrar os direitos laborais da pessoa

Name	Caminho	Tipo	Description
nome	name	string	O tipo de direitos laborais
country	country	string	O país onde os direitos laborais são válidos
Data de expiração	expirationDate	string	A data de expiração dos direitos laborais

Tipo de Trabalho2

O Tipo de Trabalho pai desta Classe de Trabalho.

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres de identificador para o Tipo de Trabalho desta Classe de Trabalho.
nome	name	string	O nome do Tipo de Trabalho. Enum: `Permanent`, `Fixed Contract`, , `Unpaid`, `Independent ContractTemporary/Casual`.
ligação	link	string	Link na api pública para obter mais informações sobre este pedaço de dados.

tipo de trabalho4

Name	Caminho	Tipo	Description
id	id	string	A cadeia de caracteres de identificador para o Tipo de Trabalho.
nome	name	string	O nome do Tipo de Trabalho. Enum: `Permanent`, `Fixed Contract`, , `Unpaid`, `Independent ContractTemporary/Casual`.
isEnabled	isEnabled	boolean	Especifica se os usuários podem selecionar esse Tipo de Trabalho em menus suspensos.

cadeia (de caracteres)

Este é o tipo de dados básico 'string'.

Partilhar via

intelliHR (Pré-visualização)

Pré-requisitos

Como obter credenciais

Introdução ao conector

Problemas conhecidos e limitações

Erros e soluções comuns

A criar uma ligação

Padrão

Limites de Limitação

Ações

Atualizar um documento por id

Parâmetros

Devoluções

Atualizar um registro de treinamento por ID

Parâmetros

Devoluções

Atualizar uma pessoa por ID

Parâmetros

Devoluções

Atualizar uma Unidade de Negócios por ID

Parâmetros

Devoluções

Corrigir um trabalho existente

Parâmetros

Devoluções

Criar um novo registo de pessoa

Parâmetros

Devoluções

Criar um novo trabalho

Parâmetros

Devoluções

Criar um registro de treinamento

Parâmetros

Devoluções

Criar um URL de carregamento pré-assinado

Parâmetros

Devoluções

Criar uma nova Unidade de Negócio

Parâmetros

Devoluções

Definir a data de término de um trabalho

Parâmetros

Devoluções

Encontrar um emprego por ID

Parâmetros

Devoluções

Encontrar um registo de formação por ID

Parâmetros

Devoluções

Encontrar um tipo de trabalho por ID

Parâmetros

Devoluções

Encontrar uma classe de trabalho por ID

Parâmetros

Devoluções

Encontrar uma componente de remuneração por incumprimento por ID

Parâmetros

Devoluções

Encontrar uma entidade comercial por ID

Parâmetros

Devoluções

Encontrar uma pessoa por ID

Parâmetros

Devoluções

Encontre um evento Webhook por ID

Parâmetros

Devoluções

Encontre um Fornecedor de Formação por ID

Parâmetros

Devoluções

Encontre um local por ID

Parâmetros

Devoluções

Encontre um tipo de treinamento por ID

Parâmetros

Devoluções

Encontre um trabalho certo por ID

Parâmetros

Devoluções