Compartilhar via


intelliHR (versão prévia)

O intelliHR é uma plataforma de gerenciamento de pessoas baseada em nuvem com recursos de análise avançada. Conecte-se ao locatário do IntelliHR para automatizar fluxos de trabalho orientados a pessoas (como integração) e exportação de dados.

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

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte ao cliente
URL https://intellihr.zendesk.com/hc/en-us
Email support@intellihr.co
Metadados do conector
Publicador intelliHR
Site https://www.intellihr.com
Política de privacidade https://intellihr.co/privacy-policy/
Categorias Recursos humanos; Business Intelligence

O intelliHR é uma plataforma de Gerenciamento de Pessoas e Análise fácil de usar para gerenciamento centralizado de desempenho, envolvimento de funcionários, processos básicos de Recursos Humanos e análise de RH em um só lugar. Crie tarefas agendadas e fluxos de trabalho automatizados com seus dados de pessoas no Power Automate, Office 365, SharePoint, Microsoft Dynamics 365 e outros serviços sem código com o Conector intelliHR.

Pré-requisitos

Para usar esse conector, você deve ter um locatário intelliHR. Para ter um locatário provisionado para 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 locatário corresponderá ao subdomínio da conta (por exemplo). https://this-is-your-tenant-name.intellihr.net

Para criar uma chave de API:

  1. Faça logon em seu locatário com uma conta de administrador
  2. Navegue até a página Configurações
  3. Pesquise por 'API' e clique em 'Chaves de Acesso à API Pública'
  4. Siga os prompts 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 de 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'. A falha ao fazer isso resultará em erros de 'chave de API inválida'.

Problemas e limitações conhecidos

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 por meio da referência à documentação da API pública.

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

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:

Default 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.

Essa não é uma conexão compartilhável. Se o aplicativo de energia 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, acrescentada com 'Portador' Verdade
Inquilino cadeia Seu nome de locatário intelliHR Verdade

Limitações

Nome Chamadas Período de renovação
Chamadas à 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

Atributos de patch de um registro de trabalho existente com os dados fornecidos.

Criar um novo registro 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 uma nova Unidade de Negócios

Retorna a Unidade de Negócios criada.

Criar uma URL de upload pré-atribuída

Criar uma URL de upload pré-atribuída

Definir a data de término de um trabalho

Definir a data de término de um trabalho

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 pela ID fornecida.

Listar todas as classes de trabalho

Retorna uma lista de todas as Classes de Trabalho registradas no sistema.

Listar todas as condições de emprego

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

Listar todas as definições de campo personalizadas

Retorna uma lista de todas as Definições de Campo Personalizadas.

Listar todas as entidades comerciais

Retorna uma lista de todas as Entidades Comerciais.

Listar todas as fontes de recrutamento

Retorna uma lista de todas as fontes de recrutamento.

Listar todas as notas salariais

Retorna uma lista de todas as notas salariais.

Listar todas as pessoas

Retorna uma lista de todas as Pessoas como na data atual.

Listar todas as Unidades de Negócios

Retorna uma lista de todas as Unidades de Negócios registradas no sistema.

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

Retorna uma lista de todos os componentes de remuneração padrão registrados no sistema.

Listar todos os direitos de trabalho

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

Listar todos os locais

Retorna uma lista de todos os locais.

Listar todos os provedores de treinamento

Retorna uma lista de todos os Provedores de Treinamento.

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 trabalhos

Retorna uma lista de todos os registros de entidade de trabalho como na data atual.

Listar todos os treinamentos

Retorna uma lista de todos os registros de treinamento.

Localizar um componente de remuneração padrão por ID

Retorna um único componente de remuneração padrão.

Localizar um evento do Webhook por ID

Retorna um único evento do Webhook.

Localizar um local por ID

Retorna um único local.

Localizar um provedor de treinamento por ID

Retorna um único Provedor de Treinamento.

Localizar um registro de treinamento por ID

Retorna um único registro de treinamento.

Localizar um tipo de trabalho por ID

Retorna um único tipo de trabalho.

Localizar um tipo de treinamento por ID

Retorna um único tipo de treinamento.

Localizar um trabalho direito por ID

Retorna um único direito de trabalho.

Localizar um trabalho por ID

Obtenha um único registro de trabalho pelo identificador UUIDv4.

Localizar um Webhook por ID

Retorna um único webhook.

Localizar uma classe corporativa por ID

Retorna uma única classe corporativa.

Localizar uma condição de emprego por ID

Retorna uma única condição de emprego.

Localizar uma definição de campo personalizado por ID

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

Localizar uma entidade de negócios por ID

Retorna uma única entidade de negócios por seu identificador.

Localizar uma fonte de recrutamento por ID

Retorna uma única fonte de recrutamento.

Localizar uma nota de pagamento por ID

Retorna uma única nota salarial.

Localizar uma pessoa por ID

Obtenha um único registro de pessoa pelo identificador UUIDv4.

Localizar uma unidade de negócios por ID

Retorna uma única Unidade de Negócios.

UpdateAWebhook

Patch de um Webhook

Atualizar um documento por ID

Atualizar um documento

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID do documento
id True string

A cadeia de caracteres do identificador de recurso

personId
personId True string

A cadeia de caracteres do identificador para a pessoa à qual este documento pertence.

uploadStatus
uploadStatus True string

O status de upload deste Documento. Enumeração: SUCCESS, PENDING, FAILED.

Retornos

PatchaPersonDocument
PatchaPersonDocument

Atualizar um registro de treinamento por ID

Atualizar um registro de treinamento

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID do registro de treinamento
id True string

A cadeia de caracteres do identificador de recurso

id
id string

A cadeia de caracteres do identificador para a Pessoa a ser localizada no sistema.

nome
name string

O nome da pessoa no intelliHR a ser pesquisado. Observe que a pesquisa conta para diferenças na ordem de nome automaticamente.

endereço de e-mail principal
primaryEmailAddress string

O endereço de email sinalizado como primário para a pessoa dentro do sistema.

númeroDoFuncionário
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 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 locatário.

data de conclusão
completionDate string

O carimbo de data/hora em que o Treinamento foi concluído. Esta data seguirá o formato definido por RFC3339.

YYYY- também há suporte para a formatação de dataMM-DD, embora usando esse formato a data será armazenada como o início do dia no horário UTC, não o fuso horário dos locatários solicitantes.

custar
cost string

O custo deste Treinamento.

moeda
currency string

A moeda usada para este Treinamento. 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 neste treinamento

id
id string

A cadeia de caracteres do identificador para o trabalho para o qual este Treinamento foi concluído.

nome
name string

Nome amigável fornecido a este Treinamento para identificá-lo no sistema.

id
id string

A cadeia de caracteres do identificador para a Pessoa a ser localizada no sistema.

nome
name string

O nome da pessoa no intelliHR a ser pesquisado. Observe que a pesquisa conta para diferenças na ordem de nome automaticamente.

endereço de e-mail principal
primaryEmailAddress string

O endereço de email sinalizado como primário para a pessoa dentro do sistema.

númeroDoFuncionário
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 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 locatário.

id
id string

A cadeia de caracteres do identificador para o Provedor de Treinamento do Treinamento.

nome
name string

Nome amigável fornecido ao Provedor de Treinamento do Treinamento.

id
id string

A cadeia de caracteres do 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 personalizados para este treinamento

Retornos

SingleTraining
SingleTraining

Atualizar uma pessoa por ID

Atualizar uma pessoa

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID do registro de pessoa
id True string

A cadeia de caracteres do identificador de recurso

primeiro nome
firstName string

O 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 preferencial da pessoa . Geralmente, pode ser configurado por funcionários para si mesmos.

dateOfBirth
dateOfBirth string

Data de nascimento (YYYY-MM-DD).

gender
gender string

Cadeia de caracteres legível humana para o gênero da pessoa , por exemplo. Male. A pesquisa é feita sem diferenciação de maiúsculas de 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 ao primeiro será escolhido.

númeroDoFuncionário
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 locatário.

title
title string

O título a ser referenciado a essa 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 contato de emergência.

relação
relationship string

A relação que esse contato de emergência tem com a Pessoa.

phone
phone string

Número de telefone do contato de emergência.

email
email string

Email do contato de emergência.

email
email string

O endereço de email associado a essa pessoa.

isPersonal
isPersonal boolean

Indica se esse email é pessoal ou um email de trabalho.

é Primário
isPrimary boolean

Indica se esse email é o email de contato principal.

número
number string

O número de telefone. Esse número pode ser prefixado com um código de área. Quando isso acontecer, o sistema tentará determinar automaticamente o país de origem para o número de telefone

