Integrações HCM
Introdução
API do ecossistema HCM que possibilita a manipulações gerais de informações.
A URL base oficial da API pode ser acessada através do endereço: https://hcmservices.teknisa.com/index.php
Como parâmetros de cada requisição, é necessário o CLIENT_SECRET e o CLIENT_ID. Para obtê-los entre em contato com a equipe Teknisa HCM.
Tipos suportados
- Integer: Apenas valores númericos
- Data: String em formato “DD/MM/YYYY”
- String: Sequência de caracteres
Documentação da API
Útil
Abaixo serão descritos endpoints de funções gerais da API:
Access Token
Esse endpoint é necessário para a geração de um token de acesso que será utilizado nas demais rotas da API.
Empresa
Conjunto de endpoints responsáveis por buscar/manipular informações de empresas dentro do contexto HCM.
Busca Estrutura Por Tipo
Retorna os dados referentes as estruturas.
Busca Centros de Custo
Retorna os dados referentes as estruturas do tipo CENTRO CUSTO.
Busca Departamentos
Retorna os dados referentes as estruturas do tipo DEPARTAMENTO.
Busca Equipes
Função que retorna os dados referentes as estruturas do tipo LOCAL.
Cria Estrutura
Função responsável por criar uma estrutura.
Cria Quadro de Vagas
Função responsável por criar um quadro de vagas.
Empresa – Auxiliares
Busca Tipos de Estruturas
Retorna os tipos de estruturas cadastradas na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Tipo de Demissão
Retorna os tipos de demissão cadastrados na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Motivo Rescisão
Retorna os motivos de rescisão cadastrados na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Empresa – AFD
Importação AFD
Retorna mensagem de sucesso – de acordo com as marcações existentes -, ou mensagem de erro – na ausência de vínculos, ou no caso de registros com status de rescisão.
Login REP
Retorna informações dos pontos de acesso.
Busca Pontos Acesso REP
Retorna informações dos pontos de acesso.
Colaborador
Conjunto de endpoints responsáveis por buscar/manipular informações dos colaboradores dentro do contexto HCM.
Busca Demitidos
Retorna os dados de vínculos demitidos.
Busca Alterações Escala
Retorna os dados referentes às alterações de escala dos colaboradores.
Busca Colaboradores
Retorna os dados referentes aos colaboradores.
Busca Alterações Ocupação
Retorna os dados referentes às alterações de ocupação dos colaboradores.
Busca Afastamentos
Retorna os dados referentes aos afastamentos dos colaboradores.
Busca Férias
Retorna os dados referentes às férias dos colaboradores.
Busca Movimentação por Tipo
Retorna os dados referentes às movimentações de uma estrutura.
Cria Afastamento por Atestado Médico
Criar afastamento por atestado médico.
Busca Dados Pessoa
Retorna os dados referentes à pessoa: pessoa mestre e histórico, parceiro de negócio, endereço, forma de comunicação e conta.
Busca Marcações por CPF
Retorna todas as marcações de acordo com o período de tempo informado.
Cria Movimentação Gerencial Vínculo
Função responsável por criar movimentação gerencial para o vínculo.
Busca Vínculos por Data de Admissão
Função destinada ao retorno das informações dos vínculos de acordo com o período de admissão.
Busca Afastamento por Período
Função destinada ao retorno das informações dos vínculos afastados no período (no formato DD/MM/YYYY) do sistema HCM.
O período de busca dos afastamentos deve contemplar afastamentos que iniciaram, terminaram ou estão entre o período selecionado.
Exemplo:
Busca: 01/05/2023 a 05/05/2023
Retorna colaboradores que estão afastados neste período:
Período 1: Início: 01/04/2023 a Final: 03/05/2023;
Período 2: Início: 02/05/2023 a Final: 02/05/2023;
Período 3: 03/05/2023 a Final: 07/05/2023.
Busca Movimentação no Período
Função destinada ao retorno das informações das movimentações ocorridas no período (no formato DD/MM/YYYY)
O período de busca deve contemplar movimentações que iniciaram, terminaram ou estão entre o período selecionado.
Exemplo:
Busca: 01/05/2023 a 05/05/2023
Retorna movimentações neste período:
Período 1: 01/04/2023 a Final: 03/05/2023;
Período 2: 02/05/2023 a Final: 02/05/2023;
Período 3: 03/05/2023 a Final: 07/05/2023;
Período 4: 03/05/2023 a Final: vazio (movimentação em vigor).
Busca Alteração de Cargo
Função destinada ao retorno das informações de alteração dos cargos no período (no formato DD/MM/YYYY).
O período de busca deve contemplar alterações de cargo que iniciaram, terminaram ou estão entre o período selecionado.
Exemplo:
Busca: 01/05/2023 a 05/05/2023
Retorna alterações de cargo neste período:
Período 1: Início: 01/04/2023 a Final: 03/05/2023;
Período 2: 02/05/2023 a Final: 02/05/2023;
Período 3: 03/05/2023 a Final: 07/05/2023;
Período 4: 03/05/2023 a Final: vazio (alteração de cargo em vigor).
Busca Movimentação
Função destinada ao retorno das informações de alteração de estrutura legal (empresa) no período (no formato DD/MM/YYYY).
Tipo 1: Movimentação Legal (Empresa)
Tipo 2: Movimentação Gerencial (Local)
O período de busca deve contemplar movimentações que iniciaram, terminaram ou estão entre o período selecionado.
Exemplo:
Busca: 01/05/2023 a 05/05/2023
Retorna movimentações neste período:
Período 1: Início: 01/04/2023 a Final: 03/05/2023;
Período 2: Início: 02/05/2023 a Final: 02/05/2023;
Período 3: Início: 03/05/2023 a Final: 07/05/2023;
Período 4: Início: 03/05/2023 a Final: vazio (movimentação em vigor).
Cria Admissão Simplificada
Rota responsável por criar uma admissão para um vínculo que ficará pendente para aprovação.
OBSERVAÇÃO: Para os valores possíveis, é possível que a organização crie novos valores. Os valores demonstrados são os comuns a todas organizações.
Cria Admissão Completa
Rota responsável por criar uma admissão para um vínculo que ficará pendente para aprovação.
OBSERVAÇÃO: Para os valores possíveis, é possível que a organização crie novos valores. Os valores demonstrados são os comuns a todas organizações.
Busca Contra Cheque
Retorna os dados referentes ao contra cheque/holerite dos colaboradores.
Busca Pontos do Vínculo
Retorna os dados referentes aos pontos do colaborador em um determinado período.
Busca Marcações Ponto Espelho
Retorna os dados referentes à apuração de ponto de um vínculo, com um período especificado.
Colaborador – Auxiliares
Busca Cargos
Retorna os dados referentes às ocupações ou aos cargos.
Busca Tipo Ocupação
Retorna os tipos de ocupação cadastrados na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Solicitações Admissão
Retorna os dados referentes as solicitações de admissão criadas via portal do gestor.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Vínculo Empregatício
Retorna dados referente aos tipos de vínculos empregatícios.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Escala de Trabalho
Retorna dados referente às escalas de trabalho cadastradas pela organização.
Busca Turnos
Retorna dados referente aos turnos cadastradas pela organização.
Busca Estrutura
Busca as estruturas cadastradas para a organização.
Importante se atentar ao NMTIPOESTRUTURA.
Busca Tipo de Transferência
Busca os tipos de transferência existentes para uma determinada organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Estrutura Adicional Pelo Tipo
Busca as estruturas existentes na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Tipo Salário
Busca as estruturas existentes na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Tipo Relacionamento
Busca os tipos de relacionamentos existentes.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Tipo Dependente
Busca os tipos de dependentes existentes.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Tipo de Formação
Busca os tipos de formações existentes.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Curso Acadêmico
Busca os cursos acadêmicos cadastrados.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Instituição Estrutura
Busca instituições e estruturas cadastradas na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Área de Formação
Busca tipos de áreas de formação cadastradas na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Linha de Transporte Ativa
Busca linhas de transporte ativas cadastradas na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Tipo de Linha
Busca tipos de linhas de transporte cadastradas na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Integração Transporte
Busca os números de integração de tranposrte cadastradas na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Sentido da Linha
Busca os tipos de sentidos das linhas cadastradas na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Benefícios
Busca os benefícios cadastrados na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Nacionalidades
Busca as nacionalidades cadastradas na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Países
Busca os países cadastrados na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Estados
Busca os estados cadastrados na organização.
Busca Municípios
Busca os municípios cadastrados na organização.
Busca Grau Instrução
Busca os graus de instrução cadastrados na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Classificação Estrangeiro
Busca as classificações para estrageiros cadastrados na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Conselhos Regionais
Busca os conselhos regionais cadastrados na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Tipo de Admissão
Busca os tipos de admissão cadastrados na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Tipo de Endereço
Busca os tipos de endereço cadastrados na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Tipo de Logradouro
Busca os tipos de logradouro cadastrados na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Bancos
Busca os bancos cadastrados na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Agência
Busca as agências cadastradas na organização.
Busca Tipo de Conta Corrente
Busca os tipos de contas correntes cadastrados na organização.
OBSERVAÇÃO: Essa rota não possui parâmetros, somente é necessário passar corretamente os headers.
Busca Situações Funcionais
Função destinada ao retorno de todas as situações funcionais do sistema HCM para o respectivo cliente.
Ficha Financeira
Busca Pagamentos por CNPJ
Retorna os pagamentos por CNPJ, Data e Movimento.
Busca Resumo Contábil por CNPJ
Retorna os resumos contábeis por CNPJ e Mês.
Busca Resumo Despesa por Data
Retorna todas as despesas de um determinado dia, realizadas por um determinado CNPJ em um determinado movimento de folha.
Busca Lançamentos de Cálculo
Retorna lançamentos de cálculo conforme o filtro informado.
Cria Lançamento Lote
Função responsável por criar lotes e eventos, e seus itens.