isPersonal
isPersonal boolean

Indica se esse telefone é pessoal ou um número de telefone de trabalho.

é Primário
isPrimary boolean

Indica se esse telefone é o número de telefone de contato principal.

addressType
addressType string

Enumeração: Home, Postal. O tipo de endereço.

fullAddress
fullAddress string

O endereço legível completo, menos o código postal e o país

country
country string

O país em que o endereço está.

Cp
postcode string

O código postal do endereço.

estado
state string

O estado em que o endereço está. 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 personalizados para essa pessoa

id
id string

A cadeia de caracteres do identificador para o direito de trabalho ao qual essa pessoa pertence.

nome
name string

O nome da Direita de Trabalho.

workRightExpiryDate
workRightExpiryDate string

A data em que este Direito de Trabalho expirará para essa pessoa (YYYY-MM-DD).

Retornos

SinglePerson
SinglePerson

Atualizar uma unidade de negócios por ID

Retorna a Unidade de Negócios atualizada.

Parâmetros

Nome Chave Obrigatório Tipo Description
A 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 fornecido para esta Unidade de Negócios. Esse nome normalmente seria mostrado aos usuários do sistema.

notas
notes string

Anotações anexadas a uma Unidade de Negócios

ID do pai
parentId string

A cadeia de caracteres do identificador para a Unidade de Negócios pai ou nula se não houver pai (esta é uma unidade de negócios de nível superior).

está ativado
isEnabled boolean

Especifica se os usuários podem selecionar esta Unidade de Negócios em listas suspensas.

Retornos

Resposta
Response

Corrigir um trabalho existente

Atributos de patch de um registro de trabalho existente com os dados fornecidos.

Parâmetros

Nome Chave Obrigató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 Trabalho está 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 essa Atualização está em vigor desde o início do trabalho. Esta data seguirá o formato definido por RFC3339.

YYYY- também há suporte para a formatação de dataMM-DD, embora usando esse formato a data será armazenada como o início do dia no horário UTC, não o fuso horário dos locatários solicitantes.

effectiveTo
effectiveTo string

A data em que esta Atualização de Trabalho está 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- também há suporte para a formatação de dataMM-DD, embora usando esse formato a data será armazenada como o início do dia no horário 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 do identificador para a Entidade De Negócios a quem este Trabalho pertence.

nome
name string

Nome fornecido a esta Entidade de Negócios. Esse nome normalmente seria mostrado aos usuários do sistema.

nome legal
legalName string

Nome legal da Entidade de Negócios. Normalmente usado para tarefas administrativas.

número
number string

Número da Entidade Comercial registrada legalmente, por exemplo, na Austrália, pode ser o ABN, ou na América, o RN.

id
id string

A cadeia de caracteres do identificador da Unidade de Negócios à qual este Trabalho pertence.

nome
name string

Nome fornecido para esta Unidade de Negócios. Esse nome normalmente seria mostrado aos usuários do sistema.

id
id string

A cadeia de caracteres do identificador para a Pessoa a ser localizada no sistema.

nome
name string

O nome da pessoa no intelliHR a ser pesquisado. Observe que a pesquisa conta para diferenças na ordem de nome automaticamente.

endereço de e-mail principal
primaryEmailAddress string

O endereço de email sinalizado como primário para a pessoa dentro do sistema.

númeroDoFuncionário
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 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 locatário.

id
id string

A cadeia de caracteres do identificador para o trabalho do supervisor deste trabalho.

nome
name string

O nome/cargo do trabalho do supervisor.

id
id string

A cadeia de caracteres do identificador para o Local.

nome
name string

Nome fornecido para este Local. Esse nome normalmente seria mostrado aos usuários do sistema.

address
address string

O endereço deste local.

id
id string

A cadeia de caracteres do identificador para a Classe Corporativa à qual este Trabalho pertence.

nome
name string

O nome da Classe Corporativa.

id
id string

A cadeia de caracteres do identificador para o Tipo de Trabalho ao qual este Trabalho pertence.

nome
name string

O nome do Tipo de Trabalho. Enumeração: Permanent, Fixed Contract, , Unpaid, Temporary/Casual. Independent Contract

Fte
fte string

O equivalente em tempo integral deste Trabalho. Indicando a carga de trabalho de um funcionário que pode ser comparável em diferentes contextos. Isso é nulo para pessoas sem um FTE.

id
id string

A cadeia de caracteres do identificador para o Pay Grade.

codificar
code string

Código administrativo curto associado ao Pay Grade.

nome
name string

Nome amigável dado ao Pay Grade.

tipo
type string

O método no qual esse cronograma de remuneração é pago. Enumeração: Annual Salary, Hourly Rate, No Remuneration Schedule.

payCycle
payCycle True string

O ciclo em que o trabalho é pago. Enumeração: Weekly, Fortnightly, Monthly.

moeda
currency string

A moeda em que a base e o total dos valores 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 do identificador para a Condição de Emprego deste Agendamento 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.

hoursPerCycle
hoursPerCycle True double

Quantas horas trabalhadas por payCycle.

baseAnnualSalary
baseAnnualSalary double

O Salário Base pago anualmente, isso só será necessário se o Tipo de Agendamento de Remuneração for "Salário Anual".

baseHourlyRate
baseHourlyRate double

A Taxa Base paga por hora, isso só será necessário se o Tipo de Agendamento de Remuneração for "Taxa por Hora".

nome
name True string

O nome desta Adição.

tipo
type True string

Como essa adição é calculada e aplicada à quantidade base, MultipleOfBase é multiplicado por baseAnnualSalary e, em seguida, adicionado ao total enquanto FixedAmount é adicionado diretamente ao total. Enumeração: MultipleOfBase, FixedAmount.

value
value True string

Para MultipleOfBase, esse é o multiplicador (por exemplo, 9 = 9%) enquanto, para o valor fixo, esse é o valor a ser adicionado diretamente ao total.

moeda
currency string

A moeda usada 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 do componente de remuneração padrão.

nome
name True string

O nome desta Adição.

tipo
type True string

Como essa adição é calculada e aplicada à quantidade base, MultipleOfBase é multiplicado por baseAnnualSalary e, em seguida, adicionado ao total enquanto FixedAmount é adicionado diretamente ao total. Enumeração: MultipleOfBase, FixedAmount.

value
value True string

Para MultipleOfBase, esse é o multiplicador (por exemplo, 9 = 9%) enquanto, para o valor fixo, esse é o valor a ser adicionado diretamente ao total.

moeda
currency string

A moeda usada 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 esse detalhamento é calculado e aplicado à quantidade base, MultipleOfBase é multiplicado por baseAnnualSalary e, em seguida, adicionado ao total enquanto FixedAmount é adicionado diretamente ao total. Enumeração: MultipleOfBase, FixedAmount.

value
value True string

Para MultipleOfBase, esse é o multiplicador (por exemplo, 9 = 9%) enquanto, para o valor fixo, esse é o valor a ser adicionado diretamente ao total.

moeda
currency string

A moeda usada para esse detalhamento. 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 do componente de remuneração padrão.

Retornos

SingleJob
SingleJob

Criar um novo registro de pessoa

Criar uma pessoa

Parâmetros

Nome Chave Obrigatório Tipo Description
primeiro nome
firstName string

O 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 preferencial da pessoa . Geralmente, pode ser configurado por funcionários para si mesmos.

dateOfBirth
dateOfBirth string

Data de nascimento (YYYY-MM-DD).

gender
gender string

Cadeia de caracteres legível humana para o gênero da pessoa , por exemplo. Male. A pesquisa é feita sem diferenciação de maiúsculas de 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 ao primeiro será escolhido.

númeroDoFuncionário
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 locatário.

title
title string

O título a ser referenciado a essa 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 contato de emergência.

relação
relationship string

A relação que esse contato de emergência tem com a Pessoa.

phone
phone string

Número de telefone do contato de emergência.

email
email string

Email do contato de emergência.

email
email string

O endereço de email real.

isPersonal
isPersonal boolean

Indica se esse email é pessoal ou um email de trabalho.

número
number string

O número de telefone real. Esse número pode ser prefixado com um código de área. Quando isso acontecer, o sistema tentará determinar automaticamente o país de origem para o número de telefone

isPersonal
isPersonal boolean

Indica se esse telefone é pessoal ou um número de telefone de trabalho.

customFields
customFields object

Os valores de campo personalizados para essa pessoa

id
id string

A cadeia de caracteres do identificador para o direito de trabalho ao qual essa pessoa pertence.

nome
name string

O nome da Direita de Trabalho.

workRightExpiryDate
workRightExpiryDate string

A data em que este Direito de Trabalho expirará para essa pessoa (YYYY-MM-DD).

Retornos

SinglePerson
SinglePerson

Criar um novo trabalho

Crie um novo registro de trabalho com os dados fornecidos.

Parâmetros

Nome Chave Obrigatório Tipo Description
id
id string

A cadeia de caracteres do identificador para a Pessoa a ser localizada no sistema.

nome
name string

O nome da pessoa no intelliHR a ser pesquisado. Observe que a pesquisa conta para diferenças na ordem de nome automaticamente.

endereço de e-mail principal
primaryEmailAddress string

O endereço de email sinalizado como primário para a pessoa dentro do sistema.

númeroDoFuncionário
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 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 locatário.

companyStartDate
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- também há suporte para a formatação de dataMM-DD, embora usando esse formato a data será armazenada como o início do dia no horário UTC, não o fuso horário dos locatários solicitantes.

companyEndDate
companyEndDate string

A data em que este Trabalho terminou ou terminará dentro da organização. Esta data seguirá o formato definido por RFC3339.

YYYY- também há suporte para a formatação de dataMM-DD, embora usando esse formato a data será armazenada como o início do dia no horário 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 do identificador para a Entidade De Negócios a quem este Trabalho pertence.

nome
name string

Nome fornecido a esta Entidade de Negócios. Esse nome normalmente seria mostrado aos usuários do sistema.

nome legal
legalName string

Nome legal da Entidade de Negócios. Normalmente usado para tarefas administrativas.

número
number string

Número da Entidade Comercial registrada legalmente, por exemplo, na Austrália, pode ser o ABN, ou na América, o RN.

id
id string

A cadeia de caracteres do identificador da Unidade de Negócios à qual este Trabalho pertence.

nome
name string

Nome fornecido para esta Unidade de Negócios. Esse nome normalmente seria mostrado aos usuários do sistema.

id
id string

A cadeia de caracteres do identificador para a Pessoa a ser localizada no sistema.

nome
name string

O nome da pessoa no intelliHR a ser pesquisado. Observe que a pesquisa conta para diferenças na ordem de nome automaticamente.

endereço de e-mail principal
primaryEmailAddress string

O endereço de email sinalizado como primário para a pessoa dentro do sistema.

númeroDoFuncionário
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 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 locatário.

id
id string

A cadeia de caracteres do identificador para o trabalho do supervisor deste trabalho.

nome
name string

O nome/cargo do trabalho do supervisor.

id
id string

A cadeia de caracteres do identificador para o Local.

nome
name string

Nome fornecido para este Local. Esse nome normalmente seria mostrado aos usuários do sistema.

address
address string

O endereço deste local.

id
id string

A cadeia de caracteres do identificador para a Classe Corporativa à qual este Trabalho pertence.

nome
name string

O nome da Classe Corporativa.

id
id string

A cadeia de caracteres do identificador para o Tipo de Trabalho ao qual este Trabalho pertence.

nome
name string

O nome do Tipo de Trabalho. Enumeração: Permanent, Fixed Contract, , Unpaid, Temporary/Casual. Independent Contract

Fte
fte string

O equivalente em tempo integral deste Trabalho. Indicando a carga de trabalho de um funcionário que pode ser comparável em diferentes contextos. Isso é nulo para pessoas sem um FTE.

id
id string

A cadeia de caracteres do identificador para o Pay Grade.

codificar
code string

Código administrativo curto associado ao Pay Grade.

nome
name string

Nome amigável dado ao Pay Grade.

tipo
type string

O método no qual esse cronograma de remuneração é pago. Enumeração: Annual Salary, Hourly Rate, No Remuneration Schedule.

payCycle
payCycle True string

O ciclo em que o trabalho é pago. Enumeração: Weekly, Fortnightly, Monthly.

moeda
currency string

A moeda em que a base e o total dos valores 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 do identificador para a Condição de Emprego deste Agendamento 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.

hoursPerCycle
hoursPerCycle True double

Quantas horas trabalhadas por payCycle.

baseAnnualSalary
baseAnnualSalary double

O Salário Base pago anualmente, isso só será necessário se o Tipo de Agendamento de Remuneração for "Salário Anual".

baseHourlyRate
baseHourlyRate double

A Taxa Base paga por hora, isso só será necessário se o Tipo de Agendamento de Remuneração for "Taxa por Hora".

nome
name True string

O nome desta Adição.

tipo
type True string

Como essa adição é calculada e aplicada à quantidade base, MultipleOfBase é multiplicado por baseAnnualSalary e, em seguida, adicionado ao total enquanto FixedAmount é adicionado diretamente ao total. Enumeração: MultipleOfBase, FixedAmount.

value
value True string

Para MultipleOfBase, esse é o multiplicador (por exemplo, 9 = 9%) enquanto, para o valor fixo, esse é o valor a ser adicionado diretamente ao total.

moeda
currency string

A moeda usada 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 do componente de remuneração padrão.

nome
name True string

O nome desta Adição.

tipo
type True string

Como essa adição é calculada e aplicada à quantidade base, MultipleOfBase é multiplicado por baseAnnualSalary e, em seguida, adicionado ao total enquanto FixedAmount é adicionado diretamente ao total. Enumeração: MultipleOfBase, FixedAmount.

value
value True string

Para MultipleOfBase, esse é o multiplicador (por exemplo, 9 = 9%) enquanto, para o valor fixo, esse é o valor a ser adicionado diretamente ao total.

moeda
currency string

A moeda usada 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 esse detalhamento é calculado e aplicado à quantidade base, MultipleOfBase é multiplicado por baseAnnualSalary e, em seguida, adicionado ao total enquanto FixedAmount é adicionado diretamente ao total. Enumeração: MultipleOfBase, FixedAmount.

value
value True string

Para MultipleOfBase, esse é o multiplicador (por exemplo, 9 = 9%) enquanto, para o valor fixo, esse é o valor a ser adicionado diretamente ao total.

moeda
currency string

A moeda usada para esse detalhamento. 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 do componente de remuneração padrão.

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.

custar
cost double

O custo do recrutamento.

moeda
currency string

A moeda usada para recrutar este trabalho. 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.

Retornos

SingleJob
SingleJob

Criar um registro de treinamento

Criar um novo registro de treinamento

Parâmetros

Nome Chave Obrigatório Tipo Description
id
id string

A cadeia de caracteres do identificador para a Pessoa a ser localizada no sistema.

nome
name string

O nome da pessoa no intelliHR a ser pesquisado. Observe que a pesquisa conta para diferenças na ordem de nome automaticamente.

endereço de e-mail principal
primaryEmailAddress string

O endereço de email sinalizado como primário para a pessoa dentro do sistema.

númeroDoFuncionário
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 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 locatário.

data de conclusão
completionDate True string

O carimbo de data/hora em que o Treinamento foi concluído. Esta data seguirá o formato definido por RFC3339.

YYYY- também há suporte para a formatação de dataMM-DD, embora usando esse formato a data será armazenada como o início do dia no horário UTC, não o fuso horário dos locatários solicitantes.

custar
cost string

O custo deste Treinamento.

moeda
currency string

A moeda usada para este Treinamento. 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 neste treinamento

id
id string

A cadeia de caracteres do identificador para o trabalho para o qual este Treinamento foi concluído.

nome
name True string

Nome amigável fornecido a este Treinamento para identificá-lo no sistema.

id
id string

A cadeia de caracteres do identificador para a Pessoa a ser localizada no sistema.

nome
name string

O nome da pessoa no intelliHR a ser pesquisado. Observe que a pesquisa conta para diferenças na ordem de nome automaticamente.

endereço de e-mail principal
primaryEmailAddress string

O endereço de email sinalizado como primário para a pessoa dentro do sistema.

númeroDoFuncionário
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 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 locatário.

id
id string

A cadeia de caracteres do identificador para o Provedor de Treinamento do Treinamento.

nome
name string

Nome amigável fornecido ao Provedor de Treinamento do Treinamento.

id
id string

A cadeia de caracteres do 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 personalizados para este treinamento

Retornos

SingleTraining
SingleTraining

Criar uma nova Unidade de Negócios

Retorna a Unidade de Negócios criada.

Parâmetros

Nome Chave Obrigatório Tipo Description
identificador
identifier string

Identificador opcional que pode ser usado para tarefas administrativas.

nome
name True string

Nome fornecido para esta Unidade de Negócios. Esse nome normalmente seria mostrado aos usuários do sistema.

notas
notes string

Anotações anexadas a uma Unidade de Negócios

ID do pai
parentId string

A cadeia de caracteres do identificador para a Unidade de Negócios pai ou nula se não houver pai (esta é uma unidade de negócios de nível superior).

está ativado
isEnabled boolean

Especifica se os usuários podem selecionar esta Unidade de Negócios em listas suspensas.

Retornos

Resposta
Response

Criar uma URL de upload pré-atribuída

Criar uma URL de upload pré-atribuída

Parâmetros

Nome Chave Obrigatório Tipo Description
id
id string

A cadeia de caracteres do identificador para a Pessoa a ser localizada no sistema.

nome
name string

O nome da pessoa no intelliHR a ser pesquisado. Observe que a pesquisa conta para diferenças na ordem de nome automaticamente.

endereço de e-mail principal
primaryEmailAddress string

O endereço de email sinalizado como primário para a pessoa dentro do sistema.

númeroDoFuncionário
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 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 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 de 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

Retornos

SinglePersonDocument
SinglePersonDocument

Definir a data de término de um trabalho

Definir a data de término de um trabalho

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID do trabalho a ser encerrado
id True string

A ID do trabalho a ser encerrado

data de término
endDate True string

data de término

turnoverType
turnoverType True string

turnoverType

turnoverReason
turnoverReason string

turnoverReason

Retornos

SingleJob
SingleJob

Excluir um registro de treinamento por ID

Exclui o registro de treinamento fornecido.

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID do registro de treinamento
id True string

A cadeia de caracteres do identificador de recurso

Retornos

response
string

Excluir um Webhook por ID

Exclui o webhook fornecido.

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID do webhook
id True string

A cadeia de caracteres do identificador de recurso

Retornos

response
string

Excluir uma unidade de negócios por ID

Exclua uma Unidade de Negócios pela ID fornecida.

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID da unidade de negócios
id True string

A cadeia de caracteres do identificador de recurso

Retornos

response
string

Listar todas as classes de trabalho

Retorna uma lista de todas as Classes de Trabalho registradas no sistema.

Parâmetros

Nome Chave Obrigató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

Retornos

ListWorkClasses
ListWorkClasses

Listar todas as condições de emprego

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

Parâmetros

Nome Chave Obrigató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

Retornos

ListofEmploymentConditions
ListofEmploymentConditions

Listar todas as definições de campo personalizadas

Retorna uma lista de todas as Definições de Campo Personalizadas.

Parâmetros

Nome Chave Obrigató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

Filtros a serem aplicados à 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 uma ID específica seria filters[id][eq]=8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9.

Retornos

ListofCustomFieldDefinitions
ListofCustomFieldDefinitions

Listar todas as entidades comerciais

Retorna uma lista de todas as Entidades Comerciais.

Parâmetros

Nome Chave Obrigató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

Retornos

ListofBusinessEntities
ListofBusinessEntities

Listar todas as fontes de recrutamento

Retorna uma lista de todas as fontes de recrutamento.

Parâmetros

Nome Chave Obrigató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

Retornos

ListofRecruitmentSources
ListofRecruitmentSources

Listar todas as notas salariais

Retorna uma lista de todas as notas salariais.

Parâmetros

Nome Chave Obrigató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

Retornos

ListofPayGrades
ListofPayGrades

Listar todas as pessoas

Retorna uma lista de todas as Pessoas como na data atual.

Parâmetros

Nome Chave Obrigató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

Filtros a serem aplicados à 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 uma ID específica 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 acrescentada com um subtração para retornar os dados em ordem decrescente (-). Por exemplo, uma classificação para obter os registros mais recentes primeiro seria -createdAt.

Retornos

ListPeople
ListPeople

Listar todas as Unidades de Negócios

Retorna uma lista de todas as Unidades de Negócios registradas no sistema.

Parâmetros

Nome Chave Obrigató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

Retornos

ListofBusinessUnits
ListofBusinessUnits

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

Retorna uma lista de todos os componentes de remuneração padrão registrados no sistema.

Parâmetros

Nome Chave Obrigató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

Retornos

ListofDefaultRemunerationComponents
ListofDefaultRemunerationComponents

Listar todos os direitos de trabalho

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

Parâmetros

Nome Chave Obrigató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

Retornos

ListofWorkRights
ListofWorkRights

Listar todos os locais

Retorna uma lista de todos os locais.

Parâmetros

Nome Chave Obrigató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

Retornos

Listlocations
Listlocations

Listar todos os provedores de treinamento

Retorna uma lista de todos os Provedores de Treinamento.

Parâmetros

Nome Chave Obrigató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

Retornos

ListallTrainingProviders
ListallTrainingProviders

Listar todos os tipos de trabalho

Retorna uma lista de todos os Tipos de Trabalho registrados no sistema.

Parâmetros

Nome Chave Obrigató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

Retornos

ListWorkTypes
ListWorkTypes

Listar todos os tipos de treinamento

Retorna uma lista de todos os Tipos de Treinamento.

Parâmetros

Nome Chave Obrigató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

Retornos

ListallTrainingTypes
ListallTrainingTypes

Listar todos os trabalhos

Retorna uma lista de todos os registros de entidade de trabalho como na data atual.

Parâmetros

Nome Chave Obrigató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

Filtros a serem aplicados à 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 uma ID específica 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 acrescentada com um subtração para retornar os dados em ordem decrescente (-). Por exemplo, uma classificação para obter os registros mais recentes primeiro seria -createdAt.

Retornos

ListJobs
ListJobs

Listar todos os treinamentos

Retorna uma lista de todos os registros de treinamento.

Parâmetros

Nome Chave Obrigató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

Filtros a serem aplicados à 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 uma ID específica 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 acrescentada com um subtração para retornar os dados em ordem decrescente (-). Por exemplo, uma classificação para obter os registros mais recentes primeiro seria -createdAt.

Retornos

ListofTrainings
ListofTrainings

Localizar um componente de remuneração padrão por ID

Retorna um único componente de remuneração padrão.

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID do componente de remuneração
id True string

A cadeia de caracteres do identificador de recurso

Retornos

SingleDefaultRemunerationComponent
SingleDefaultRemunerationComponent

Localizar um evento do Webhook por ID

Retorna um único evento do Webhook.

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID do evento de webhook
id True string

A cadeia de caracteres do identificador de recurso

Retornos

Evento webhook único.

webhook-events
webhook-events

Localizar um local por ID

Retorna um único local.

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID do local
id True string

A cadeia de caracteres do identificador de recurso

Retornos

SingleLocation
SingleLocation

Localizar um provedor de treinamento por ID

Retorna um único Provedor de Treinamento.

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID do provedor de treinamento
id True string

A cadeia de caracteres do identificador de recurso

Retornos

SingleTrainingProvider
SingleTrainingProvider

Localizar um registro de treinamento por ID

Retorna um único registro de treinamento.

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID do registro de treinamento
id True string

A cadeia de caracteres do identificador de recurso

Retornos

SingleTraining
SingleTraining

Localizar um tipo de trabalho por ID

Retorna um único tipo de trabalho.

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID do tipo de trabalho
id True string

A cadeia de caracteres do identificador de recurso

Retornos

SingleWorkType
SingleWorkType

Localizar um tipo de treinamento por ID

Retorna um único tipo de treinamento.

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID do tipo de treinamento
id True string

A cadeia de caracteres do identificador de recurso

Retornos

SingleTrainingTypes
SingleTrainingTypes

Localizar um trabalho direito por ID

Retorna um único direito de trabalho.

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID do direito do trabalho
id True string

A cadeia de caracteres do identificador de recurso

Retornos

SingleWorkRight
SingleWorkRight

Localizar um trabalho por ID

Obtenha um único registro de trabalho pelo identificador UUIDv4.

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID do trabalho a ser retornado
id True string

A cadeia de caracteres do identificador de recurso

Retornar dados precisos para o trabalho nesta data
asAt string

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

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.

Retornos

SingleJob
SingleJob

Localizar um Webhook por ID

Retorna um único webhook.

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID do webhook
id True string

A cadeia de caracteres do identificador de recurso

Retornos

SingleWebhook
SingleWebhook

Localizar uma classe corporativa por ID

Retorna uma única classe corporativa.

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID da classe corporativa
id True string

A cadeia de caracteres do identificador de recurso

Retornos

SingleWorkClass
SingleWorkClass

Localizar uma condição de emprego por ID

Retorna uma única condição de emprego.

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID da condição de emprego
id True string

A cadeia de caracteres do identificador de recurso

Retornos

SingleEmploymentCondition
SingleEmploymentCondition

Localizar uma definição de campo personalizado por ID

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

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID do campo personalizado
id True string

A cadeia de caracteres do identificador de recurso

Retornos

SingleCustomFieldDefinition
SingleCustomFieldDefinition

Localizar uma entidade de negócios por ID

Retorna uma única entidade de negócios por seu identificador.

Parâmetros

Nome Chave Obrigatório Tipo Description
A cadeia de caracteres do identificador de recurso
id True string

A cadeia de caracteres do identificador de recurso

Retornos

SingleBusinessEntity
SingleBusinessEntity

Localizar uma fonte de recrutamento por ID

Retorna uma única fonte de recrutamento.

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID da fonte de recrutamento
id True string

A cadeia de caracteres do identificador de recurso

Retornos

SingleRecruitmentSource
SingleRecruitmentSource

Localizar uma nota de pagamento por ID

Retorna uma única nota salarial.

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID da nota salarial
id True string

A cadeia de caracteres do identificador de recurso

Retornos

SinglePayGrade
SinglePayGrade

Localizar uma pessoa por ID

Obtenha um único registro de pessoa pelo identificador UUIDv4.

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID do registro de pessoa
id True string

A ID do registro de pessoa

Retornos

SinglePerson
SinglePerson

Localizar uma unidade de negócios por ID

Retorna uma única Unidade de Negócios.

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID da unidade de negócios
id True string

A cadeia de caracteres do identificador de recurso

Retornos

Resposta
Response

UpdateAWebhook

Patch de um Webhook

Parâmetros

Nome Chave Obrigató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 do Webhook para o qual a solicitação será enviada quando o evento webhook assinado for disparado.

webhookEvent
webhookEvent string

A lesma do evento webhook.

está ativado
isEnabled boolean

Especifica se os usuários podem selecionar esse Webhook. Quando desabilitado, esse Webhook não será enviado.

fonte
source string

Uma cadeia de caracteres personalizável que pode ser usada para identificar qual sistema criou esse Webhook. Os webhooks criados por meio do aplicativo intelliHR terão origem: "personalizado".

Retornos

SingleWebhook
SingleWebhook

Gatilhos

Criar um webhook e assinar um tipo de evento em seu locatário

Criar um webhook e assinar um tipo de evento em seu locatário

Criar um webhook e assinar um tipo de evento em seu locatário

Criar um webhook e assinar um tipo de evento em seu locatário

Parâmetros

Nome Chave Obrigatório Tipo Description
webhookEvent
webhookEvent True string

webhookEvent

está ativado
isEnabled boolean

está ativado

fonte
source string

fonte

Retornos

Nome Caminho Tipo Description
id
id string

id

evento
event string

evento

carimbo de data/hora
timestamp string

carimbo de data/hora

self
links.self string

self

Definições

SingleBusinessEntity

Nome Caminho Tipo Description
BusinessEntity
data BusinessEntity

ListofBusinessEntities

Nome Caminho Tipo Description
dados
data array of BusinessEntity
Meta
meta Meta

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

Links
links Links

Links para outros recursos relacionados.

Resposta

Nome Caminho Tipo Description
BusinessUnit3
data BusinessUnit3
Meta1
meta Meta1

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

ListofBusinessUnits

Nome Caminho Tipo Description
dados
data array of BusinessUnit3
Meta2
meta Meta2

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

Links
links Links

Links para outros recursos relacionados.

SingleCustomFieldDefinition

Nome Caminho Tipo Description
CustomFieldDefinition
data CustomFieldDefinition

ListofCustomFieldDefinitions

Nome Caminho Tipo Description
dados
data array of CustomFieldDefinition
Meta
meta Meta

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

Links
links Links

Links para outros recursos relacionados.

SingleDefaultRemunerationComponent

Nome Caminho Tipo Description
DefaultRemunerationComponent
data DefaultRemunerationComponent

ListofDefaultRemunerationComponents

Nome Caminho Tipo Description
dados
data array of DefaultRemunerationComponent
Meta
meta Meta

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

Links
links Links

Links para outros recursos relacionados.

SingleEmploymentCondition

Nome Caminho Tipo Description
EmploymentCondition
data EmploymentCondition

ListofEmploymentConditions

Nome Caminho Tipo Description
dados
data array of EmploymentCondition
Meta
meta Meta

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

Links
links Links

Links para outros recursos relacionados.

SingleJob

Nome Caminho Tipo Description
Meta1
meta Meta1

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

Job
data Job

ListJobs

Nome Caminho Tipo Description
dados
data array of Job
Meta8
meta Meta8

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

Links
links Links

Links para outros recursos relacionados.

SingleLocation

Nome Caminho Tipo Description
location5
data location5

Listlocations

Nome Caminho Tipo Description
dados
data array of location5
Meta
meta Meta

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

Links
links Links

Links para outros recursos relacionados.

SinglePayGrade

Nome Caminho Tipo Description
payGrade5
data payGrade5

ListofPayGrades

Nome Caminho Tipo Description
dados
data array of payGrade5
Meta
meta Meta

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

Links
links Links

Links para outros recursos relacionados.

ListPeople

Nome Caminho Tipo Description
dados
data array of data1
Meta
meta Meta

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

Links
links Links

Links para outros recursos relacionados.

SinglePerson

Nome Caminho Tipo Description
data1
data data1

SinglePersonDocument

Nome Caminho Tipo Description
Data3
data Data3

PatchaPersonDocument

Nome Caminho Tipo Description
Data4
data Data4

SingleRecruitmentSource

Nome Caminho Tipo Description
recruitmentSource
data recruitmentSource

ListofRecruitmentSources

Nome Caminho Tipo Description
dados
data array of recruitmentSource

Detalhes da fonte de recrutamento.

Meta
meta Meta

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

Links
links Links

Links para outros recursos relacionados.

SingleTrainingProvider

Nome Caminho Tipo Description
trainingProviders
data trainingProviders

ListallTrainingProviders

Nome Caminho Tipo Description
dados
data array of trainingProviders
Meta
meta Meta

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

Links
links Links

Links para outros recursos relacionados.

SingleTraining

Nome Caminho Tipo Description
Training
data Training

ListofTrainings

Nome Caminho Tipo Description
dados
data array of Training
Meta
meta Meta

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

Links
links Links

Links para outros recursos relacionados.

SingleTrainingTypes

Nome Caminho Tipo Description
trainingTypes
data trainingTypes

ListallTrainingTypes

Nome Caminho Tipo Description
dados
data array of trainingTypes
Meta
meta Meta

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

Links
links Links

Links para outros recursos relacionados.

SingleWorkClass

Nome Caminho Tipo Description
WorkClassesSchema
data WorkClassesSchema

ListWorkClasses

Nome Caminho Tipo Description
dados
data array of WorkClassesSchema
Meta
meta Meta

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

Links
links Links

Links para outros recursos relacionados.

SingleWorkRight

Nome Caminho Tipo Description
WorkRight2
data WorkRight2

ListofWorkRights

Nome Caminho Tipo Description
dados
data array of WorkRight2
Meta
meta Meta

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

Links
links Links

Links para outros recursos relacionados.

SingleWorkType

Nome Caminho Tipo Description
workType4
data workType4

ListWorkTypes

Nome Caminho Tipo Description
dados
data array of workType4
Meta
meta Meta

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

Links
links Links

Links para outros recursos relacionados.

webhook-events

Evento webhook único.

Nome Caminho Tipo Description
Dados5
data Data5

SingleWebhook

Nome Caminho Tipo Description
Data7
data Data7

Adição

Nome 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. Enumeração: MultipleOfBase, FixedAmount.

value
value double

Para multipleOfBase, esse é o multiplicador (por exemplo, 9 = 9%) enquanto, para valor fixo, esse é o valor a ser adicionado diretamente ao total.

moeda
currency string

A moeda usada 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.

AdditionsToTotal

Nome Caminho Tipo Description
nome
name string

O nome desta Adição Total.

tipo
type string

Como essa adição total é calculada e aplicada à quantidade base, multipleOfBase é multiplicado por baseAnnualSalary e, em seguida, adicionado ao total enquanto o valor fixo é adicionado diretamente ao total. Enumeração: MultipleOfBase, FixedAmount.

value
value double

Para multipleOfBase, esse é o multiplicador (por exemplo, 9 = 9%) enquanto, para valor fixo, esse é o valor a ser adicionado diretamente ao total.

moeda
currency string

A moeda usada 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.

Endereço

Nome Caminho Tipo Description
addressType
addressType string

O tipo de endereço.

fullAddress
fullAddress string

O endereço completo.

country
country string

O país do endereço.

Cp
postcode string

O código postal do endereço.

estado
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.

Avaria

Nome Caminho Tipo Description
nome
name string

O nome desta Adição.

tipo
type string

Como essa adição é registrada, ela não é usada para calcular o pacote total devido ao contrário de outros componentes de remuneração. Enumeração: MultipleOfBase, FixedAmount.

value
value double

Para multipleOfBase, esse é o multiplicador (por exemplo, 9 = 9%) enquanto, para valor fixo, esse é o valor a ser adicionado diretamente ao total.

moeda
currency string

A moeda usada 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.

BusinessEntity

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para a Entidade De Negócios.

nome
name string

Nome fornecido a esta Entidade de Negócios. Esse nome normalmente seria mostrado aos usuários do sistema.

nome legal
legalName string

O nome legal pode ser diferente do nome apresentado a um usuário. Normalmente usado para tarefas administrativas.

número
number string

Número da Entidade Comercial registrada legalmente, por exemplo, na Austrália, pode ser o ABN, ou na América, o RN.

está ativado
isEnabled boolean

Especifica se os usuários podem selecionar essa Entidade De Negócios em listas suspensas.

BusinessUnit3

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para a Unidade de Negócios.

identificador
identifier string

Identificador opcional que pode ser usado para tarefas administrativas.

nome
name string

Nome fornecido para esta Unidade de Negócios. Esse nome normalmente seria mostrado aos usuários do sistema.

notas
notes string

Anotações anexadas a uma Unidade de Negócios

ID do pai
parentId string

A cadeia de caracteres do identificador para a Unidade de Negócios pai ou nula se não houver pai (esta é uma unidade de negócios de nível superior).

está ativado
isEnabled boolean

Especifica se os usuários podem selecionar esta Unidade de Negócios em listas suspensas.

BusinessEntity2

A entidade comercial atual do trabalho no sistema.

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para a Entidade De Negócios deste Trabalho.

nome
name string

Nome fornecido a esta Entidade de Negócios. Esse nome normalmente seria mostrado aos usuários do sistema.

link
link string

Link na API pública para obter mais informações sobre esses dados.

BusinessUnit4

A unidade de negócios atual do trabalho no sistema.

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para a Unidade de Negócios deste Trabalho.

nome
name string

Nome fornecido para esta Unidade de Negócios. Esse nome normalmente seria mostrado aos usuários do sistema.

link
link string

Link na API pública para obter mais informações sobre esses dados.

Coordenador

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

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para o Coordenador do Treinamento.

nome de exibição
displayName string

O nome da Pessoa que coordenou o Treinamento.

númeroDoFuncionário
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 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 locatário.

link
link string

Link na API pública para obter mais informações sobre esses dados.

CustomFieldDefinition

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para a Definição de Campo Personalizado.

nome
name string

Nome dado a essa definição de campo personalizado. Esse nome normalmente seria mostrado aos usuários do sistema.

apiName
apiName string

O nome da API fornecido a essa 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 dessa definição de campo personalizado. Isso é usado como uma dica de ferramenta nas páginas criar e atualizar.

modelType
modelType string

O modelo ao qual esse campo personalizado se relaciona e pode ser anexado. Enumeração: TRAINING, PERSON.

tipo
type string

O tipo de dados que esse campo registra. Enumeração: SINGLE_SELECT, MULTI_SELECT, , TEXT, NUMBER. PEOPLE_DROPDOWN

definitions
definitions object

Os valores dessa chave são alterados dependendo da chave de "tipo". Ele é usado para armazenar informações adicionais pertinentes a essa chave. Para obter mais informações sobre configurações de campo personalizadas, consulte nosso artigo da base de dados de conhecimento sobre campos personalizados

data1

Nome 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 essa Pessoa. Geralmente, segue o padrão preferredName (firstName) lastName, mas pode ser configurado em todo o locatário para ser um formato diferente.

primeiro nome
firstName string

O 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 preferencial da pessoa . Geralmente, pode ser configurado por funcionários para si mesmos.

dateOfBirth
dateOfBirth string

Data de nascimento (YYYY-MM-DD).

gender
gender string

Cadeia de caracteres legível humana para o gênero da pessoa , por exemplo, Masculino.

númeroDoFuncionário
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 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 locatário.

title
title string

O título a ser referenciado a essa Pessoa como, por exemplo, "Sr.". Isso será nulo se não for fornecido.

endereços de e-mail
emailAddresses array of EmailAddress

Uma matriz de endereços de email que pertencem a essa Pessoa.

EmergencyContact
emergencyContact EmergencyContact

Os detalhes do contato de emergência dessa pessoa.

employmentStatus
employmentStatus string

O status atual desta pessoa dentro da organização. Enumeração: Current Staff, Exiting Staff, , No Job Records, Past Staff, Returning Staff. Upcoming Staff

jobs
jobs array of Job4

Uma matriz de entradas de trabalho simples associadas a essa Pessoa na ordem cronológica inversa da data de início.

WorkRights
workRights WorkRights

Mostrar os direitos de trabalho da pessoa

PrimaryEmailAddress1
primaryEmailAddress PrimaryEmailAddress1

Informações sobre o endereço de email principal dessa pessoa ou nulas se elas não tiverem informações de email.

PrimaryPhoneNumber1
primaryPhoneNumber PrimaryPhoneNumber1

Informações sobre o número de telefone primário dessa pessoa ou nulas se elas não tiverem números de telefone.

endereços
addresses array of Address

Uma matriz de endereços que pertencem a essa Pessoa.

phoneNumbers
phoneNumbers array of PhoneNumber

Uma matriz de números de telefone que pertencem a essa Pessoa.

createdAt
createdAt string

Quando esse registro foi criado. Esta data seguirá o formato definido por RFC3339.

updatedAt
updatedAt string

Quando este registro foi atualizado pela última vez. Esta data seguirá o formato definido por RFC3339.

Data3

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador do Documento de Pessoa.

personId
personId string

A cadeia de caracteres do identificador para a pessoa à qual este documento pertence.

presignedUploadUrl
presignedUploadUrl string

A URL de upload pré-atribuída que permite carregar um Documento de Pessoa para S3. Esse link expirará 20 minutos após a criação. Instruções sobre como carregar um objeto com uma URL S3 pré-atribuída podem ser encontradas aqui

Data4

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador do Documento de Pessoa.

personId
personId string

A cadeia de caracteres do identificador para a pessoa à qual este documento pertence.

uploadStatus
uploadStatus string

O status de upload deste Documento. Enumeração: SUCCESS, PENDING, FAILED.

Dados5

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para o Evento do Webhook.

nome
name string

A chave de evento exclusiva legível para este Evento do Webhook.

evento
event string

A lesma do evento webhook.

examplePayload
examplePayload object

Um exemplo do conteúdo que será enviado aos Webhooks que assinam esse evento de Webhook específico.

Data7

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para o Webhook.

url
url string

O ponto de extremidade do Webhook para o qual a solicitação será enviada quando o evento webhook assinado for disparado.

WebhookEvent
webhookEvent WebhookEvent

O evento webhook que disparou esse Webhook.

está ativado
isEnabled boolean

Especifica se os usuários podem selecionar esse Webhook. Quando desabilitado, esse Webhook não será enviado.

fonte
source string

Uma cadeia de caracteres personalizável que pode ser usada para identificar qual sistema criou esse Webhook. Os webhooks criados por meio do aplicativo intelliHR terão origem: "personalizado".

createdAt
createdAt string

Quando esse registro foi criado. Esta data seguirá o formato definido por RFC3339.

updatedAt
updatedAt string

Quando este registro foi atualizado pela última vez. Esta data seguirá o formato definido por RFC3339.

Dedução

Nome Caminho Tipo Description
nome
name string

O nome desta dedução.

tipo
type string

Como essa dedução é calculada e aplicada ao valor base, multipleOfBase é multiplicada por baseAnnualSalary e, em seguida, deduzida do total enquanto o valor fixo é deduzido diretamente do total. Enumeração: MultipleOfBase, FixedAmount.

value
value double

Para multipleOfBase, esse é o multiplicador, enquanto para o valor fixo esse é o valor a ser deduzir diretamente do total.

moeda
currency string

A moeda usada 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

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para o componente de remuneração padrão.

nome
name string

Nome dado a esse componente de remuneração padrão. Esse nome normalmente seria mostrado aos usuários do sistema.

value
value string

O valor desse componente de remuneração. Para multipleOfBase, esse é o multiplicador, enquanto para o valor fixo esse é o valor a ser adicionado diretamente ao total.

isInUse
isInUse boolean

Se esse componente de remuneração padrão é usado como componentes de remuneração.

automaticallyAddToJobs
automaticallyAddToJobs boolean

Se esse componente de remuneração padrão é adicionado automaticamente a trabalhos recém-criados/atualizados.

está ativado
isEnabled boolean

Se esse componente de remuneração padrão estiver habilitado para uso no sistema.

moeda
currency string

A moeda usada para esse componente de remuneração padrã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.

tipo
type string

O tipo desse componente de remuneração padrão. Enumeração: AdditionToBase, AdditionToTotal, , DeductionToBase. Breakdown

valueType
valueType string

O tipo do valor deste Componente de Remuneração Padrão. Enumeração: MultipleOfBase, FixedAmount.

Endereço de Email

Nome Caminho Tipo Description
email
email string

O endereço de email real.

é Primário
isPrimary boolean

Se esse for um endereço de email primário.

isPersonal
isPersonal boolean

Se esse for um endereço de email pessoal.

EmergencyContact

Os detalhes do contato de emergência dessa pessoa.

Nome Caminho Tipo Description
nome
name string

O nome do contato de emergência.

relação
relationship string

A relação que esse contato de emergência tem com a Pessoa.

phone
phone string

Número de telefone do contato de emergência.

email
email string

Email do contato de emergência.

EmploymentCondition

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para a Condição de Emprego.

nome
name string

Nome dado a esta Condição de Emprego. Esse nome normalmente seria mostrado aos usuários 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.

está ativado
isEnabled boolean

Especifica se os usuários podem selecionar essa Condição de Emprego nas listas suspensas.

EmploymentCondition2

A Condição de Emprego sob a qual este trabalho está sendo pago.

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para a Condição de Emprego deste Agendamento de Remuneração.

nome
name string

Nome dado a esta Condição de Emprego. Esse nome normalmente seria mostrado aos usuários 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.

link
link string

Link na API pública para obter mais informações sobre esses dados.

Job

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para o Trabalho.

Pessoa
person Person

A pessoa a quem este trabalho pertence.

Recrutamento
recruitment Recruitment

Os detalhes de recrutamento armazenados para este trabalho.

Localização
location Location

A localização geográfica deste Trabalho.

PayGrade
payGrade PayGrade

O nível depagamento atual do trabalho no sistema.

BusinessUnit4
businessUnit BusinessUnit4

A unidade de negócios atual do trabalho no sistema.

BusinessEntity2
businessEntity BusinessEntity2

A entidade comercial atual do trabalho no sistema.

SupervisorJob
supervisorJob SupervisorJob

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

SupervisorPerson
supervisorPerson SupervisorPerson

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

RemunerationSchedule
remunerationSchedule RemunerationSchedule

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

nome
name string

O nome/cargo deste trabalho.

Fte
fte number

O equivalente em tempo integral deste Trabalho. Indicando a carga de trabalho de um funcionário que pode ser comparável em diferentes contextos. Isso é nulo para pessoas sem um FTE.

workClass
workClass string

A classe de trabalho deste trabalho. Esses são detalhes extras sobre o Tipo de Trabalho.

workType
workType string

Esta é a Classificação de Trabalho para este Trabalho, que é usada para diferenciar entre funcionários em tempo integral e meio período versus voluntários não remunerados. Enumeração: Permanent, Fixed Contract, , Unpaid, Temporary/Casual. Independent Contract

jobStatus
jobStatus string

O status atual deste trabalho dentro desta organização. Enumeração: Past Job, Future Job, , Ending Job. Current Job

companyStartDate
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.

companyEndDate
companyEndDate string

A data em que este Trabalho terminou ou terminará dentro da organização ou nula se não houver uma data de término. Esta data seguirá o formato definido por RFC3339.

isEndDateConfirmed
isEndDateConfirmed boolean

Se a data de término foi finalizada no aplicativo intelliHR.

turnoverType
turnoverType string

O tipo de volume de negócios desse fim de trabalho é classificado como.

turnoverReason
turnoverReason string

O nome do motivo do volume de negócios.

createdAt
createdAt string

Quando esse registro foi criado. Esta data seguirá o formato definido por RFC3339.

Trabalho4

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para o Trabalho.

nome
name string

O nome/cargo deste trabalho.

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 nula se não houver uma data de término. Esta data seguirá o formato definido por RFC3339.

jobStatus
jobStatus string

O status atual deste trabalho dentro desta organização. Enumeração: Past Job, Future Job, , Ending Job. Current Job

link
link string

Link na API pública para obter mais informações sobre esses dados.

Trabalho7

O trabalho da pessoa que fez o treinamento.

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para o trabalho do treinamento.

nome
name string

O nome do Trabalho de Pessoas que fez o Treinamento.

startDate
startDate string

A data de início efetiva dos Trabalhos . Esta data seguirá o formato definido por RFC3339.

data de término
endDate string

A data de término efetiva dos Trabalhos . Esta data seguirá o formato definido por RFC3339.

jobStatus
jobStatus string

O esquema de status. Enumeração: Past Job, Future Job, , Ending Job. Current Job

link
link string

Link na API pública para obter mais informações sobre esses dados.

Links para outros recursos relacionados.

Nome Caminho Tipo Description
self
self string

A URL da página atual

primeiro
first string

A URL da primeira página

Prev
prev string

A URL da página anterior

próximo
next string

A URL da próxima página

último
last string

A URL da última página

Localização

A localização geográfica deste Trabalho.

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para o local deste trabalho.

nome
name string

Nome fornecido para este Local. Esse nome normalmente seria mostrado aos usuários do sistema.

address
address string

O endereço deste local.

link
link string

Link na API pública para obter mais informações sobre esses dados.

location5

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para o Local.

ID do pai
parentId string

A cadeia de caracteres do identificador para o Local pai ou nulo se não houver pai (este é um local de nível superior).

nome
name string

Nome fornecido para este Local. Esse nome normalmente seria mostrado aos usuários do sistema.

address
address string

O endereço deste local.

está ativado
isEnabled boolean

Especifica se os usuários podem selecionar esse Local em listas suspensas.

Meta

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

Nome Caminho Tipo Description
Paginação
pagination Pagination

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

Meta1

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

Nome Caminho Tipo Description
Asat
asAt string

O ponto no tempo para o qual essa resposta serve. Esta data seguirá o formato definido por RFC3339.

Meta2

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

Nome Caminho Tipo Description
Asat
asAt string

O ponto no tempo para o qual essa resposta serve. Esta data seguirá o formato definido por RFC3339.

Paginação
pagination Pagination

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

Meta8

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

Nome Caminho Tipo Description
Asat
asAt string

O ponto no tempo em que os dados nessa resposta são precisos. Esta data seguirá o formato definido por RFC3339.

Paginação
pagination Pagination

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

Paginação

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

Nome 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

Itens por limite de página

current_page
current_page integer

Página atual

total_pages
total_pages integer

Número total de páginas

PayGrade

O nível depagamento atual do trabalho no sistema.

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para o grau de pagamento deste trabalho.

nome
name string

Nome amigável dado ao Pay Grade.

codificar
code string

Código administrativo curto associado ao Pay Grade.

link
link string

Link na API pública para obter mais informações sobre esses dados.

payGrade5

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para o Pay Grade.

codificar
code string

Código administrativo curto associado ao Pay Grade.

nome
name string

Nome amigável dado ao Pay Grade.

está ativado
isEnabled boolean

Especifica se os usuários podem selecionar esse Pay Grade em listas suspensas.

Pessoa

A pessoa a quem este trabalho pertence.

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para a Pessoa à qual este Trabalho pertence.

nome de exibição
displayName string

Nome a ser exibido em todo o sistema para essa Pessoa. Geralmente, segue o padrão preferredName (firstName) lastName, mas pode ser configurado em todo o locatário para ser um formato diferente.

númeroDoFuncionário
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 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 locatário.

link
link string

Link na API pública para obter mais informações sobre esses dados.

Person7

A pessoa que fez o treinamento.

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para a Pessoa do Treinamento.

nome de exibição
displayName string

O nome da Pessoa que fez o Treinamento.

númeroDoFuncionário
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 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 locatário.

link
link string

Link na API pública para obter mais informações sobre esses dados.

Número de telefone

Nome Caminho Tipo Description
número
number string

O número de telefone real.

fullNumber
fullNumber string

O número de telefone real com o código de área (se registrado).

é Primário
isPrimary boolean

Se esse for um número de telefone primário.

isPersonal
isPersonal boolean

Se esse for um número de telefone pessoal.

PrimaryEmailAddress1

Informações sobre o endereço de email principal dessa pessoa ou nulas se elas não tiverem informações de email.

Nome Caminho Tipo Description
email
email string

O endereço de email real.

isPersonal
isPersonal boolean

Indica se esse email é pessoal ou um email de trabalho.

PrimaryPhoneNumber1

Informações sobre o número de telefone primário dessa pessoa ou nulas se elas não tiverem números de telefone.

Nome Caminho Tipo Description
número
number string

O número de telefone real.

fullNumber
fullNumber string

O número de telefone real com o código de área (se registrado).

isPersonal
isPersonal boolean

Indica se esse número de telefone é pessoal ou de trabalho.

Fornecedor

O provedor de treinamento do treinamento.

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para o Provedor de Treinamento do Treinamento.

nome
name string

Nome amigável fornecido ao Provedor de Treinamento do Treinamento.

link
link string

Link na API pública para obter mais informações sobre esses dados.

Recrutamento

Os detalhes de recrutamento armazenados para este trabalho.

Nome Caminho Tipo Description
custar
cost number

O custo para recrutar este trabalho. Se for nulo, o custo não foi registrado.

moeda
currency string

A moeda usada para recrutar este trabalho. 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.

Source
source Source

A Fonte de Recrutamento deste trabalho foi originada ou nula se não foi registrada.

recruitmentSource

Nome 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.

ID do pai
parentId string

A cadeia de caracteres do identificador para a fonte de recrutamento pai ou nula se não houver pai (esta é uma fonte de recrutamento de nível superior).

está ativado
isEnabled boolean

Especifica se os usuários podem selecionar essa Fonte de Recrutamento em listas suspensas.

RemunerationSchedule

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

Nome Caminho Tipo Description
tipo
type string

O método no qual esse cronograma de remuneração é pago, se uma pessoa não for paga, então isso será No Remuneration Schedule. Enumeração: Annual Salary, Hourly Rate, No Remuneration Schedule.

baseAnnualSalary
baseAnnualSalary double

O Salário Base pago anualmente, isso é uma aproximação se eles são pagos por hora. Observe que, se baseAnnualSalary e baseHourlyRate forem fornecidos em uma solicitação de criação ou patch, o baseHourlyRate será ignorado.

baseHourlyRate
baseHourlyRate double

A Taxa Base paga por hora, isso é uma aproximação se eles são pagos anualmente. Observe que, se baseAnnualSalary e baseHourlyRate forem fornecidos em uma solicitação de criação ou patch, o baseHourlyRate será ignorado.

moeda
currency string

A moeda em que a base e o total dos valores 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.

hoursPerCycle
hoursPerCycle double

Quantas horas trabalhadas por payCycle.

payCycle
payCycle string

O ciclo em que o trabalho é pago. Enumeração: Weekly, Fortnightly, Monthly.

annualPackage
annualPackage double

O pacote total pago anualmente, incluindo adições e deduções. Esse valor é calculado adicionando o Salário Base Anual e adições menos as deduções.

hourlyPackage
hourlyPackage double

O pacote total pago por hora, incluindo adições e deduções. Esse valor é calculado dividindo o Pacote Anual pelo número total de horas por ano.

currencyConversionOccurred
currencyConversionOccurred boolean

Se alguma conversão tiver que ser executada entre moedas de adição e dedução ao calcular o pacote anual.

EmploymentCondition2
employmentCondition EmploymentCondition2

A Condição de Emprego sob a qual este trabalho está sendo pago.

Adições
additions array of Addition

Uma matriz de Adições para este Agendamento de Remuneração.

Deduções
deductions array of Deduction

Uma matriz de Deduções para este Agendamento de Remuneração.

additionsToTotal
additionsToTotal array of AdditionsToTotal

Uma matriz de Adições aplicadas ao pacote após todos os outros componentes deste Agendamento de Remuneração.

Avarias
breakdowns array of Breakdown

Uma matriz de Detalhamentos para este Agendamento de Remuneração. Os detalhamentos não serão usados para calcular o pacote total.

Source

A Fonte de Recrutamento deste trabalho foi originada ou nula se não foi registrada.

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para a fonte de recrutamento deste trabalho.

nome
name string

O nome dado a esta Fonte de Recrutamento.

link
link string

Link na API pública para obter mais informações sobre esses dados.

SupervisorJob

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

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para o trabalho do supervisor deste trabalho.

jobStatus
jobStatus string

O status atual deste trabalho dentro desta organização. Enumeração: Past Job, Future Job, , Ending Job. Current Job

nome
name string

O nome/cargo do trabalho do supervisor.

link
link string

Link na API pública para obter mais informações sobre esses dados.

SupervisorPerson

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

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para a Pessoa do Supervisor deste trabalho.

nome de exibição
displayName string

Nome a ser exibido em todo o sistema para essa Pessoa. Geralmente, segue o padrão preferredName (firstName) lastName, mas pode ser configurado em todo o locatário para ser um formato diferente.

númeroDoFuncionário
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 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 locatário.

link
link string

Link na API pública para obter mais informações sobre esses dados.

Training

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para o Treinamento.

nome
name string

Nome amigável dado a este Treinamento.

Person7
person Person7

A pessoa que fez o treinamento.

Trabalho7
job Job7

O trabalho da pessoa que fez o treinamento.

Coordenador
coordinator Coordinator

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

horas
hours string

Quantas horas foram gastas neste treinamento.

moeda
currency string

A moeda usada para isso [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.

custar
cost string

O custo deste Treinamento.

Fornecedor
provider Provider

O provedor de treinamento do treinamento.

Tipo
type Type

O tipo de treinamento do treinamento.

data de conclusão
completionDate string

O carimbo de data/hora em que o Treinamento foi concluído. Esta data seguirá o formato definido por RFC3339.

createdAt
createdAt string

Quando esse registro foi criado. Esta data seguirá o formato definido por RFC3339.

updatedAt
updatedAt string

Quando este registro foi atualizado pela última vez. Esta data seguirá o formato definido por RFC3339.

trainingProviders

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para o Provedor de Treinamento.

nome
name string

Nome amigável fornecido ao Provedor de Treinamento.

isDefault
isDefault boolean

Indica se esse Provedor de Treinamento será usado como padrão ao criar um registro de treinamento .

trainingTypes

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para o tipo de treinamento.

nome
name string

Nome amigável fornecido 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 treinamento do treinamento.

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para o tipo de treinamento do treinamento.

nome
name string

Nome amigável dado ao tipo de treinamento do treinamento.

link
link string

Link na API pública para obter mais informações sobre esses dados.

WebhookEvent

O evento webhook que disparou esse Webhook.

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para o Evento do Webhook.

nome
name string

A chave de evento exclusiva legível para este Evento do Webhook.

evento
event string

A lesma do evento webhook.

link
link string

Link na API pública para obter mais informações sobre esses dados.

WorkClassesSchema

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para a Classe Corporativa.

nome
name string

Nome dado a esta Classe de Trabalho. Esse nome normalmente seria mostrado aos usuários do sistema.

WorkType2
workType WorkType2

O tipo de trabalho pai desta classe de trabalho.

está ativado
isEnabled boolean

Especifica se os usuários podem selecionar esse Tipo de Trabalho nas listas suspensas.

WorkRight2

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para a direita de trabalho.

nome
name string

Nome dado a este direito de trabalho. Esse nome normalmente seria mostrado aos usuários do sistema.

countryId
countryId string

A cadeia de caracteres do identificador para o País.

country
country string

O valor do nome do País atribuído.

WorkRights

Mostrar os direitos de trabalho da pessoa

Nome Caminho Tipo Description
nome
name string

O tipo dos direitos de trabalho

country
country string

O país onde os direitos de trabalho são válidos

data de expiração
expirationDate string

A data em que os direitos de trabalho estão expirando

WorkType2

O tipo de trabalho pai desta classe de trabalho.

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para o tipo de trabalho desta classe de trabalho.

nome
name string

O nome do Tipo de Trabalho. Enumeração: Permanent, Fixed Contract, , Unpaid, Temporary/Casual. Independent Contract

link
link string

Link na API pública para obter mais informações sobre esses dados.

workType4

Nome Caminho Tipo Description
id
id string

A cadeia de caracteres do identificador para o Tipo de Trabalho.

nome
name string

O nome do Tipo de Trabalho. Enumeração: Permanent, Fixed Contract, , Unpaid, Temporary/Casual. Independent Contract

está ativado
isEnabled boolean

Especifica se os usuários podem selecionar esse Tipo de Trabalho nas listas suspensas.

cadeia

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