Guia de uso das APIs

Seja bem-vindo! A partir de agora, você pode explorar este ambiente que permite seu acesso às
informações do Sistema Integrado de Recursos Humanos da Metadados.

   

Implementação

Nesta etapa, o cliente deverá entrar em contato com a Metadados para execução do processo de instalação da API do Sistema. Em seguida, o cliente precisará publicar o Banco de Dados do Sistema para uma lista específica de IPs que será enviado pela nossa equipe por e-mail.

Após a publicação do banco de dados para os IPs listados, é necessário que o cliente forneça as seguintes informações para a equipe Metadados:

  • Tipo de Base (SQL Server ou Oracle)
  • Host (IP/DNS externo para acesso ao banco)
  • Porta (Porta de acesso externo)
  • Instância (Onde se encontra o banco de dados - caso houver)
  • Alias (Alias para acesso ao banco de dados - caso houver)
  • Database (Nome do banco de dados)
  • Usuário (Usuário para acesso ao banco)
  • Senha (Senha do usuário)
  • SID (SID - apenas para base Oracle)
  • Service Name (Service Name - apenas para base Oracle)

 

A Metadados recomenda que o cliente antes de realizar a configuração acima comfigure o banco de dados para trafegar os dados de forma criptografada. Para SQL Server basta realizar a configuração descrita no artigo https://suporte.metadados.com.br/kb/article/270980/configurar-ssl-no-sql-server?preview=true&revisionId=942723 Para banco de dados Oracle, o cliente deve verificar como realizar essa configuração. O sistema Metadados opera normalmente com essa configuração. Se o cliente tiver outros sistemas na mesma instância do banco de dados é necessário verificar com seu fornecedor os possíveis impactos.

 

Após fornecer esses dados, a equipe irá criar um acesso exclusivo para o cliente na plataforma de API e, então, enviará para o cliente o token para ser utilizado nas consultas dos recursos da API.

 

Observações:

Caso deseje utilizar os recursos do PortalRH, é necessária a realização de uma configuração à parte, conforme descrita no link: https://www.metadados.com.br/documentacaoAPIPortalRH

Clientes SaaS não precisam realizar a publicação do banco de dados, pois a mesma é efetuada pela TI da Metadados.

Após a entrega do token para o cliente, é de responsabilidade do mesmo a distribuição e utilização deste. É importante lembrar que a API possui recursos que retornam dados sensíveis como salários, CPFs, entre outros.

   

Autenticação

A autenticação da API é realizada após informar o basic token no parâmetro Authorization do header nas chamadas, no seguinte modelo: "Basic " + token.

Esse token é gerado a partir da criptografia em Base 64 de [Client ID]:[Client Secret] e sua geração ocorre após a configuração dos dados para conexão com o banco de dados.

   

Status Codes

Código Erro Descrição
200 OK

Sucesso.
400 Bad Request

A requisição possui parâmetro(s) inválido(s).
401 Unauthorized

O token de acesso não foi informado ou não possui acesso as APIs.
404 Not Found

O recurso informado no request não foi encontrado.
413 Request is to Large

A requisição está ultrapassando o limite permitido para o perfil do seu token de acesso.
422 Unprocessable Entity

A requisição possui erros de negócio.
429 Too Many Requests

O consumidor estourou o limite de requisições por tempo.
500 Internal Server Error

Erro não esperado, algo está quebrado na API.

 

Número Máximo de Registros

A API hoje retorna até 100 registros por chamada, retornando um objeto vazio {} em chamadas que ultrapassassem esse limite. Portanto, para um melhor desempenho, recomendamos a utilização dos parâmetros offset e limit nos recursos onde estes estão disponíveis.

1. Cadastros

1.1 /bancos

Campos retornados no recurso bancos:

Campo Formato Tamanho Descrição
banco character 4 Código do Banco
descricao character 40 Descrição do Banco
formapagto character 1

Forma de Pagamento:

  • 1 - Em Espécie
  • 2 - Em Cheque
  • 3 - Documento de Compensação (DOC)
  • 4 - Depósito em CC
  • 5 - Depósito em Poupança
  • 6 - Depósito para Saque com Cartão
nrobanco character 4 Número do Banco
agencia character 20 Nome da Agência
nroagencia character 4 Número da Agência
digitoagencia character 1 Dígito da Agência
contacorrenteestpag character 15 Conta do Estabelecimento Pagador
estabelecimento character 4 Código do Estabelecimento, ref. /estabelecimentos
bancpagador character 1  Banco Pagador:
  • S - Sim
  • N - Não

Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ bancos?banco=0001&offset=0&limit=100


Query Params:

banco
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.2 /cargos

Campos retornados no recurso cargos:

Campo Formato Tamanho Descrição
cargo character 8 Código do Banco
descricao character 40 Descrição do Banco
cbo character 5 Código do CBO Antigo
cbonovo character 6 Código do CBO Novo


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ cargos?cargo=0101&offset=0&limit=100


Query Params:

cargo
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.3 /centrosCusto

Campos retornados no recurso de centros de custo 1:

Campo Formato Tamanho Descrição
centrocusto1 character 4 Código do Centro de Custo 1
descricao character 40 Descrição do Centro de Custo 1


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/centrosCusto?centrocusto=0001&ativo=true&offset=0&limit=100


Query Params:

centrocusto
ativo (true: retorna somente os registros ativos; false: retorna somente os registros inativos)
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.4 /centrosCusto2

Campos retornados no recurso de centros de custo 2:

Campo Formato Tamanho Descrição
centrocusto2 character 4 Código do Centro de Custo 2
descricao character 40 Descrição do Centro de Custo 2


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/centrosCusto2?centrocusto=0001&ativo=true&offset=0&limit=100


Query Params:

centrocusto
ativo (true: retorna somente os registros ativos; false: retorna somente os registros inativos)
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.5 /centrosCusto3

Campos retornados no recurso de centros de custo 3:

Campo Formato Tamanho Descrição
centrocusto3 character 4 Código do Centro de Custo 3
descricao character 40 Descrição do Centro de Custo 3


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/centrosCusto3?centrocusto=0001&ativo=true&offset=0&limit=100


Query Params:

centrocusto
ativo (true: retorna somente os registros ativos; false: retorna somente os registros inativos)
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.6 /centrosCusto4

Campos retornados no recurso de centros de custo 4:

Campo Formato Tamanho Descrição
centrocusto4 character 4 Código do Centro de Custo 4
descricao character 40 Descrição do Centro de Custo 4


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/centrosCusto4?centrocusto=0001&ativo=true&offset=0&limit=100


Query Params:

centrocusto
ativo (true: retorna somente os registros ativos; false: retorna somente os registros inativos)
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.7 /escalas

Campos retornados no recurso escalas:

Campo Formato Tamanho Descrição
escala character 4 Código da Escala
descricao character 60 Descrição da Escala
tipoescala character 1

Tipo Escala:

  • S - Simples
  • R - Revezamento
jornadaesocial character 4

Código da Jornada no eSocial
descjornadaesocial character 60

Descrição da Jornada no eSocial
horassemana character 5 Horas Semanais
horasrepouso character 5 Horas de Repouso
iniciovalidade datetime 8 Data de Início da Validade
terminovalidade datetime 8 Data de Término da Validade
ultalteracao datetime 8 Data da Última Alteração


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ escalas?escala=0001&offset=0&limit=100


Query Params:

escala
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.8 /horarios

Campos retornados no recurso horários:

Campo Formato Tamanho Descrição
horario character 4 Código do Horário
descricao character 40 Descrição do Horário
tipohorario character 1

Tipo de Horário:

  • 1 - Fixo
  • 2 - Móvel
  • 3 - Alternativo
  • 4 - Flexível
separacaodia character 5 Separação Dia do Horário


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ horarios?horario=0001&ativo=true&offset=0&limit=100


Query Params:

horario
ativo (true: retorna somente os registros ativos; false: retorna somente os registros inativos)
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.9 /escalasSemanais

Campos retornados no recurso de escalas semanais:

Campo Formato Tamanho Descrição
escala character 4 Código da Escala
descricao character 60 Descrição da Escala
diasemana character 1

Dia da Semana:

  • 1 - Segunda
  • 2 - Terça
  • 3 - Quarta
  • 4 - Quinta
  • 5 - Sexta
  • 6 - Sábado
  • 7 - Domingo
tipodiaescala character 1

Tipo de Dia Escala:

  • C - Compensado
  • D - Dispensado
  • P - Parcialmente Compensado
  • R - Repouso
  • T - Trabalhado
horario character 4 Código do Horário
descricao40 character 40 Descrição do Horário
horarioalternativo character 2 Código do Horário Alternativo
nroordem inteiro inteiro Ordem das Marcações
classemarcacao character 2

Classe da Marcação:

  • 01 - Início Jornada
  • 03 - Início Refeição
  • 04 - Término Refeição
  • 05 - Início Lanche
  • 06 - Término Lanche
  • 07 - Início Descanso
  • 08 - Término Descanso
  • 99 - Término Jornada
tipomarcacao character 1

Tipo de Marcação

  • 1 - Fixa
  • 2 - Móvel
horamarcacao character 5 Hora de Marcação
ativadesativada character 1

Ativo:

  • 1 - Ativa
  • 2 - Desativada


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/escalasSemanais?ativo=true&escala=0001&offset=0&limit=100


Query Params:

ativo (true: retorna somente os registros ativos; false: retorna somente os registros inativos)
escala
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.10 /horariosMarcacoes

Campos retornados no recurso de horários marcações:

Campo Formato Tamanho Descrição
horario character 4 Código do Horário
nroordem inteiro inteiro Ordem das Marcações
classemarcacao character 2

Classe da Marcação:

  • 01 - Início da Jornada
  • 03 - Início da Refeição
  • 04 - Término da Refeição
  • 05 - Início do Lanche
  • 06 - Término do Lanche
  • 07 - Início do Descanso
  • 08 - Término do Descanso
  • 99 - Término da Jornada
tipomarcacao character 1

Tipo de Dia Escala:

  • 1 - Fixa
  • 2 - Móvel
horamarcacao character 5 Hora de Marcação
toleranciaantes character 5 Hora de Tolerância Antes
toleranciadepois character 5 Hora de Tolerância Após


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/horariosMarcacoes?horario=0001&offset=0&limit=100


Query Params:

horario 
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.11 /funcoes

Campos retornados no recurso funções:

Campo Formato Tamanho Descrição
funcao character 4 Código da Função
descricao character 40 Descrição da Função
cbo character 6 Código do CBO Antigo
cbonovo character 6 Código do CBO Novo


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ funcoes?funcao=0001&offset=0&limit=100


Query Params:

funcao
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.12 /setores

Campos retornados no recurso setores:

Campo Formato Tamanho Descrição
setor character 4 Código do Setor
descricao40 character 40 Descrição do Setor


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ setores?setor=0001&ativo=true&offset=0&limit=100


Query Params:

setor
ativo (true: retorna somente os registros ativos; false: retorna somente os registros inativos)
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.13 /classificacoesGerenciais

Campos retornados no recurso de classificações gerenciais:

Campo Formato Tamanho Descrição
classificacaogerencial character 8 Código da Classificação Gerencial
descricao character 40 Descrição da Classificação Gerencial
unidade character 4 Unidade do Gestor, ref. /unidades
contrato numérico 8 Contrato do Gestor, ref. /contratos


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ classificacoesGerenciais?classificacaoGerencial=0001&ativo=true&offset=0&limit=100


Query Params:

classificacaoGerencial
ativo (true: retorna somente os registros ativos; false: retorna somente os registros inativos)
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.14 /classificacoesContabeis

Campos retornados no recurso de classificações contábeis:

Campo Formato Tamanho Descrição
classificacaocontabil character 8 Código da Classificação Contábil
descricao character 40 Descrição da Classificação Contábil


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ classificacoesContabeis?classificacaoContabil=0001&ativo=true&offset=0&limit=100


Query Params:

classificacaoContabil
ativo (true: retorna somente os registros ativos; false: retorna somente os registros inativos)
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.15 /sindicatos

Campos retornados no recurso sindicatos:

Campo Formato Tamanho Descrição
sindicato character 4 Código do Sindicato
descricao character 60 Descrição do Sindicato
codigoentidade character 16 Código da Entidade
inscricao character 16 Inscrição do Sindicato
rua character 40 Rua
nrorua character 8 Número da Rua
complemento character 20 Complemento
bairro character 20 Bairro
cidade character 20 Cidade
cep character 10 CEP
uf character 2 UF
mesdissidio character 2 Mês do Dissídio
contato character 40 Contato
ddd character 4 DDD
telefone character 15 Telefone
ramal character 4 Ramal
dddfax character 4 DDD do Fax
telefonefax character 15 Fax
ramalfax character 4 Ramal do Fax
email character 80 E-mail


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ sindicatos?sindicato=0001&offset=0&limit=100


Query Params:

sindicato
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.16 /vinculosEmpregaticios

Campos retornados no recurso vínculos empregatícios:

Campo Formato Tamanho Descrição
vinculoempregaticio character 4 Código do Vínculo Empregatício
descricao character 40 Descrição do Vínculo Empregatício
vinculoempregaticiorais character 2 Vínculo Empregatício para RAIS
categoriasefip character 2 Categoria SEFIP
opcaoprevidencia character 1

Opção Previdência:

  • 0 - Nenhuma
  • 1 - INSS
  • 2 - Outra Previdência
vinculoprevidencia character 1

Vínculo Previdência:

  • 0 - Não Recolhe
  • 1 - Empregado
  • 2 - Empregador
  • 3 - Autônomo
  • 4 - Freteiro
  • 5 - Médico Residente
  • 6 - Empregado Doméstico
  • 7 - Facultativo
  • 8 - Estagiário
  • I - Inativo
  • P - Pensionista
recolhefgts character 1 Recolhe FGTS:
  • S - Sim
  • N - Não
vinclosindicato character 1 Vínculo Sindicato:
  • S - Sim
  • N - Não
recebeferias character 1 Recebe Férias:
  • S - Sim
  • N - Não


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ vinculosEmpregaticios?vinculoEmpregaticio=0001&offset=0&limit=100


Query Params:

vinculoEmpregaticio
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.17 /feriasProgramadas

Campos retornados no recurso férias programadas:

Campo Formato Tamanho Descrição
unidade character 4 Código da Unidade, ref. /unidades
contrato numérico 8 Código do Contrato, ref. /contratos
inicioprogferias datetime 8 Início da Programação de Férias
terminoprogferias datetime 8 Término da Programação de Férias
diasferiasprogramados decimal 4,2 Dias de Férias Programados
diasabonoprogramados decimal 4,2 Dias de Abono Programados


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ feriasProgramadas?unidade=0001& contrato=41& inicioProgFerias>=2020-08-01&terminoProgFerias<=2020-08-31 & offset=0&limit=100


Query Params:

unidade
contrato
inicioProgFerias (YYYY-MM-DD): Podem ser utilizados os operadores >=, <= e =
terminoProgFerias (YYYY-MM-DD): Podem ser utilizados os operadores >=, <= e =
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.18 /feriasCedidas

Campos retornados no recurso férias cedidas:

Campo Formato Tamanho Descrição
unidade character 4 Código da Unidade, ref. /unidades
contrato numérico 8 Código do Contrato, ref. /contratos
iniciogozoferias datetime 8 Início do Gozo de Férias
terminogozoferias datetime 8 Término do Gozo de Férias
inicioperaquisitivo datetime 8 Início do Período Aquisitivo
terminoperaquisitivo datetime 8 Término do Período Aquisitivo
datafolha datetime 8 Data Folha
diasferiasrecibo decimal 4,2 Dias de Férias
diasabonorecibo decimal 4,2 Dias de Abono
origemferias character 1

Origem Férias:

  • C - Cálculo Coletivo
  • D - Digitada
  • I - Cálculo Individual


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ feriasCedidas? unidade=0001& contrato=41& inicioGozoFerias>=2020-08-01&terminoGozoFerias<=2020-08-31 & offset=0&limit=100


Query Params:

unidade
contrato
inicioGozoFerias (YYYY-MM-DD): Podem ser utilizados os operadores >=, <= e =
terminoGozoFerias (YYYY-MM-DD): Podem ser utilizados os operadores >=, <= e =
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.19 /ocorrencias

Campos retornados no recurso ocorrências:

Campo Formato Tamanho Descrição
ocorrencia character 4 Código da Ocorrência
descricao character 40 Descrição da Ocorrência
tipoocorrencia character 1

Tipo da Ocorrência:

  • 1 - Faltas
  • 2 - Acidente de Trabalho
  • 3 - Doença
  • 4 - Afastamentos Legais
  • 9 - Outros
geraafastamento character 1 Gera Afastamento:
  • S - Sim
  • N - Não
geraafastamentoponto character 1 Gera Afastamento Ponto:
  • S - Sim
  • N - Não
causaafastfolha character 1

Causa do Afastamento para Folha:

  • 1 - Acidente de Trabalho
  • 2 - Doença
  • 3 - Licença-gestante
  • 4 - Licença-prêmio
  • 5 - Serviço Militar
  • 6 - Licença sem Remuneração
  • 9 - Outras Causas
causaafastrais character 2 Causa do Afastamento para RAIS


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ ocorrencias? ocorrencia=0001& tipoOcorrencia=4& geraAfastamento=S& geraAfastamentoPonto =S & causaAfastFolha=9& causaAfastRais =98 & offset=0&limit=100


Query Params:

ocorrencia
tipoOcorrencia
geraAfastamento
geraAfastamentoPonto
causaAfastFolha
causaAfastRais
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.20 /registrosOcorrencias

Campos retornados no recurso registros de ocorrências:

Campo Formato Tamanho Descrição
unidade character 4 Código da Unidade, ref. /unidades
contrato numérico 8 Código do Contrato, ref. /contratos
ocorrencia character 4 Código da Ocorrência, ref. /ocorrencias
datainicioocorrencia datetime 8 Data de Início da Ocorrência
dataterminoocorrencia datetime 8 Data de Término da Ocorrência
datahoraalteracao datetime 8 Data e Hora da Alteração
tipooperacao character 1

Tipo Operação:

  • A - Alteração
  • E - Exclusão
  • I - Inclusão


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/registrosO correncias? unidade=0001& contrato=41& ocorrencia=0001& tipoOperacao=I& dataInicioOcorrencia>=2020-08-01&dataTerminoOcorrencia<=2020-08-31 & offset=0&limit=100


Query Params:

unidade
contrato
ocorrencia
tipoOperacao
dataInicioOcorrencia (YYYY-MM-DD): Podem ser utilizados os operadores >=, <= e =
dataTerminoOcorrencia (YYYY-MM-DD): Podem ser utilizados os operadores >=, <= e =
dataHoraAlteracao (YYYY-MM-DD): Podem ser utilizados os operadores >=, <= e =
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.21 /planosCargos

Campos retornados no recurso registros de planos de cargos:

Campo Formato Tamanho Descrição
planocargo character 4 Código do Plano de Cargo
descricao character 40 Descrição do Plano de Cargo
tiposalario character 1

Tipo Salário:

  • 1 - Mensal
  • 2 - Por Quinzena
  • 3 - Por Semana
  • 4 - Por Dia
  • 5 - Por Hora
  • 6 - Por Tarefa
  • 7 - Outros
horascontratuais decimal 5,2 Horas Contratuais


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/planosCargos ? planoCargo=0001& ativo=true & offset=0&limit=100


Query Params:

planoCargo
ativo (true: retorna somente os registros ativos; false: retorna somente os registros inativos)
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.22 /preAdmissao

A documentação deste recurso, sua formatação e exemplos podem ser acessados através do seguinte link: https://www.metadados.com.br/documentacaoAPIPreAdmissao


URL de chamada:

https://metadados.gateway.linkapi.com.br/v4/sirh/preAdmissao

Operação: POST

Formato Retorno: JSON

 

1.23 /atestados

Campos a serem enviados para o recurso atestados:

Campo Obrigatório Formato Tamanho Descrição
empresa S character 4 Código da Empresa, ref. /empresas
unidade S character 4 Código da Unidade, ref. /unidades
pessoa S numérico 8 Código da Pessoa, ref. /dadosPessoais
contrato S numérico 8 Código do Contrato, ref. /contratos
beneficiarioservico S character 1

Beneficiário Serviço:

  • T – Titular
  • D - Dependente
familiar Se informado "D" acima numérico 8  Código do Familiar, ref. /familiares
nomearquivo N character 250 Nome do Arquivo
anexo N imagem   Atestado Escaneado
dataemissao S datetime 8 Data de Emissão
tipoinfoatest S character 1

Tipo de Informação:

  • 1 – Dias
  • 2 – Horas/Dia
  • 3 – Faixa Horas  
nrodiasatestado Se o Tipo de Informação for "1" ou "2" decimal 15,2 Número de Dias
horainicioatestado S character 5 Hora de Início do Atestado
horaterminoatestado S character 5 Hora de Término do Atestado
justificativa N character 250 Justificativa
observacao N character 250 Observações
ocorrencia S character 4 Código da Ocorrência, ref. /ocorrencias
cid N array[character] 10 Array para envio de um ou mais CID vinculados ao atestado


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ atestados


Exemplo de Body:

{
"empresa":"0001",
"unidade":"0001",
"pessoa":1,
"contrato":1,
"beneficiarioServico":"D",
"familiar":3,
"nomeArquivo":"atestado.jpg",
"anexo":"JG2VnCZGfo4R4d0sdQoBAHhPjhIB94v/wRoRKQWGRHgrhGSQJxCS+0pCZbEhAAOw==",
"dataEmissao":"2020-11-03",
"tipoInfoAtest":"2",
"nroDiasAtestado":5,
"horaInicioAtestado":"08:00",
"horaTerminoAtestado":"17:55",
"justificativa":"Doença.",
"observacao":"Repouso.",
"ocorrencia":"007",
"cid":[
"A01.0",
"A03.8"
]
}

Operação: POST

Formato Retorno: JSON

 

1.24 /classesSalariais

Campos retornados no recurso registros de classes salariais:

Campo Formato Tamanho Descrição
planoCargo varchar 4 Código do plano salarial cadastrado no SIRH.
anoMesBase datetime   Mês / ano base do plano de cargo cadastrado.
classeSalarial varchar 4 Código da classe salarial vinculada ao plano.
descricao varchar 10 Descrição da classe salarial.
indiceVariacao decimal   Percentual de variação da classe salarial.


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/classesSalariais ? planoCargo=0002& classeSalarial=0002 & offset=0&limit=100


Query Params:

planoCargo
classeSalarial
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.25 /faixasSalariais

Campos retornados no recurso registros de faixas salariais:

Campo Formato Tamanho Descrição
planoCargo varchar 4 Código do plano salarial cadastrado no SIRH.
anoMesBase datetime   Mês / ano base do plano de cargo cadastrado.
classeSalarial varchar 4 Código da classe salarial vinculada ao plano.
faixaSalarial varchar 4 Código da faixa salarial vinculada ao plano.
salarioContratual decimal   Salário contratual definido no plano / classe / faixa.
indice decimal   Percentual de variação da classe salarial.


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/faixasSalariais ? planoCargo=0002& classeSalarial=0002 & faixaSalarial=0002 & offset=0&limit=100


Query Params:

planoCargo
classeSalarial
faixaSalarial
offset
limit

Operação: GET

Formato Retorno: JSON

 

1.26 /gpssefip

Campos retornados no recurso registros de gpssefip:

Campo Formato Tamanho Descrição
classGpsSefip varchar 4 Código  da classe GPS/SEFIP.
anoMesCompetencia varchar 7 Mês / ano de início da validade GPS / SEFIP.
valorEmpresa decimal   Valor da Empresa.
valorSegurados decimal   Valor de Segurados.
valorTerceiros decimal   Valor de Terceiros.
valorProdutosRurais decimal   Valor de Produtos Rurais.
valorTerceirosProdr decimal   Valor de Terceiros Produtos Rurais.
valorCooperativas decimal   Valor de Cooperativas.
valorRetido decimal   Valor retido NF.
valorRetidoPr decimal   Valor retido NF Produtos Rurais.
valorDeduzir decimal   Valor de Deduções
valorCompensar decimal   Valor Compensado.
valorCompensarPr decimal   Valor Compensado Produtos Rurais.
compensouAteLimite char 1 Valor Compensado até o limite:
N - Não
S - Sim
liquidoGpsPago decimal   Valor Líquido da GPS pago.
liquidoCompetencia decimal   Valor Líquido da Competência.
saldoCompensacao decimal   Saldo a Compensar.
saldoRetido decimal   Valor Retido.
anoMesRecolhimento varchar 7 Mês / ano recolhimento.
dataVencimento datetime   Data de vencimento.
dataPagamento datetime   Data de Pagamento.
AnoMesRecolhimentoPr varchar 7 Mês / ano recolhimento Produtos Rurais.
dataVencimentoPr datetime   Data de vencimento Produtos Rurais.
DataPagamentoPr datetime   Data de Pagamento Produtos Rurais.
dataEmissao datetime   Data de Emissão da GPS.
nroBanco varchar 3 Código do Banco.
nroAgencia varchar 4 Código da agência.
digitoAgencia varchar 1 Dígito da agência.
contaCorrente varchar 15 Número da conta corrente.
valorMultaJuros decimal   Valor da Multa / Juros.
nroRemessa int   Número da remessa bancária.
valorBaseSalarios decimal   Valor de base salarial.
valorBaseProLabore decimal   Valor de base salarial Pro Labore.
valorBaseAutonomos decimal   Valor de base salarial dos Autônomos.
valorBaseFretes decimal   Valor de base salarial dos Fretes.
valorBaseCooperativas decimal   Valor de base salarial das Cooperativas.
valorBaseProdRurais decimal   Valor de base salarial dos Produtos Rurais.
valorSegSalarios decimal   Valor do seguro de acidentes.
valorSegProLabore decimal   Valor do seguro de acidentes Pro Labore.
valorSegAutonomos decimal   Valor do seguro de acidentes dos Autônomos.
valorSegFretes decimal   Valor do seguro de acidentes dos Fretes.
valorEmprSalarios decimal   Valor dos salários.
valorEmprProLabore decimal   Valor do Pró-Labore
valorEmprAutonomos decimal   Valor dos autônomos.
valorEmprFretes decimal   Valor dos Fretes.
valorTercSalarios decimal   Valor dos salários de terceiros
valorTercFretes decimal   Valor dos fretes de terceiros
valorRat decimal   Valor do RAT.
valorSalFam decimal   Valor do Salário Família.
saldoSalFam decimal   Saldo do Salário Família.
valorSalMat decimal   Valor do Salário Maternidade.
saldoSalMat decimal   Saldo do Salário Maternidade.
valor13SalMat decimal   Valor do 13º Salário Maternidade.
saldo13SalMat decimal   Saldo do 13º Salário Maternidade.
liquidoProdRurais decimal   Valor Líquido dos Produtos Rurais.
liquidoTercFretes decimal   Valor Líquido dos Fretes de Terceiros.
multaJurosProdRurais decimal   Multa / Juros Produtos Rurais.
multaJurosTercFretes decimal   Multa / Juros Fretes Terceiros.
liquidoPRuraisPago decimal   Valor Líquido Produtos Rurais pagos.
liquidoTercFretesPago decimal   Valor Líquido Fretes Terceiros pagos.
anoMesRecolheFretes varchar 7 Ano / mês recolhimento Fretes.
dataVencimentoFretes datetime   Data de vencimento dos fretes.
dataPagamentoFretes datetime   Data de pagamento dos fretes.
valorEmpresaDis decimal   Valor de empresa do dissídio.
valorSeguradosDis decimal   Valor de segurados dissídio.
valorTerceirosDis decimal   Valor de terceiros dissídio.
valorRatDis decimal   Valor RAT dissídio.
valorCompensarDis decimal   Valor Compensar dissídio.
liquidoDissidio decimal   Valor Líquido dissídio.
multaJurosDissidio decimal   Multa / Juros dissídio.
liquidoDissidioPago decimal   Valor Líquido Dissídio pago.
anoMesRecolheDis varchar 7 Ano / mês recolhimento Dissídio.
dataVencimentoDis datetime   Data vencimento dissídio.
dataPagamentoDis datetime   Data pagamento dissídio.
valorSalMatDis decimal   Valor Salário Maternidade do dissídio.
saldoSalMatDis decimal   Saldo Maternidade dissídio.
valor13SalMatDis decimal   Valor 13º Salário Maternidade dissídio.
saldo13SalMatDis decimal   Saldo 13º Salário Maternidade dissídio.
DataVenctoCovid19 datetime   Data vencimento COVID19.
DataVenctoCovid19Dis datetime   Data vencimento COVID19 dissídio.
DataVenctoCovid19PRurais datetime   Data vencimento COVID19 Produtos Rurais.
dataVenctoCovid19Fretes datetime   Data vencimento COVID19 Fretes.
valorGuiaCovid19 decimal   Valor da guia COVID19.
valorGuiaCovid19Dis decimal   Valor da guia COVID19 dissídio.
valorGuiaCovid19PRurais decimal   Valor da guia COVID19 Produtos Rurais.
valorGuiaCovid19Fretes decimal   Valor da guia COVID19 Fretes.
estabelecimentoResponsavel varchar 4 Código do Estabelecimento Responsável pela GPS.
descricaoEstabelecimento varchar 20 Nome do Estabelecimento Responsável pela GPS.
empresa varchar 4 Código da empresa.
descricaoEmpresa varchar 20 Nome da empresa.


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/gpssefip ? anoMesCompetencia='2008/03'& classeGpsSefip=0005 & offset=0&limit=100


Query Params:

anoMesCompetencia
classeGpsSefip
offset
limit

Operação: GET

Formato Retorno: JSON

 

2. Colaboradores

2.1 /contratos

Campos retornados no recurso contratos.

Campo Formato Tamanho Descrição
empresa character 4 Código da Empresa, ref. /empresas
descricaoempresa character 20 Descrição da Empresa
pessoa numérico 8 Código da Pessoa
nome character 40 Nome da Pessoa
sexo character 1

Sexo:

  • M - Masculino
  • F - Feminino
cpf character 11 CPF da Pessoa
emailcorporativo character 80 E-mail Corporativo da Pessoa
unidade character 4 Código da Unidade, ref. /unidades
estabelecimento character 4 Código do Estabelecimento, ref. /estabelecimentos
razaosocialestabelecimento character 40 Razão Social do Estabelecimento
descricaodoestabelecimento character 20 Descrição do Estabelecimento
contrato numérico 8 Código do Contrato
cracha character 12 Crachá do Contrato
dataadmissao datetime 8 Data de Admissão do Contrato
mesescasa inteiro inteiro Meses de Casa do Contrato
anoscasa inteiro inteiro Anos de Casa do Contrato
dataavisoprevio datetime 8 Data de Aviso Prévio do Contrato
datarescisao datetime 8 Data de Rescisão do Contrato
terminocontrato datetime 8 Data de Término do Contrato
ultimodiatrabalhado datetime 8 Data do Último Dia Trabalhado
situacao character 1

Situação do Contrato:

  • 1 - Ativo
  • 2 - Afastado
  • 3 - Rescindido no mês
  • 4 - Rescindido em meses anteriores
dataultimoafastamento character 30 Data do Último Afastamento do Contrato
causaafastamento character 1

Causa do Afastamento:

  • 1 - Acidente de Trabalho
  • 2 - Doença
  • 3 - Licença-gestante
  • 4 - Licença-prêmio
  • 5 - Serviço Militar
  • 6 - Licença sem remuneração
  • 9 - Outras causas
dataultimoretorno datetime 8 Data do Último Retorno do Contrato
dataultimatransferencia datetime 8 Data da Última Transferência do Contrato
dataultimaalteracaocontrato datetime 8 Data da Última Alteração no Contrato
tipocontrato character 1

Tipo do Contrato:

  • 0 - Determinado por Fato
  • 1 - Determinado
  • 2 - Efetivo
  • 3 - Temporário
  • 4 - Autônomo
tiposalario character 1

Tipo Salário:

  • 1 - Mensal
  • 2 - Por Quinzena
  • 3 - Por Semana
  • 4 - Por Dia
  • 5 - Por Hora
  • 6 - Por Tarefa
  • 7 - Outros
salariocontratual decimal 11,2 Salário Contratual do Contrato
horascontratuais decimal 5,2 Horas Contratuais do Contrato
vinculoempregaticio character 2 Código do Vínculo Empregatício, ref. /vinculosEmpregaticios
banco character 4 Código do Banco, ref. /bancos
cargo character 8 Código do Cargo, ref. /cargos
planocargo character 4 Código do Plano de Cargo, ref. /planosCargos
descricaocargo character 40 Descrição do Cargo
funcao character 8 Código da Função, ref. /funcoes
descricaofuncao character 40 Descrição da Função
escala character 4 Código da Escala de Horários, ref. /escalas
descricaoescala character 40 Descrição da Escala de Horários
centrocusto1 character 8 Código do Centro de Custo Nível 1, ref. /centrosCusto
descricaocentrocusto1 character 40 Descrição do Centro de Custo Nível 1
centrocusto2 character 8 Código do Centro de Custo Nível 2, ref. /centrosCusto2
descricaocentrocusto2 character 40 Descrição do Centro de Custo Nível 2
centrocusto3 character 8 Código do Centro de Custo Nível 3, ref. /centrosCusto3
descricaocentrocusto3 character 40 Descrição do Centro de Custo Nível 3
centrocusto4 character 8 Código do Centro de Custo Nível 4, ref. /centrosCusto4
descricaocentrocusto4 character 40 Descrição do Centro de Custo Nível 4
postotrabalho character 8 Código do Posto de Trabalho
descricaopostotrabalho character 40 Descrição do Posto de Trabalho
setor character 8 Código do Setor, ref. /setores
descricaosetor character 40 Descrição do Setor
classificacaocontabil character 8 Código da Classificação Contábil
descclassificacaocontabil character 40 Descrição da Classificação Contábil
classificacaogerencial character 8 Código da Classificação Gerencial
descclassificacaogerencial character 40 Descrição da Classificação Gerencial
unidadeclassificacaogerencial character 4 Unidade da Classificação Gerencial
contratoclassificacaogerencial numérico 8 Contrato da Classificação Gerencial
contratonivelexposicao character 2 Nível de Exposição
descricaonivelexposicao character 60 Descrição do Nível de Exposição
categoriatrabalhador character 3 Código da Categoria do Trabalhador de acordo com o eSocial
descricaocategoriatrabalhador character 60 Descrição do Código da Categoria do Trabalhador de acordo com o eSocial
sindicato character 4 Código do Sindicato, ref. /sindicatos
descricaosindicato character 60 Descrição do Código do Sindicato, ref. /sindicatos
semregistroponto character 1

Sem Registro do Ponto:

  • S - Sim
  • N - Não
  • null - (não tem registro do ponto)
matriculaesocial character 30 A matrícula do empregado no eSocial

Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/contratos? offset=0& limit=10& unidade=0001& contrato=14& email=suporte@metadados.com.br& cpf=48380046187& dataAlteracao=2020-08-01& dataAdmissao=2020-05-01


Query Params:

unidade
contrato
email
cpf
dataRescisao (Obtém os rescindidos a partir da data enviada)
ativo (true: retorna somente contratos ativos; false: retorna somente contratos rescindidos e/ou afastados)
situacao
dataAlteracao (Obtém os contratos alterados a partir da data enviada)
dataAdmissao
offset
limit

Operação: GET

Formato Retorno: JSON

2.2 /dadosPessoais

Campos retornados no recurso dadosPessoais.

Campo Formato Tamanho Descrição
empresa character 4 Código da Empresa, ref. /empresas
pessoa numérico 8 Código da Pessoa, ref. /contratos
nome character 40 Nome da Pessoa
datacadastramento datetime 8 Data de Cadastramento da Pessoa
pai character 40 Nome do Pai da Pessoa
mae character 40 Nome da Mãe da Pessoa
nascimento datetime 8 Data de Nascimento da Pessoa
localnascimento character 20 Cidade de Nascimento da Pessoa
ufnascimento character 2 UF de Nascimento da Pessoa
sexo character 1

Sexo:

  • M - Masculino
  • F - Feminino
racacor character 1

Raça/Cor:

  • 1 - Indígena
  • 2 - Branca
  • 4 - Preta
  • 6 - Amarela
  • 8 - Parda
  • 9 - Não Informada
deficientefisico character 1

Deficiente Físico:

  • 0 - Não Deficiente
  • 1 - Deficiente Físico
  • 2 - Deficiente Auditivo
  • 3 - Deficiente Visual
  • 4 - Deficiente Mental (Intelectual)
  • 5 - Deficiente Múltiplo
estudando character 1 Estudando:
  • S - Sim
  • N - Não
ddd character 4 DDD da Pessoa
telefone character 15 Telefone da Pessoa
ramal character 4 Ramal da Pessoa
dddcelular character 4 DDD Celular da Pessoa
telefonecelular character 15 Telefone Celular da Pessoa
email character 80 E-mail da Pessoa
nrocarttrab character 10 Número da CTPS da Pessoa
seriecarttrab character 5 Série da CTPS da Pessoa
datacarttrab datetime 8  Data da CTPS da Pessoa 
ufcarttrab  character  2 UF da CTPS da Pessoa 
pis character 11  Número do PIS da Pessoa
datapis datetime 8 Data do PIS da Pessoa
cpf character 11 CPF da Pessoa
tipoidentidade character 2

Tipo da Identidade:

  • RE
  • RG
identidade character 15 Identidade da Pessoa
dataidentidade datetime 8 Data da Identidade da Pessoa
orgaoemissoridentidade character 8 Orgão Emissor da Identidade da Pessoa
ufidentidade character 2 UF da Identidade
tituloeleitoral character 15 Título Eleitoral da Pessoa
zonaeleitoral character 4 Zona Eleitoral da Pessoa
secaoeleitoral character 4 Seção Eleitoral da Pessoa
tiposanguineo character 3

Tipo Sanguíneo:

  • A+
  • A-
  • AB+
  • AB-
  • B+
  • B-
  • O+
  • O-
estadocivil character 2

Estado Civil:

  • 01 - Solteiro
  • 02 - Casado
  • 03 - Viúvo
  • 04 - Separado
  • 05 - Divorciado
  • 06 - União Estável Solteiro
  • 07 - União Estável Divorciado
  • 08 - União Estável Viúvo
grauinstrucao character 2

Grau de Instrução:

  • 01 - Analfabeto
  • 02 - Até o 5º Ano Incompleto do Ensino Fundamental
  • 03 - 5º Ano Completo do Ensino Fundamental
  • 04 - Do 6º ao 9º Ano do Ensino Fundamental
  • 05 - Ensino Fundamental Completo
  • 06 - Ensino Médio Incompleto
  • 07 - Ensino Médio Completo
  • 08 - Técnico
  • 09 - Educação Superior Incompleta
  • 10 - Educação Superior Completa
  • 11 - Pós-Graduação
  • 12 - Mestrado
  • 13 - Doutorado

OBS: É possível que a tabela de grau de instrução seja customizada, portanto, os códigos podem apresentar diferenças em relação aos listados acima.
nacionalidade character 2

Código da Nacionalidade da Pessoa.

OBS: Com exceção do código 50 que é correspondente ao 80 na RAIS (Outros).
sindicato character 4 Código Sindicato da Pessoa, ref. /sindicatos
emailcorporativo character 80 E-mail Corporativo da Pessoa
reservista character 20 Certificado de Reservista da Pessoa
registrohabilitacao character 15 Registro da Habilitação da Pessoa
validadehabilitacao datetime 8 Data de Validade da Habilitação da Pessoa
categoriahabilitacao character 3 Categoria da Habilitação da Pessoa
dataultimaalteracaopessoa datetime 8 Data da Última Alteração na Pessoa

Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/dadosPessoais?empresa=0001&pessoa=298&offset=0&limit=100&dataAlteracao=2020-08-01


Query Params:

empresa
pessoa
dataAlteracao (Obtém as pessoas alteradas a partir da data enviada)
offset
limit

Operação: GET

Formato Retorno: JSON

 

2.3 /familiares

Campos retornados no recurso familiares.

Campo Formato Tamanho Descrição
empresa character 4 Código da Empresa, ref. /empresas
pessoa numérico 8 Código da Pessoa, ref. /dadosPessoais
familiar numérico 8 Código do Familiar
nome character 40 Nome do Familiar
nascimento datetime 8 Data de Nascimento do Familiar
grauparentesco character 1

Grau de Parentesco:

  • 0 - Nenhum Parentesco
  • 1 - Filho(a) ou Enteado(a)
  • 2 - Neto(a)
  • 3 - Bisneto(a)
  • 4 - Esposo(a)
  • 5 - Pai ou Mãe
  • 6 - Avô ou Avó
  • 7 - Bisavô ou Bisavó
  • 9 - Outro Parentesco
  • A - Irmão(a)
  • B - Sobrinho(a)
  • C - Sogro(a)
  • D - Nora/Genro
graudependencia character 1

Grau de Dependência:

  • 0 - Nenhuma Dependência
  • 1 - Menor de 21 anos
  • 2 - Menor de 25 anos Estudante
  • 3 - Inválido
  • 4 - Cônjuge sem renda
  • 5 - Idoso sem renda
  • 6 - Filha Solteira maior de 21 anos


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/familiares?empresa=0001&pessoa=10020007&dependente=true&offset=0&limit=100


Query Params:

empresa
pessoa
dependente (true: retorna somente os dependentes; false: retorna somente os não dependentes)
offset
limit

Operação: GET

Formato Retorno: JSON

 

2.4 /enderecos

Campos retornados no recurso endereços.

Campo Formato Tamanho Descrição
complemento character 20 Complemento (endereço)
contrato character 8 Código do Contrato, ref. /contratos
empresa character 4 Código da Empresa, ref. /empresas
cep character 10 CEP
pessoa numérico 8 Código da Pessoa, ref. /dadosPessoais
nrorua character 8 Número (endereço)
uf character 2 UF
bairro character 20 Bairro
cpf character 11 CPF
nome character 40 Nome da Pessoa
cidade character 20 Cidade
unidade character 4 Código da Unidade, ref. /unidades
rua character 40 Rua (endereço)

Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/enderecos?offset=0&limit=10&empresa=0001&pessoa=10020007&unidade=1003&contrato=16&email=suporte@metadados.com.br&cpf=48380046187


Query Params:

empresa
pessoa
unidade
contrato
email
cpf
offset
limit

Operação: GET

Formato Retorno: JSON

 

2.5 /dadosComplementaresContrato

Campos retornados no recurso dados complementares do contrato.

Campo Formato Tamanho Descrição
unidade character 4 Código da Unidade, ref. /unidades
contrato numérico 8 Código do Contrato, ref. /contratos
variavel character 4 Código da Variável
variaveldescricao character 40 Descrição da Variável
valor indefinido * Valor da Variável


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/dadosComplementaresContrato?unidade=0001&contrato=298& variavel =OP12& descricao =Cor do Olho & valor =A& offset =0& limit =100


Query Params:

unidade
contrato
variavel
descricao
valor
offset
limit

Operação: GET

Formato Retorno: JSON

3. Contábil 

3.1 /matrizesLancamentos

Campos retornados no recurso matrizes lançamentos:

Campo Formato Tamanho Descrição
matrizlancamentos character 4 Matriz Lançamentos
anomesbase datetime 8 Ano e Mês Base
itemcontabil inteiro inteiro Código do Item Contábil
classificacaocontabil character 8 Classificação Contábil, ref. /classificacoesContabeis
contadevedora character 20 Conta Devedora
contacredora character 20 Conta Credora
historicopadrao character 4 Histórico Padrão


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/contabil/ matrizesLancamentos?matrizLancamentos=0001& anoMesBase>=2020-08-01&anoMesBase<=2020-09-31 & offset=0&limit=100


Query Params:

matrizLancamentos
anoMesBase (YYYY-MM-DD): Podem ser utilizados os operadores >=, <= e =
offset
limit

Operação: GET

Formato Retorno: JSON

 

3.2 /lancamentosContabeis

Campos retornados no recurso lançamentos contábeis:

Campo Formato Tamanho Descrição
operador character 6 Operador
datalancamento datetime 8 Data do Lançamento
empresa character 4 Código da Empresa, ref. /empresas
estabelecimento character 4 Código do Estabelecimento, ref. /estabelecimentos
unidade character 4 Código da Unidade, ref. /unidades
contrato numérico 8 Código do Contrato, ref. /contratos
classificacaocontabil character 8 Classificação Contábil, ref. /classificacoesContabeis
itemcontabil inteiro inteiro Código do Item Contábil
descricao character 40 Descrição do Item Contábil
tipoitem character 1

Tipo do Item Contábil:

  • 1 - Contábil
  • 2 - Estatístico
contadevedora character 20 Conta Devedora
contacredora character 20 Conta Credora
historicopadrao character 4 Histórico Padrão
valor decimal 15,2 Valor
centrocusto1 character 8 Código do Centro de Custo 1, ref. /centrosCusto
centrocusto2 character 8 Código do Centro de Custo 2, ref. /centrosCusto2
centrocusto3 character 8 Código do Centro de Custo 3, ref. /centrosCusto3
centrocusto4 character 8 Código do Centro de Custo 4, ref. /centrosCusto4
setor character 8 Código do Setor, ref. /setores
classificacaogerencial character 8 Código da Classificação Gerencial, ref. /classificacoesGerenciais
classcontabest character 20 Código Estruturado da Classificação Contábil
codigoestruturadocc1 character 16 Código Estruturado do Centro de Custo 1
codigoestruturadocc2 character 16 Código Estruturado do Centro de Custo 2
codigoestruturadocc3 character 16 Código Estruturado do Centro de Custo 3
codigoestruturadocc4 character 16 Código Estruturado do Centro de Custo 4
estabelecimentoaux character 20 Código Auxiliar do Estabelecimento
unidadecalculo character 4 Unidade de Cálculo, ref. /unidades
unidadecalculoaux character 20 Código Auxiliar da Unidade de Cálculo


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/contabil/ lancamentosContabeis? dataLancamento>=2020-08-01&dataLancamento<=2020-09-31 & offset=0&limit=100


Query Params:

empresa
estabelecimento
unidade
contrato
dataLancamento (YYYY-MM-DD): Podem ser utilizados os operadores >=, <= e =
offset
limit

Operação: GET

Formato Retorno: JSON 

4. Empresas

4.1 /empresas

Campos retornados no recurso empresas:

Campo Formato Tamanho Descrição
empresa character 4 Código da Empresa
razaoempresa character 40 Razão Social da Empresa
descricaoempresa character 20 Descrição da Empresa


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/empresas?empresa=0001


Query Params:

empresa
offset
limit

 

Operação: GET

Formato Retorno: JSON

 

4.2 /unidades

Campos retornados no recurso unidades:

Campo Formato Tamanho Descrição
unidade character 4 Código da Unidade
descricao character 40 Descrição da Unidade
ativa character 1 Ativa/Desativada
empresa character 4 Código da Empresa
razaoempresa character 40 Razão Social da Empresa
descricaoempresa character 20 Descrição da Empresa


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/unidades?unidade=0001


Query Params:

unidade
offset
limit

Operação: GET

Formato Retorno: JSON

 

4.3 /estabelecimentos

Campos retornados no recurso estabelecimentos:

Campo Formato Tamanho Descrição
estabelecimento character 4 Código do Estabelecimento
razaosocial character 40 Razão Social do Estabelecimento
descricao character 20 Descrição do Estabelecimento
tipoinscricao character 1

Tipo de Inscrição:

  • 1 - CNPJ
  • 2 - CEI
  • 3 - CPF
  • 4 - CAEPF
  • 5 - CNO
inscricao character 16 Inscrição do Estabelecimento
tipologradouro character 4 Código do Tipo de Logradouro
rua character 40 Rua
nrorua character 8 Número da Rua
bairro character 20 Bairro
complemento character 20 Complemento
cep character 10 CEP
cidade character 20 Cidade
codigoibge character 8 Código do Município para o IBGE
uf character 2 Estado (UF)
ddd character 4 DDD
telefone character 15 Telefone
ramal character 4 Ramal
dddfax character 4 DDD do Fax
telefonefax character 15 Telefone do Fax
ramalfax character 4 Ramal do Fax
email character 80 E-mail
ativadesativada character 1

Ativo:

  • 1 - Ativa
  • 2 - Desativada
cpfresponsavel character 11 CPF do Responsável
cargoresponsavel character 40 Descrição do Cargo do Responsável
desccalendario character 40 Descrição do Calendário
cnae character 7 CNAE
graurisco character 1 Grau 1, 2, 3 ou 4
empresa character 4 Empresa a qual o estabelecimento faz parte
sindicato character 4 Sindicato vinculado ao estabelecimento
razaoempresa character 40 Razão Social da Empresa
descricaoempresa character 20 Descrição da Empresa

Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/estabelecimentos?estabelecimento=0001& cnpj=81039999/0001-85


Query Params:

estabelecimento
cnpj
offset
limit

Operação: GET

Formato Retorno: JSON

5. Financeiro

5.1 /contasAPagar

Campos retornados no recurso contas a pagar:

Campo Formato Tamanho Descrição
numerosequencial numérico 10 Número Sequencial
numerodocumento character 10 Número do Documento
datainicio datetime 8 Data de Início
datatermino datetime 8 Data de Término
statusregistro character 2

Status Registro:

  • 01 - Incluído
  • 02 - Liberado para o Sistema de Contas a Pagar
  • 03 - Aceito pelo Sistema de Contas a Pagar
  • 04 - Solicitando Autorização para a Exclusão
  • 05 - Excluído pelo Sistema de Contas a Pagar
  • 06 - Autorização negada para a Exclusão
  • 07 - Excluído pela Folha
  • 08 - Rejeitado pelo Sistema de Contas a Pagar
  • 09 - Solicitando Provisão p/Conta a Pagar
  • 10 - Provisionado pelo Contas a Pagar
datainclusao datetime 8 Data de Inclusão
operadorinclusao character 6 Operador da Inclusão
dataliberacao datetime 8 Data de Liberação
operadorliberacao character 6 Operador da Liberação
dataaceitacaoliberacao datetime 8 Data de Aceitação da Liberação
datasolicitacaoestorno datetime 8 Data de Solicitação do Estorno
operadorsolicitacaoestorno character 6 Operador da Solicitação do Estorno
dataautorizacaoestorno datetime 8 Data de Autorização do Estorno
datanegacaoestorno datetime 8 Data de Negação do Estorno 
dataestorno datetime 8 Data do Estorno
operadorestorno character 6 Operador do Estorno
datasolicitacaoprovisao datetime 8 Data de Solicitação da Provisão
operadorsolicitacaoprovisao character 6  Operador da Solicitação de Provisão 
dataprovisao datetime 8  Data da Provisão
datavencimento datetime  8  Data de Vencimento 
descricaoreduzida character 40 Descrição Reduzida
descricao character 250  Descrição 
formaapuracontapagar character 2 

Forma de Apuração:

  • 01 - Empresa
  • 02 - Unidade
  • 03 - Estabelecimento
  • 04 - Setor
  • 05 - Centro Custo Nível 1
  • 06 - Centro Custo Nível 2
  • 07 - Centro Custo Nível 3
  • 08 - Centro Custo Nível 4
  • 09 - Classificação Contábil
  • 10 - Classificação Gerencial
  • 11 - Classificação GPS
  • 12 - Classificação SEFIP
  • 13 - Sindicato
  • 14 - Banco
  • 15 - Banco Pagador
  • 99 - Um único total
codigoapuracao character 8  Código de Apuração 
fornecedor character 4 Código do Fornecedor, ref. /fornecedores
fornecedordescricaoreduzida character 20  Descrição Reduzida do Fornecedor
contadevedora character 20 Conta Devedora
contacredora character  20 Conta Credora 
historicopadrao character 4 Código do Histórico Padrão
valor decimal  15,2  Valor
valororiginal decimal 11,2 Valor Original
tipoitemcontapagar character 2

Tipo do Item:

  • 01 - GPS Empresa Mensal
  • 02 - GPS Empresa 13º Salário
  • 03 - GPS Individual
  • 04 - DARF IRF s/Salários
  • 05 - DARF PIS s/Folha
  • 06 - GFIP (FGTS)
  • 07 - GRCS Patronal
  • 08 - GRCS Empregados
  • 09 - Contrato
  • 10 - DARF IRF s/Autônomos
  • 11 - GPS Produtos Rurais
  • 12 - GPS Fretes (SIMPLES)
  • 13 - GPS Diferença Dissídio
  • 14 - GPS Individual 13º Salário
  • 15 - DARF IRF s/Lucros Distr.
  • 16 - GFIP (FGTS 115)
  • 17 - GFIP (FGTS 150)
  • 18 - GFIP (FGTS 155)
  • 19 - GFIP (FGTS 650)
  • 20 - Emissão de Cheques
  • 21 - DARF IRF s/Residente Exterior
  • 22 - Remessas Bancárias
  • 26 - Pensionistas
  • 40 - Folha Avulsa/RPA
  • 41 - Férias
  • 44 - Rescisão Principal
  • 45 - Rescisão Complementar
  • 99 - Outros
chaveoutrosistema numérico 10 Chave no Sistema Terceiro
chaveoutrosistematitulo numérico 10 Chave do Título no Sistema Terceiro
numerotitulo numérico  10  Número do Título
numerocheque numérico 10 Número do Cheque
seriecheque character 6 Série do Cheque
numeroremessa numérico 10 Número da Remessa
banco character 4 Código do Banco, ref. /bancos
numerobanco character 3 Número do Banco
numeroagencia character 4 Número da Agência
digitoagencia character 1 Dígito da Agência
contacorrente character 15 Número da Conta Corrente
numerodoc numérico 10 Número do DOC
seriedoc character 6 Série do DOC
numeroemissaoseq numérico 10 Número de Emissão Sequência
numerochequeseq numérico 10 Número do Cheque Sequência
formapagamento character 1

Forma de Pagamento:

  • 1 - Em Espécie
  • 2 - Em Cheque
  • 3 - Documento de Compensação - DOC
  • 4 - Depósito em Conta Corrente
  • 5 - Depósito na Poupança
  • 6 - Depósito para Saque por Cartão
formapagamentooriginal character 1

Forma de Pagamento Original:

  • 1 - Em Espécie
  • 2 - Em Cheque
  • 3 - Documento de Compensação - DOC
  • 4 - Depósito em Conta Corrente
  • 5 - Depósito na Poupança
  • 6 - Depósito para Saque por Cartão
itemcontapagar numérico 10 Código do Item
codigoauxiliar character 20 Código Auxiliar do Item
empresa character 4 Código da Empresa, ref. /empresas
estabelecimento character 4 Código do Estabelecimento, ref. /estabelecimentos
estabelecimentocodigoauxiliar character 20 Código Auxiliar do Estabelecimento
sindicato character 4 Código do Sindicato, ref. /sindicatos
classificacaogpssefip character 4 Código da Classificação GPS/SEFIP
anomescompetencia character 7 Ano/Mês de Competência
unidade character 4 Código da Unidade, ref. /unidades
contrato numérico  8 Código do Contrato, ref. /contratos
nome character  40 Nome da Pessoa
datafolha datetime  8  Data Folha 
codigofolha character  2

Código da Folha:

  • 11 - Mensal
  • 21 - Quinzenal - 1a. Quinzena
  • 22 - Quinzenal - 2a. Quinzena
  • 31 - Semanal - 1a. Semana
  • 32 - Semanal - Semanas intermediárias
  • 33 - Semanal - Última Semana
  • 41 - Adiantamento Semanal/Quinzenal
  • 51 - 13o. Salário - Antecipação
  • 52 - 13o. Salário - Complementação
  • 61 - Suplementar
  • 71 - Avulsa
  • 81 - Férias
  • 82 - Férias - 2o. Recibo do Dia
  • 83 - Férias - 3o. Recibo do Dia
  • 91 - Rescisão Principal
  • 92 - 1ª Rescisão Complementar
  • 93 - 2ª Rescisão Complementar
  • 95 - Rescisão Parcial
necessitaprovisao character 1

Necessita Provisão:

  • S - Sim
  • N - Não
tipolancamento character  1

Tipo de Lançamento:

  • 1 - Para Folha Mensal
  • 2 - Para Folha Quinzenal
  • 3 - Para Folha Semanal
  • 4 - Para Adiantamento
  • 5 - Para 13o. Salário
  • 6 - Para Folha Suplementar
  • 7 - Para Folha Avulsa/RPA
  • 8 - Para Folha de Férias
  • 9 - Para Folha de Rescisão
 
justificativa texto 2³¹ Justificativa
codigoguia character 100 Código Guia
unidadecodigoauxiliar character  20 Código Auxiliar da Unidade
datavencimentocovid19 datetime  8  Data de Vencimento COVID-19 


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/financeiro/ contasAPagar?status=02& dataInclusao>=2020-08-01&dataInclusao<=2020-08-31 & offset=0&limit=100


Query Params:

status
fornecedor
unidade
contrato
dataInclusao (YYYY-MM-DD): Podem ser utilizados os operadores >=, <= e =
dataLiberacao (YYYY-MM-DD): Podem ser utilizados os operadores >=, <= e = 
dataVencimento (YYYY-MM-DD): Podem ser utilizados os operadores >=, <= e = 
offset
limit

Operação: GET

Formato Retorno: JSON

 

5.2 /contasAPagarRateio/{numeroSequencial}

Campos retornados no recurso contas a pagar rateio:

Campo Formato Tamanho Descrição
numerosequencial numérico 10 Número Sequencial
tiporateio character 2

Tipo de Rateio:

  • 01 - DARF Folha
  • 02 - DARF Autônomos
  • 03 - DARF PIS
  • 04 - DARF Lucros Distr.
  • 05 - GRCS Empregados
  • 06 - GFIP (FGTS)
  • 07 - GFIP (FGTS 115)
  • 08 - GFIP (FGTS 150)
  • 09 - GFIP (FGTS 155)
  • 10 - GFIP (FGTS 650)
  • 11 - Outros
  • 12 - GPS Empresa Mensal
  • 13 - GPS Empresa 13º Salário
  • 14 - GPS Diferença de Dissídio
  • 15 - DARF Residente Exterior
empresa character 4 Código da Empresa, ref. /empresas
pessoa numérico 8 Código da Pessoa, ref. /contratos
unidade character 4 Código da Unidade, ref. /unidades
unidadecodigoauxiliar character 20 Código Auxiliar da Unidade
contrato numérico 8 Código do Contrato, ref. /contratos
anomesbase datetime 8 Ano/Mês Base
valor decimal 15,2 Valor
estabelecimento character 4 Código do Estabelecimento, ref. /estabelecimentos
estabelecimentocodigoauxiliar character 20 Código Auxiliar do Estabelecimento
classificacaocontabil character 8 Código da Classificação Contábil
classcontabest character 20 Código Estruturado da Classificação Contábil
setor character 8 Código do Setor, ref. /setores 
postotrabalho character 8 Código do Posto de Trabalho
centrocusto1 character 8 Código do Centro de Custo 1, ref. /centrosCusto
centrocusto1codigoestruturado character 16 Código Estruturado do Centro de Custo 1
centrocusto2 character 8 Código do Centro de Custo 2, ref. /centrosCusto2
centrocusto2codigoestruturado character 16 Código Estruturado do Centro de Custo 2
centrocusto3 character 8  Código do Centro de Custo 3, ref. /centrosCusto3
centrocusto3codigoestruturado character 16 Código Estruturado do Centro de Custo 3
centrocusto4 character 8 Código do Centro de Custo 4, ref. /centrosCusto4
centrocusto4codigoestruturado character 16 Código Estruturado do Centro de Custo 4
classificacaogerencial character 8  Código da Classificação Gerencial
classificacaogps character 4 Código da Classificação GPS
classificacaosefip character 4 Código da Classificação SEFIP


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/financeiro/ contasAPagarRateio/2 ?unidade=0001& contrato=298& offset=0&limit=100

 

Path Params:

numeroSequencial


Query Params:

unidade
contrato
offset
limit

Operação: GET

Formato Retorno: JSON

 

5.3 /contasAPagar/{numeroSequencial}

Campos a serem enviados para o recurso contas a pagar:

Campo Obrigatório Formato Tamanho Descrição
status S character 2

Status Permitidos para Atualização:

  • 03 - Aceito pelo Sistema de Contas a Pagar
  • 05 - Excluído pelo Sistema de Contas a Pagar
  • 06 - Autorização negada para a Exclusão
  • 08 - Rejeitado pelo Sistema de Contas a Pagar
mensagem

Obrigatório caso status = 06 ou status = 08

 texto 2³¹ Mensagem de erro para gravação no log
operadorestorno Obrigatório caso status = 05 character 6 Operador do Estorno
dataestorno Obrigatório caso status = 05 datetime 8  Data de Estorno


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/financeiro/ contasAPagar/2

 

Path Params:

numeroSequencial


Exemplos de Body:

{
    "status": "03"
}

{
    "status": "05",
    "dataEstorno": "2020-08-13 10:41:50",
    "operadorEstorno": "TESTE"
}

{
    "status": "06",
    "mensagem": "Não foi possível efetuar a exclusão do título."
}

{
    "status": "08",
    "mensagem": "Erro ao inserir o título."
}

Operação: PATCH

Formato Retorno: JSON

6. Folha de Pagamento

6.1 /vdbs

Campos retornados no recurso VDBs:

Campo Formato Tamanho Descrição
vdb numérico 8 Código do VDB
descricao character 40 Descrição do VDB
tipovdb character 1

Tipo de VDB:

  • V - Vencimento
  • D - Desconto
  • B - Base
aceitaprestacao character 1 Aceita Prestação:
  • S - Sim
  • N - Não
usaponto character 1 Utiliza Ponto:
  • S - Sim
  • N - Não
usafolha character 1 Utiliza Folha:
  • S - Sim
  • N - Não
impressofolha character 1

Impressão Folha:

  • N - Não Imprimir
  • Q - Imprimir Horas/Qtde 
  • S - Imprimir Valor
  • T - Imprimir Horas/Qtde e Valor
impressorecibo character 1 Impressão Recibo:
  • N - Não Imprimir
  • Q - Imprimir Horas/Qtde 
  • S - Imprimir Valor
  • T - Imprimir Horas/Qtde e Valor
impressotermo character 1 Impressão Termo:
  • N - Não Imprimir
  • Q - Imprimir Horas/Qtde 
  • S - Imprimir Valor
  • T - Imprimir Horas/Qtde e Valor
avisaafastferias character 1

Avisa Afastamento Férias: 

  • S - Sim
  • N - Não
incidenciafolha character 1 Incidência Folha:
  • - (Subtraindo)
  • + (Somando)
  • 0 (Não Incide)
classificacaofolha character 2

Classificação Folha:

  • 00 - Outros
  • AB - Abono de Férias
  • AD - Adicionais
  • DT - 13º Salário
  • EN - Encargos
  • FE - Férias
  • FT - Faltas
  • HE - Horas Extras
  • HN - Horas Noturnas
  • IN - Indenizações
  • PC - Prêmios e Comissões
  • RP - Rendimentos do PIS/PASEP
  • SL - Salários e Ordenados 
incidenciarais character 1 Incidência RAIS:
  • - (Subtraindo)
  • + (Somando)
  • 0 (Não Incide)
classificacaorais character 2

Classificação RAIS:

  • 00 - Outros
  • AI - Aviso Prévio Indenizado
  • DT - 13º Salário
  • RF- Remuneração Fixa
  • RV - Remuneração Variável
  • VB - Valor Total do Saldo do Banco de Horas
incidenciainss character 1 Incidência INSS:
  • - (Subtraindo)
  • + (Somando)
  • 0 (Não Incide)
classificacaoinss character 2

Classificação INSS:

  • 00 - Outros
  • DT - 13º Salário
  • FE - Férias
  • PF - Provisão INSS s/Férias
  • PL - Pró-Labore e Honorários
  • RA - Remuneração de Autônomo
  • RO - Sal. Contrib. Outros Empregos
  • SE - Salário Educação
  • SF - Salário Família
  • SL - Salários e Ordenados
  • SM - Salário Maternidade
incidenciafgts character 1 Incidência FGTS:
  • - (Subtraindo)
  • + (Somando)
  • 0 (Não Incide)
classificacaofgts character 2

Classificação FGTS:

  • 00 - Outros
  • DT - 13º Salário
  • FE - Férias
  • SL - Salários e Ordenados
incidenciairf character 1

Incidência IRF:

  • - (Subtraindo)
  • + (Somando)
  • 0 (Não Incide)
classificacaoirf character 2

Classificação IRF:

  • 00 - Outros
  • BM - Bolsa de Estudo Médico Residente
  • CP - Contribuições Previdenciárias
  • DA - Diárias e Ajudas de Custo
  • DM - Despesas Médico-Hospitalares
  • DT - 13º Salário
  • E1 - Fundo Prev. Serv. Público sobre 13º Salário
  • EP - Fundo Prev. Serv. Público (Patrocinador)
  • F1 - Fundo Aposent. Prog. Individual sobre 13º Salário (FAPI)
  • FA - Fundo Aposent. Prog. Individual (FAPI)
  • FC - Frete de Cargas
  • FE - Férias
  • FP - Frete de Passageiros
  • LD - Lucros Distribuídos
  • LS - Lucros e Dividendos pagos ao Sócio de SCP
  • LU - Lucros e Dividendos pagos por PJ
  • P1 - Previdência Privada sobre 13º Salário
  • PA - Proventos de Aposentadoria/Pensão
  • PD - Pensão Judicial sobre 13º Salário
  • PF - Pensão Judicial sobre Férias
  • PJ - Pensão Judicial sobre Salários
  • PL - Pensão Judicial sobre Lucros Distribuídos
  • PM - Pensão/Aposentadoria por Moléstia Grave
  • PP - Previdência Privada
  • RE - Residente Exterior c/ Rend Brasil
  • RN - Outros Rendimentos não Tributáveis
  • RT - Outros Rendimentos Tributáveis
  • S1 - Fundo Previdência Servidor Público sobre 13º Salário
  • SP - Fundo Previdência Servidor Público
  • VC - Rend. não Trib. Voluntário da Copa
verbarescisoria numérico  10 Verba Rescisória
incidenciaverba character 1 Incidência Verba:
  • - (Subtraindo)
  • + (Somando)
  • 0 (Não Incide)


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ vdbs?vdb=1&tipoVdb=V&ativo=true&offset=0&limit=100


Query Params:

vdb
tipoVdb
ativo (true: retorna somente os registros ativos; false: retorna somente os registros inativos)
offset
limit

Operação: GET

Formato Retorno: JSON

 

6.2 /folhaPagamento

Campos retornados no recurso folha pagamento:

Campo Formato Tamanho Descrição
datafolha datetime 8 Data da Folha
codigofolha character 2

Código da Folha:

  • 11 - Mensal
  • 21 - Quinzenal - 1a. Quinzena
  • 22 - Quinzenal - 2a. Quinzena
  • 31 - Semanal - 1a. Semana
  • 32 - Semanal - Semanas intermediárias
  • 33 - Semanal - Última Semana
  • 41 - Adiantamento Semanal/Quinzenal
  • 51 - 13o. Salário - Antecipação
  • 52 - 13o. Salário - Complementação
  • 61 - Suplementar
  • 71 - Avulsa
  • 81 - Férias
  • 82 - Férias - 2o. Recibo do Dia
  • 83 - Férias - 3o. Recibo do Dia
  • 91 - Rescisão Principal
  • 92 - 1ª Rescisão Complementar
  • 93 - 2ª Rescisão Complementar
  • 95 - Rescisão Parcial
unidade character 4 Código da Unidade, ref. /unidades
contrato numérico 8 Código do Contrato, ref. /contratos
vdb numérico 8 Código do VDB, ref. /vdbs
tipoinfofolha character 1

Tipo de Informação Folha:

  • 0 - Só o Valor
  • 1 - Horas e Valor
  • 2 - Dias e Valor
  • 3 - Quantidade de Tarefas e Valor
horasquantidade decimal 11,2 Horas/Quantidade
valor decimal 15,2 Valor
datapagamento datetime 8 Data de Pagamento da Folha


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ folhaPagamento?vdb=1& unidade=0001&contrato=296 & dataFolha=08-2020 &consolidada=true&dataPagamento>=2020-08-01&dataPagamento<=2020-08-15&offset=0&limit=100


Query Params:

vdb
unidade
contrato
dataFolha (MM-YYYY) *
consolidada (true: retorna somente registros consolidados na folha; false: retorna somente registros não consolidados na folha)
dataPagamento (YYYY-MM-DD): Podem ser utilizados os operadores >=, <= e =
offset
limit
* campos obrigatórios

Operação: GET

Formato Retorno: JSON

 

6.3 /lancamentos

Campos retornados no recurso lançamentos:

Campo Formato Tamanho Descrição
unidade character 4 Código da Unidade, ref. /unidades
contrato numérico 8 Código do Contrato, ref. /contratos
vdb numérico 8 Código do VDB, ref. /vdbs
tipolancamento character 1

Tipo de Lançamento:

  • 1 - Para Folha Mensal
  • 2 - Para Folha Quinzenal
  • 3 - Para Folha Semanal
  • 4 - Para Adiantamento
  • 5 - Para 13o. Salário
  • 6 - Para Folha Suplementar
  • 7 - Para Folha Avulsa/RPA
  • 8 - Para Folha de Férias
  • 9 - Para Folha de Rescisão
datavencimento datetime 8  Data de Vencimento
datalancamento datetime 8  Data do Lançamento 
origemlancamento character 1

Origem do Lançamento:

  • A - Vale Alimentação
  • C - Convênios
  • D - Digitado
  • G - Gerado pelo Sistema
  • I - Importações Diversas
  • P - Ponto Eletrônico
  • T - Vale Transporte
tipoinfolancamento character  1 

Tipo de Informação do Lançamento:

  • 0 - Valor em R$
  • 1 - Quantidade de Horas
  • 2 - Quantidade de Dias
  • 3 - Quantidade de Tarefas
quantidadevalor decimal 11,2 Quantidade/Valor
lancamentofixo character 1 

Lançamento Fixo:

  • S - Sim
  • N - Não
situacaolancamento character 1 

Situação do Lançamento:

  • C - Consolidado na Folha de Pagamento 
  • null - Não Consolidado na Folha de Pagamento 
operador character 6  Operador do Lançamento
datahoraalteracao datetime 8  Data/Hora da Alteração
numeroprestacao numérico 10 Número de Prestação
numerototalprestacoes numérico 10 Número Total de Prestações
descricao character 250 Descrição


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ lancamentos?vdb=1&tipoLancamento=1& unidade=0001&contrato=296 & dataVencimento>=2020-08-01&dataVencimento<=2020-08-31 &offset=0&limit=100


Query Params:

vdb
tipoLancamento
unidade
contrato
dataVencimento (YYYY-MM-DD): Podem ser utilizados os operadores >=, <= e =
offset
limit 

Operação: GET

Formato Retorno: JSON

 

6.4 /lancamentos

Campos a serem enviados para o recurso lançamentos:

Campo Obrigatório Formato Tamanho Descrição
unidade S character 4 Código da Unidade, ref. /unidades
contrato S numérico 8 Código do Contrato, ref. /contratos
vdb S numérico 8 Código do VDB, ref. /vdbs
tipolancamento S character 1

Tipo de Lançamento:

  • 1 - Para Folha Mensal
  • 2 - Para Folha Quinzenal
  • 3 - Para Folha Semanal
  • 4 - Para Adiantamento
  • 5 - Para 13o. Salário
  • 6 - Para Folha Suplementar
  • 7 - Para Folha Avulsa/RPA
  • 8 - Para Folha de Férias
  • 9 - Para Folha de Rescisão
datavencimento S datetime 8  Data de Vencimento
datalancamento S datetime 8  Data do Lançamento 
origemlancamento S character 1

Origem do Lançamento:

  • A - Vale Alimentação
  • C - Convênios
  • D - Digitado
  • G - Gerado pelo Sistema
  • I - Importações Diversas
  • P - Ponto Eletrônico
  • T - Vale Transporte
tipoinfolancamento S character  1 

Tipo de Informação do Lançamento:

  • 0 - Valor em R$
  • 1 - Quantidade de Horas
  • 2 - Quantidade de Dias
  • 3 - Quantidade de Tarefas
quantidadevalor N decimal 11,2 Quantidade/Valor
lancamentofixo S character 1 

Lançamento Fixo:

  • S - Sim
  • N - Não
situacaolancamento N character 1 

 Situação do Lançamento:

  • C - Consolidado na Folha de Pagamento 
  • null - Não Consolidado na Folha de Pagamento
operador S character 6  Operador do Lançamento
datahoraalteracao S datetime 8  Data/Hora da Alteração
numeroprestacao N numérico 10 Número de Prestação
numerototalprestacoes N numérico 10 Número Total de Prestações
descricao N character 250 Descrição


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ lancamentos


Exemplo de Body:

{
     "unidade": "0001",
     "contrato": "1",
     "vdb": 1,
     "tipoLancamento": "1",
     "dataVencimento": "2020-07-01",
     "dataLancamento": "2020-07-01",
     "origemLancamento": "D",
     "tipoInfoLancamento": "0",
     "quantidadeValor": 2436.46,
     "lancamentoFixo": "N",
     "situacaoLancamento": null,
     "operador": "TESTE",
     "dataHoraAlteracao": "2020-07-02 12:05:02",
     "numeroPrestacao": null,
     "numeroTotalPrestacoes": null,
     "descricao": null
}

Operação: POST

Formato Retorno: JSON

 

6.5 /contratosFolha

Campos retornados no recurso contratos folha:

Campo Formato Tamanho Descrição
datafolha datetime 8 Data da Folha
codigofolha character 2

Código da Folha:

  • 11 - Mensal
  • 21 - Quinzenal - 1a. Quinzena
  • 22 - Quinzenal - 2a. Quinzena
  • 31 - Semanal - 1a. Semana
  • 32 - Semanal - Semanas intermediárias
  • 33 - Semanal - Última Semana
  • 41 - Adiantamento Semanal/Quinzenal
  • 51 - 13o. Salário - Antecipação
  • 52 - 13o. Salário - Complementação
  • 61 - Suplementar
  • 71 - Avulsa
  • 81 - Férias
  • 82 - Férias - 2o. Recibo do Dia
  • 83 - Férias - 3o. Recibo do Dia
  • 91 - Rescisão Principal
  • 92 - 1ª Rescisão Complementar
  • 93 - 2ª Rescisão Complementar
  • 95 - Rescisão Parcial
empresa character 4 Código da Empresa, ref. /empresas
pessoa numérico 8 Código da Pessoa, ref. /dadosPessoais
unidade character 4 Código da Unidade, ref. /unidades
estabelecimento character 4 Código do Estabelecimento, ref. /estabelecimentos
contrato numérico 8 Código do Contrato, ref. /contratos
situacao character 1

Situação do Contrato:

  • 1 - Ativo
  • 2 - Afastado
  • 3 - Rescindido no mês
  • 4 - Rescindido em meses anteriores
dataadmissao datetime 8 Data de Admissão
dataultimoafastamento datetime 8 Data do Último Afastamento
datarescisao datetime 8 Data de Rescisão
cargo character 8 Código do Cargo, ref. /cargos
funcao character 8 Código da Função, ref. /funcoes
setor character 8 Código do Setor, ref. /setores
escala character 4 Código da Escala, ref. /escalas
centrocusto1 character 8 Código do Centro de Custo 1, ref. /centrosCusto
centrocusto2 character 8 Código do Centro de Custo 2, ref. /centrosCusto1
centrocusto3 character 8 Código do Centro de Custo 3, ref. /centrosCusto2
centrocusto4 character 8 Código do Centro de Custo 4, ref. /centrosCusto3
classificacaogerencial character 8 Código da Classificação Gerencial, ref. /classificacoesGerenciais
classificacaocontabil character 8 Código da Classificação Contábil, ref. /classificacoesContabeis
vinculoempregaticio character 2 Código do Vínculo Empregatício, ref. /vinculosEmpregaticios
salariocontratual decimal 11,2 Salário Contratual
salariomes decimal 11,2 Salário Mês
salariohora decimal 11,4 Salário Hora
horascontratuais decimal 5,2 Horas Contratuais
horasmes decimal 5,2 Horas Mês
horasdia decimal 7,4 Horas Dia


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ contratosFolha? unidade=0001&contrato=296 & dataFolha=08-2020 &offset=0&limit=100


Query Params:

unidade
contrato
dataFolha (MM-YYYY) *
offset
limit
* campos obrigatórios

Operação: GET

Formato Retorno: JSON

 

6.6 /lancamentosContratoLote

Campos a serem enviados para o recurso lancamentosContratoLote:

Campo Obrigatório Formato Tamanho Descrição
unidade S varchar 4 Código da unidade cadastrada no Metadados.
contrato S int   Código do contrato cadastrado no Metadados.
vdb S int   Código do vdb (verba) cadastrado no Metadados.
tipoLancamento S char 1
  • 1 - Para Folha Mensal
  • 2 - Para Folha Quinzenal
  • 3 - Para Folha Semanal
  • 4 - Para Adiantamento
  • 5 - Para 13o. Salário
  • 6 - Para Folha Suplementar
  • 7 - Para Folha Avulsa/RPA
  • 8 - Para Folha de Férias
  • 9 - Para Folha de Rescisão
dataVencimento S datetime   Data de Vencimento.
dataLancamento S datetime   Data de Lançamento.
origemLancamento S char 1
  • A - Vale Alimentação
  • C - Convênios
  • D - Digitado
  • G - Gerado pelo Sistema
  • I - Importações Diversas
  • P - Ponto Eletrônico
  • T - Vale Transporte
tipoInfoLancamento S char 1
  • 0 - Valor em R$
  • 1 - Quantidade de Horas
  • 2 - Quantidade de Dias
  • 3 - Quantidade de Tarefas
quantidadeValor S decimal   Quantidade de horas ou valor do vdb que está sendo lançado.
lancamentoFixo S char 1
  • N - Não
  • S - Sim
situacaoLancamento N char 1 Situação do Lançamento:
  • C - Consolidado na Folha de Pagamento
  • null - Não Consolidado na Folha de Pagamento
operador S varchar 6 Identificação do operador que está realizando o lançamento.
dataHoraAlteracao S datetime   Data / hora de inserção / alteração do lançamento.
numeroPrestacao N int   Número da Parcela.
numeroTotalPrestacoes N int   Quantidade total de parcela.
descricao N varchar 250 Observações.

 

OBS.: Se algum registro for rejeitado, a API fará o rollback de todos os lançamentos que foram enviados no body.

 

Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4 /sirh/lancamentosContratoLote


Exemplo de Body:

{
    "lancamentos": [
    {
        "unidade": "0001",
        "contrato": "6",
        "eventos": [
        {
            "vdb": 54201,
            "tipoLancamento": "8",
            "dataVencimento": "2021-11-17",
            "dataLancamento": "2021-11-17",
            "origemLancamento": "D",
            "tipoInfoLancamento": "0",
            "quantidadeValor": 1314.46,
            "lancamentoFixo": "N",
            "situacaoLancamento": null,
            "operador": "INTEG",
            "dataHoraAlteracao": "2021-11-16 18:05:02",
            "numeroPrestacao": null,
            "numeroTotalPrestacoes": null,
            "descricao": null
        },
        {
            "vdb": 1,
            "tipoLancamento": "8",
            "dataVencimento": "2021-11-18",
            "dataLancamento": "2021-11-15",
            "origemLancamento": "D",
            "tipoInfoLancamento": "0",
            "quantidadeValor": 100.17,
            "lancamentoFixo": "N",
            "situacaoLancamento": null,
            "operador": "INTEG",
            "dataHoraAlteracao": "2021-11-15 12:05:02",
            "numeroPrestacao": null,
            "numeroTotalPrestacoes": null,
            "descricao": null
        }
        ]
    },
    {
        "unidade": "0001",
        "contrato": "4",
        "eventos": [
        {
            "vdb": 54201,
            "tipoLancamento": "8",
            "dataVencimento": "2021-11-17",
            "dataLancamento": "2021-11-17",
            "origemLancamento": "D",
            "tipoInfoLancamento": "0",
            "quantidadeValor": 1314.46,
            "lancamentoFixo": "N",
            "situacaoLancamento": null,
            "operador": "INTEG",
            "dataHoraAlteracao": "2021-11-16 18:05:02",
            "numeroPrestacao": null,
            "numeroTotalPrestacoes": null,
            "descricao": null
        },
        {
            "vdb": 1,
            "tipoLancamento": "8",
            "dataVencimento": "2021-11-18",
            "dataLancamento": "2021-11-15",
            "origemLancamento": "D",
            "tipoInfoLancamento": "0",
            "quantidadeValor": 100.17,
            "lancamentoFixo": "N",
            "situacaoLancamento": null,
            "operador": "INTEG",
            "dataHoraAlteracao": "2021-11-15 12:05:02",
            "numeroPrestacao": null,
            "numeroTotalPrestacoes": null,
            "descricao": null
        }
        ]
    }
    ]
}


Operação: POST

Exemplo de Resposta:

{
    "statusCode": 500,
    "message": "Erro ao tentar persistir lote",
    "errors": [
        {
            "statusCode": 500,
            "message": "Lote rejeitado - Lançamento duplicado: Unidade: 0001, Contrato: 4, VDB: 1, TipoLancamento: 8, DataVencimento: 2021-11-18, DataLancamento: 2021-11-15"
        }
    ]
}

 

6.7 /lancamentosLote

Campos a serem enviados para o recurso lancamentosLote:

Campo Obrigatório Formato Tamanho Descrição
unidade S varchar 4 Código da unidade cadastrada no Metadados.
contrato S int   Código do contrato cadastrado no Metadados.
vdb S int   Código do vdb (verba) cadastrado no Metadados.
tipoLancamento S char 1
  • 1 - Para Folha Mensal
  • 2 - Para Folha Quinzenal
  • 3 - Para Folha Semanal
  • 4 - Para Adiantamento
  • 5 - Para 13o. Salário
  • 6 - Para Folha Suplementar
  • 7 - Para Folha Avulsa/RPA
  • 8 - Para Folha de Férias
  • 9 - Para Folha de Rescisão
dataVencimento S datetime   Data de Vencimento.
dataLancamento S datetime   Data de Lançamento.
origemLancamento S char 1
  • A - Vale Alimentação
  • C - Convênios
  • D - Digitado
  • G - Gerado pelo Sistema
  • I - Importações Diversas
  • P - Ponto Eletrônico
  • T - Vale Transporte
tipoInfoLancamento S char 1
  • 0 - Valor em R$
  • 1 - Quantidade de Horas
  • 2 - Quantidade de Dias
  • 3 - Quantidade de Tarefas
quantidadeValor S decimal   Quantidade de horas ou valor do vdb que está sendo lançado.
lancamentoFixo S char 1
  • N - Não
  • S - Sim
situacaoLancamento N char 1 Situação do Lançamento:
  • C - Consolidado na Folha de Pagamento
  • null - Não Consolidado na Folha de Pagamento
operador S varchar 6 Identificação do operador que está realizando o lançamento.
dataHoraAlteracao S datetime   Data / hora de inserção / alteração do lançamento.
numeroPrestacao N int   Número da Parcela.
numeroTotalPrestacoes N int   Quantidade total de parcela.
descricao N varchar 250 Observações.
OBS.: Se algum registro for rejeitado, a API fará o rollback de todos os lançamentos que foram enviados no body. Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4 /sirh/lancamentosLote


Exemplo de Body:

{
    "unidade": "0001",
    "contrato": "1",
    "eventos": [
    {
        "vdb": 54201,
        "tipoLancamento": "8",
        "dataVencimento": "2021-11-17",
        "dataLancamento": "2021-11-16",
        "origemLancamento": "D",
        "tipoInfoLancamento": "0",
        "quantidadeValor": 1314.46,
        "lancamentoFixo": "N",
        "situacaoLancamento": null,
        "operador": "INTEG",
        "dataHoraAlteracao": "2021-11-16 18:05:02",
        "numeroPrestacao": null,
        "numeroTotalPrestacoes": null,
        "descricao": null
    },
    {
        "vdb": 1,
        "tipoLancamento": "8",
        "dataVencimento": "2021-11-18",
        "dataLancamento": "2021-11-15",
        "origemLancamento": "D",
        "tipoInfoLancamento": "0",
        "quantidadeValor": 100.17,
        "lancamentoFixo": "N",
        "situacaoLancamento": null,
        "operador": "INTEG",
        "dataHoraAlteracao": "2021-11-15 12:05:02",
        "numeroPrestacao": null,
        "numeroTotalPrestacoes": null,
        "descricao": null
    }
    ]
}


Operação: POST

Exemplo de Resposta:
 
{
    "message": "Lote inserido com sucesso."
}

7. Frequência

7.1 /marcacoes

Campos retornados no recurso marcações:

Campo Formato Tamanho Descrição
data datetime 8 Data da Marcação no formato "DD-MM-YYYY"
hora character 5 Horário da Marcação no formato "HH:mm"
origem character 10 Origem da marcação
numeroMarcacao character 8 Número da marcação no dia

Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ marcacoes?unidade=0001&contrato=296&dataInicio=2019-07-01&dataFim=2019-07-22&offset=0&limit=100


Query Params:

unidade *
contrato *
dataInicio *
dataFim *
offset
limit
* campos obrigatórios

Operação: GET

Formato Retorno: JSON

 

7.2 /eventosPonto

Campos retornados no recurso eventos ponto:

Campo Formato Tamanho Descrição
eventoponto numérico 8 Código do Evento do Ponto
descricao character 40 Descrição do Evento do Ponto
tipoinfoevento character 1

Tipo de Informação do Evento:       

  • H - Horas
  • Q - Quantidade
  • V - Valor
avisaocorrencia character 1 Avisa Ocorrência:
  • S - Sim
  • N - Não
aceitaacerto character 1 Aceita Acerto:
  • S - Sim
  • N - Não
aceitaconfirmacao character 1 Aceita Confirmação:
  • S - Sim
  • N - Não
aceitalancamentos character 1 Aceita Lançamentos:
  • S - Sim
  • N - Não


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ eventosPonto?eventoPonto=1&tipoInfoEvento=H&ativo=true&offset=0&limit=100


Query Params:

eventoPonto
tipoInfoEvento
ativo (true: retorna somente os registros ativos; false: retorna somente os registros inativos)
offset
limit

Operação: GET

Formato Retorno: JSON

 

7.3 /lancamentosEventosPonto

Campos retornados no recurso lançamentos eventos ponto:

Campo Formato Tamanho Descrição
dataapuracao datetime 8 Data da Apuração
unidade character 4 Código da Unidade, ref. /unidades
contrato numérico 8 Código do Contrato, ref. /contratos
eventoponto numérico 8 Código do Evento do Ponto, ref. /eventosPonto
descricao character 40 Descrição do Evento do Ponto
numeroordem numérico 8 Número da Ordem
minutosdiurnos numérico 10 Minutos Diurnos
minutosnoturnos numérico 10 Minutos Noturnos
minutostotal numérico 10 Minutos Totais
quantidadeapurada decimal 18,6 Quantidade Apurada
valorapurado decimal 11,2 Valor Apurado
origemlanctoevento character 1

Origem de Lançamento do Evento:

  • G - Gerado
  • D - Digitado
origemcalculoponto character 1

Origem de Cálculo no Ponto:

  • B - Banco Horas   
  • D - Digitado
  • G - Gorjetas
  • M - Marcações Diversas 
  • P - Ponto
  • R - Refeitório
  • S - Simulação BH


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ lancamentosEventosPonto?eventoPonto=1& unidade=0001&contrato=296 & dataInicio=2020-08-01&dataFim=2020-08-31 &dataAlteracao=2020-08-01offset=0&limit=100


Query Params:

eventoPonto
unidade
contrato
dataInicio (YYYY-MM-DD)
dataFim (YYYY-MM-DD)
dataAlteracao (Obtém os lançamentos de eventos do ponto alterados a partir da data enviada)
offset
limit 

Operação: GET

Formato Retorno: JSON 

 

7.4 /marcacoesPeriodo

Campos retornados no recurso registros de marcacoes do período:

Campo Formato Tamanho Descrição
UNIDADE varchar 4 Código da Unidade.
CONTRATO int   Código do Contrato.
origem varchar 10 D - Digitada
E - Eletrônica
G - Gerada
M - Manutenção
P - Presumida
hora varchar 5 Hora Marcação.
numeroMarcacao varchar   A ordem da marcação realizada.
data datetime   Data da marcação.


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/marcacoesPeriodo ? dataInicio='2019-01-01'& dataFim='2019-01-31' & offset=0&limit=100


Query Params:

dataInicio
dataFim
offset
limit

Operação: GET

Formato Retorno: JSON

 

8. PortalRH

Os recursos pertencentes à divisão PortalRH na API Metadados, são um redirecionamento para seus correspondentes métodos no WebService do PortalRH.

8.1 /obterSaldoDoBancoDeHoras

Campos retornados no recurso obterSaldoDoBancoDeHoras:

Campo Formato Tamanho Descrição
unidade character 4 Código da Unidade, ref. /unidades
contrato character 8 Código do Contrato
mensagem character 40 Mensagem
codigoBancoHoras character 4 Código do Banco de Horas
nomeBancoHoras character 40 Nome do Banco de Horas
saldoMinutos numerico 5 Saldo em minutos

Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/portalrh/obterSaldoBancoDeHoras?unidade=0001&contrato=296&dataSolicitacao=2019-07-31


Query Params:

unidade *
contrato *
dataSolicitacao *
* campos obrigatórios

Operação: GET

Formato Retorno: XML

8.2 /obterSaldoDeFerias

Campos retornados no recurso obterSaldoDeFerias:

Campo Formato Tamanho Descrição
unidade character 4 Código da Unidade, ref. /unidades
contrato character 8 Código do Contrato
inicioPerAquisitivo datetime 23 Data de Início do Período Aquisitivo
terminoPerAquisitivo datetime 23 Data de Término do Período Aquisitivo
diasFaltadosPeriodo numerico 4 Número de Dias Faltados no Período
diasPerdidosPeriodo numerico 4 Número de Dias Perdidos no Período
diasCedidosPeriodo numerico 4 Número de Dias Cedidos no Período
diasAbonoPeriodo numerico 4 Número de Dias Abonados no Período
diasPendentesPeriodos numerico 4 Número de Dias Pendentes no Período
dataLimite datetime 23 Date Limite do Período

Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/portalrh/obterSaldoDeFerias?unidade=0001&contrato=296


Query Params:

unidade *
contrato *
* campos obrigatórios

Operação: GET

Formato Retorno: XML

8.3 /inserirMarcacoesPonto

Campos a serem enviados para o recurso inserirMarcacoesPonto:

Campo Formato Tamanho Descrição
unidade character 4 Código da Unidade, ref. /unidades
contrato character 8 Código do Contrato
marcacoes
  • dataHora
  • tipo
character
character
19
1
Data e Hora da Marcação
Tipo da Marcação:
  • D - Digitada
  • E - Eletrônica
  • G - Gerada
  • M - Manutenção
  • P - Presumida

Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/portalrh/inserirMarcacoesPonto


Exemplo de Body:

{
 "unidade": "0001",
 "contrato": 2,
 "marcacoes": [
  {
   "DataHora": "2019-08-02 08:10:00",
   "Tipo": "D"
  }
 ]
}

Operação: POST

Exemplo de Resposta:

{
 "unidade": "0001",
 "contrato": 2,
 "retorno": [
  {
   "DataHora": "2019-08-02T18:10:00",
   "Tipo": "D",
   "Status": "Marcação incluída com sucesso"
  }
 ]
}

8.4 /excluirMarcacoesPonto

Campos a serem enviados para o recurso excluirMarcacoesPonto:

Campo Formato Tamanho Descrição
unidade character 4 Código da Unidade, ref. /unidades
contrato character 8 Código do Contrato
marcacoesParaExcluir
  • dataHora
  • tipo
character
character
19
1
Data e Hora da Marcação
Tipo da Marcação

Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/portalrh/excluirMarcacoesPonto


Exemplo de Body:

{
 "unidade": "0001",
 "contrato": 296,
 "marcacoesParaExcluir": [
  {
   "DataHora": "2019-08-02 08:10:00",
   "Tipo": "D"
  }
 ]
}

Operação: POST

Exemplo de Resposta:

{
 "d": "[
    {
     "DataHora": "2019-08-02T18:10:00",
     "Tipo": "D",
     "Status": "Marcação excluída com sucesso"
    }
   ]"
}

8.5 /inserirSolicitacaoFerias

Campos a serem enviados para o recurso inserirSolicitacaoFerias:

Campo Formato Tamanho Descrição
unidade character 4 Código da Unidade, ref. /unidades
contrato character 8 Código do Contrato
solicitacaoFerias
  • inicioFerias
  • diasFerias
  • diasAbono
  • pagamento13Salario
character
numerico
numerico
boolean
10
2
2
Data de Início das Férias
Número de Dias
Número de Dias Abonados
Indicativo de Pagamento de 13° Salário

Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/portalrh/inserirSolicitacaoFerias


Exemplo de Body:

{
 "unidade": "0001",
 "contrato": 296,
 "solicitacaoFerias": {
   "InicioFerias": "2019-10-15",
   "DiasFerias": 15,
   "DiasAbono": 0,
   "Pagamento13Salario": false
 }
}

Operação: POST

Exemplo de Resposta:

{
 "d": "[
    {
     "InicioFerias": "2019-10-15T00:00:00",
     "DiasFerias": 15,
     "DiasAbono": 0,
     "Pagamento13Salario": false,
     "Situaca": 0,
     "NumeroSolicitacao": 30488,
     "Mensagem": "Sucesso"
    }
   ]"
}

 

8.6 /importarXmlEventos

Campos a serem enviados para o recurso importarXmlEventos:

Campo Obrigatório Formato Tamanho Descrição
xml   character   XML do evento.


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/portalrh/importarXmlEventos


Exemplo de Body:

{
        "xmlEvento": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<eSocial xmlns=\"http:\/\/www.esocial.gov.br\/schema\/evt\/evtMonit\/v_S_01_00_00\">\r\n <evtMonit Id=\"ID0000000000000000000000000000000000\">\r\n <ideEvento>\r\n <indRetif>1<\/indRetif>\r\n <tpAmb>1<\/tpAmb>\r\n <procEmi>1<\/procEmi>\r\n <verProc>1.0<\/verProc>\r\n <\/ideEvento>\r\n <ideEmpregador>\r\n <tpInsc>1<\/tpInsc>\r\n <nrInsc>12345<\/nrInsc>\r\n <\/ideEmpregador>\r\n <ideVinculo>\r\n <cpfTrab>99999999999<\/cpfTrab>\r\n\t <matricula>123<\/matricula>\r\n <\/ideVinculo>\r\n <exMedOcup>\r\n <tpExameOcup>1<\/tpExameOcup>\r\n <aso>\r\n <dtAso>2021-05-06<\/dtAso>\r\n <exame>\r\n <dtExm>2021-05-06<\/dtExm>\r\n <procRealizado>9999<\/procRealizado>\r\n <obsProc>AVALIA\u00C7\u00C3O OCUPACIONAL<\/obsProc>\r\n <ordExame>1<\/ordExame>\r\n <\/exame>\r\n <exame>\r\n <dtExm>2021-05-06<\/dtExm>\r\n <procRealizado>9999<\/procRealizado>\r\n <obsProc>AUDIOMETRIA<\/obsProc>\r\n <ordExame>2<\/ordExame>\r\n <\/exame>\r\n <exame>\r\n <dtExm>2021-05-06<\/dtExm>\r\n <procRealizado>9999<\/procRealizado>\r\n <obsProc>HEMOGRAMA<\/obsProc>\r\n <ordExame>1<\/ordExame>\r\n <\/exame>\r\n <exame>\r\n <dtExm>2021-05-06<\/dtExm>\r\n <procRealizado>9999<\/procRealizado>\r\n <obsProc>PLAQUETAS<\/obsProc>\r\n <ordExame>1<\/ordExame>\r\n <\/exame>\r\n <exame>\r\n <dtExm>2021-05-06<\/dtExm>\r\n <procRealizado>9999<\/procRealizado>\r\n <obsProc>RETICUL\u00D3CITOS<\/obsProc>\r\n <ordExame>1<\/ordExame>\r\n <\/exame>\r\n <medico>\r\n <nmMed>NOME MEDICO<\/nmMed>\r\n <nrCRM>99999<\/nrCRM>\r\n <ufCRM>RS<\/ufCRM>\r\n <\/medico>\r\n <\/aso>\r\n <respMonit>\r\n <cpfResp>99999999999<\/cpfResp>\r\n <nmResp>Nome do Responsavel<\/nmResp>\r\n <nrCRM>99999<\/nrCRM>\r\n <ufCRM>RS<\/ufCRM>\r\n <\/respMonit>\r\n <\/exMedOcup>\r\n <\/evtMonit>\r\n <Signature xmlns=\"http:\/\/www.w3.org\/2000\/09\/xmldsig#\">\r\n <SignedInfo>\r\n <CanonicalizationMethod Algorithm=\"http:\/\/www.w3.org\/TR\/2001\/REC-xml-c14n-20010315\"\/>\r\n <SignatureMethod Algorithm=\"http:\/\/www.w3.org\/2001\/04\/xmldsig-more#rsasha256\"\/>\r\n <Reference URI=\"\">\r\n <Transforms>\r\n <Transform Algorithm=\"http:\/\/www.w3.org\/2000\/09\/xmldsig#envelopedsignature\"\/>\r\n <Transform Algorithm=\"http:\/\/www.w3.org\/TR\/2001\/REC-xml-c14n-20010315\"\/>\r\n <\/Transforms>\r\n <DigestMethod Algorithm=\"http:\/\/www.w3.org\/2001\/04\/xmlenc#sha256\"\/>\r\n <DigestValue>CFJEIy1dUko99nNUW\/ICvG9ZNoij0o9IOhdP6Nt1j1k=<\/DigestValue>\r\n <\/Reference>\r\n <\/SignedInfo>\r\n <SignatureValue>...<\/SignatureValue>\r\n <KeyInfo>\r\n <X509Data>\r\n <X509Certificate>...<\/X509Certificate>\r\n <\/X509Data>\r\n <\/KeyInfo>\r\n <\/Signature>\r\n<\/eSocial>\r\n"  
}

 

Operação: POST

Exemplo de Resposta:

{
  "statusCode": 200,
  "body": {
        "xmlEvento": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<eSocial xmlns=\"http:\/\/www.esocial.gov.br\/schema\/evt\/evtMonit\/v_S_01_00_00\">\r\n <evtMonit Id=\"ID0000000000000000000000000000000000\">\r\n <ideEvento>\r\n <indRetif>1<\/indRetif>\r\n <tpAmb>1<\/tpAmb>\r\n <procEmi>1<\/procEmi>\r\n <verProc>1.0<\/verProc>\r\n <\/ideEvento>\r\n <ideEmpregador>\r\n <tpInsc>1<\/tpInsc>\r\n <nrInsc>12345<\/nrInsc>\r\n <\/ideEmpregador>\r\n <ideVinculo>\r\n <cpfTrab>99999999999<\/cpfTrab>\r\n\t <matricula>123<\/matricula>\r\n <\/ideVinculo>\r\n <exMedOcup>\r\n <tpExameOcup>1<\/tpExameOcup>\r\n <aso>\r\n <dtAso>2021-05-06<\/dtAso>\r\n <exame>\r\n <dtExm>2021-05-06<\/dtExm>\r\n <procRealizado>9999<\/procRealizado>\r\n <obsProc>AVALIA\u00C7\u00C3O OCUPACIONAL<\/obsProc>\r\n <ordExame>1<\/ordExame>\r\n <\/exame>\r\n <exame>\r\n <dtExm>2021-05-06<\/dtExm>\r\n <procRealizado>9999<\/procRealizado>\r\n <obsProc>AUDIOMETRIA<\/obsProc>\r\n <ordExame>2<\/ordExame>\r\n <\/exame>\r\n <exame>\r\n <dtExm>2021-05-06<\/dtExm>\r\n <procRealizado>9999<\/procRealizado>\r\n <obsProc>HEMOGRAMA<\/obsProc>\r\n <ordExame>1<\/ordExame>\r\n <\/exame>\r\n <exame>\r\n <dtExm>2021-05-06<\/dtExm>\r\n <procRealizado>9999<\/procRealizado>\r\n <obsProc>PLAQUETAS<\/obsProc>\r\n <ordExame>1<\/ordExame>\r\n <\/exame>\r\n <exame>\r\n <dtExm>2021-05-06<\/dtExm>\r\n <procRealizado>9999<\/procRealizado>\r\n <obsProc>RETICUL\u00D3CITOS<\/obsProc>\r\n <ordExame>1<\/ordExame>\r\n <\/exame>\r\n <medico>\r\n <nmMed>NOME MEDICO<\/nmMed>\r\n <nrCRM>99999<\/nrCRM>\r\n <ufCRM>RS<\/ufCRM>\r\n <\/medico>\r\n <\/aso>\r\n <respMonit>\r\n <cpfResp>99999999999<\/cpfResp>\r\n <nmResp>Nome do Responsavel<\/nmResp>\r\n <nrCRM>99999<\/nrCRM>\r\n <ufCRM>RS<\/ufCRM>\r\n <\/respMonit>\r\n <\/exMedOcup>\r\n <\/evtMonit>\r\n <Signature xmlns=\"http:\/\/www.w3.org\/2000\/09\/xmldsig#\">\r\n <SignedInfo>\r\n <CanonicalizationMethod Algorithm=\"http:\/\/www.w3.org\/TR\/2001\/REC-xml-c14n-20010315\"\/>\r\n <SignatureMethod Algorithm=\"http:\/\/www.w3.org\/2001\/04\/xmldsig-more#rsasha256\"\/>\r\n <Reference URI=\"\">\r\n <Transforms>\r\n <Transform Algorithm=\"http:\/\/www.w3.org\/2000\/09\/xmldsig#envelopedsignature\"\/>\r\n <Transform Algorithm=\"http:\/\/www.w3.org\/TR\/2001\/REC-xml-c14n-20010315\"\/>\r\n <\/Transforms>\r\n <DigestMethod Algorithm=\"http:\/\/www.w3.org\/2001\/04\/xmlenc#sha256\"\/>\r\n <DigestValue>CFJEIy1dUko99nNUW\/ICvG9ZNoij0o9IOhdP6Nt1j1k=<\/DigestValue>\r\n <\/Reference>\r\n <\/SignedInfo>\r\n <SignatureValue>...<\/SignatureValue>\r\n <KeyInfo>\r\n <X509Data>\r\n <X509Certificate>...<\/X509Certificate>\r\n <\/X509Data>\r\n <\/KeyInfo>\r\n <\/Signature>\r\n<\/eSocial>\r\n",
        "retorno": {
            "EventosImportados": [
                {
                    "Evento": null
                }
            ],
            "EventosNaoImportados": [
                {
                    "Evento": {
                        "Id": "ID1101694638000566202105311407400001",
                        "Situacao": "Contrato não encontrado"
                    }
                }
            ]
        }
    }
}

 

8.7 /solicitacoes

Campos retornados no recurso registros de solicitações:

Campo Formato Tamanho Descrição
idSolicitacao varchar 16 Código identificador da solicitação.
numeroSolicitacao int   Número da solicitação.
idUsuario varchar 16 Código identificador do usuário solicitante.
nomeUsuario varchar 64 Nome do usuário solicitante.
empresa varchar 4 Código da empresa.
pessoa int   Código da Pessoa.
observacoes text   Observações.
dataSolicitacao datetime   Data da solicitação.
situacao varchar 1 Código da situação da solicitação.
tipoSolicitacao varchar 16 Código identificador do tipo da solicitação.
descTipoSolicitacao varchar 16 Descrição do tipo da solicitação.
estadoSolicitacao char 1 L - Liberado
P - Em Processamento


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/planosCargos ? tipoSolicitacao='CB08E79C-8EBC-4751-AE80-5AF9DF5C63A2'& estadoSolicitacao='B' & offset=0&limit=100


Query Params:

tipoSolicitacao
estadoSolicitacao
offset
limit

Operação: GET

Formato Retorno: JSON

9. Recrutamento e Seleção

9.1 /requisicoes

Campos retornados no recurso requisições:

Campo Formato Tamanho Descrição
requisicao character 8 Código da Requisição
dataRequisicao datetime 8 Data da Requisição
codSituacaoRequisicao character 1

Situação da Requisição:

  • A - Aguardando Aprovação
  • C - Cancelada
  • E - Encerrada
  • N - Aberta
  • S - Suspensa
quantidadeVagas inteiro inteiro Quantidade de vagas
codMotivoVaga character 2

Código do Motivo da Vaga:

  • 01 - Aumento de Quadro
  • 02 - Substituição
  • 03 - Transferência
  • 09 - Outros
motivoVaga character 17 Descritos acima
salarioMaximo decimal 11,2 Salário Máximo da Vaga
salarioMaximo decimal 11,2 Salário Máximo da Vaga
idadeMinima inteiro inteiro Idade Mínima para Vaga
idadeMaxima inteiro inteiro Idade Máxima para Vaga
sexoRequisicao character 1

Sexo Requisitado para Vaga:

  • A - Ambos
  • F - Feminino
  • M - Masculino
codGrauInstrucao character 2

Grau de Instrução:

  • 01 - Analfabeto
  • 02 - Até o 5º Ano Incompleto do Ensino Fundamental
  • 03 - 5º Ano Completo do Ensino Fundamental
  • 04 - Do 6º ao 9º Ano do Ensino Fundamental
  • 05 - Ensino Fundamental Completo
  • 06 - Ensino Médio Incompleto
  • 07 - Ensino Médio Completo
  • 08 - Técnico
  • 09 - Educação Superior Incompleta
  • 10 - Educação Superior Completa
  • 11 - Pós-Graduação
  • 12 - Mestrado
  • 13 - Doutorado

OBS: É possível que a tabela de grau de instrução seja customizada, portanto, os códigos podem apresentar diferenças em relação aos listados acima.
grauInstrucao character 20 Descritos acima
setor character 8 Código do Setor, ref. /setores
funcao character 8 Código da Função, ref. /funcoes
postoTrabalho character 8 Código do Posto de Trabalho
centroCusto1 character 8 Código do Centro de Custo 1, ref. /centrosCusto
centroCusto2 character 8 Código do Centro de Custo 2, ref. /centrosCusto2
centroCusto3 character 8 Código do Centro de Custo 3, ref. /centrosCusto3
centroCusto4 character 8 Código do Centro de Custo 4, ref. /centrosCusto4
classificacaoGerencial character 8 Código da Classificação Gerencial, ref. /classificacoesGerenciais
cargo character 8 Código do Cargo, ref. /cargos
vinculoEmpregaticio character 2 Código do Vínculo Empregatício, ref. /vinculosEmpregaticios
codAreaAtuacao character 4 Código da Área de Atuação
areaAtuacao character 20 Descrição da Área de Atuação
empresa character 4 Código da Empresa, ref. /empresas
unidade character 4 Código da Unidade, ref. /unidades
prazoEncerramento datetime 8 Prazo para Encerramento
codSituacaoEmprego character 1

Situação do Emprego:

  • 1 - Está trabalhando
  • 2 - Não está trabalhando
  • 3 - Desconsiderar
  • null - Parâmetro não setado
candidatosExternos character 1

Aceita candidatos externos:

  • N - Não
  • S - Sim
  • null - Parâmetro não setado
candidatosInternos character 1

Aceita candidatos internos:

  • N - Não
  • S - Sim
  • null - Parâmetro não setado
exFuncionarios character 1

Aceita ex-funcionários:

  • N - Não
  • S - Sim
  • null - Parâmetro não setado
escala character 4 Código da Escala de Horários, ref. /escalas
divulgarVagaExt character 4

Divulga vaga externamente:

  • N - Não
  • S - Sim
  • null - Parâmetro não setado
inicioSelecao datetime 8 Início da Seleção
codSituacaoAprovacao character 1

Situação da aprovação:

  • 1 - Pendente
  • 2 - Concedida
  • 3 - Rejeitada
  • null - Parâmetro não setado
dataAprovacao datetime 8 Data da Aprovação
dataCancelamento datetime 8 Data do Cancelamento


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/recrutamentoSelecao/ requisicoes? requisicao=00000003& codSituacaoRequisicao=N& codSituacaoAprovacao=2& dataRequisicao=2010-08-18& prazoEncerramento=2010-11-18& inicioSelecao=2010-09-18& offset=0& limit=100

 


Query Params:

requisicao
codSituacaoRequisicao
codSituacaoAprovacao
dataRequisicao
prazoEncerramento
inicioSelecao
offset
limit

Operação: GET

Formato Retorno: JSON 

 

9.2 /pessoa

Campos a serem enviados para o recurso pessoa:

Campo Obrigatório Formato Tamanho Descrição
empresa S varchar 4 Código da Empresa, cfe. Tabela de Empresas.
nome S varchar 40 Nome da Pessoa.
nomeCompleto S varchar 70 Nome Completo da Pessoa.
nascimento S datetime   Data de Nascimento.
localNascimento S varchar 20 Local de Nascimento.
ufNascimento S varchar 2 UF de Nascimento:
  • AC - AC
  • AL - AL
  • AM - AM
  • AP - AP
  • BA - BA
  • CE - CE
  • DF - DF
  • ES - ES
  • GO - GO
  • MA - MA
  • MG - MG
  • MS - MS
  • MT - MT
  • PA - PA
  • PB - PB
  • PE - PE
  • PI - PI
  • PR - PR
  • RJ - RJ
  • RN - RN
  • RO - RO
  • RR - RR
  • RS - RS
  • SC - SC
  • SE - SE
  • SP - SP
  • TO - TO
sexo S char 1 Sexo:
  • F - Feminino
  • M - Masculino
racaCor S char 1 Raça/Cor:
  • 1 - Indígena
  • 2 - Branca
  • 4 - Preta
  • 6 - Amarela
  • 8 - Parda
  • 9 - Não informada
rua S varchar 40 Rua (endereço).
numeroRua S varchar 8 Número (endereço).
complemento N varchar 20 Completo (endereço).
bairro N varchar 20 Bairro.
cidade S varchar 20 Cidade.
cep S varchar 10 CEP.
uf S varchar 2 UF:
  • AC - AC
  • AL - AL
  • AM - AM
  • AP - AP
  • BA - BA
  • CE - CE
  • DF - DF
  • ES - ES
  • GO - GO
  • MA - MA
  • MG - MG
  • MS - MS
  • MT - MT
  • PA - PA
  • PB - PB
  • PE - PE
  • PI - PI
  • PR - PR
  • RJ - RJ
  • RN - RN
  • RO - RO
  • RR - RR
  • RS - RS
  • SC - SC
  • SE - SE
  • SP - SP
  • TO - TO
ddd S varchar 4 DDD Celular.
telefone S varchar 15 Celular.
email S varchar 80 Email.
cpf N varchar 11 CPF.
rg N varchar 14 Número do Registro de Identidade Civil.
ctps N varchar 10 Número da Carteira de Trabalho.
ctpsSerie N varchar 5 Série da Carteira de Trabalho.
ctpsDataEmissao N datetime   Data de Emissão da Carteira de Trabalho.
ctpsUf N varchar 2 UF da CTPS:
  • AC - AC
  • AL - AL
  • AM - AM
  • AP - AP
  • BA - BA
  • CE - CE
  • DF - DF
  • ES - ES
  • GO - GO
  • MA - MA
  • MG - MG
  • MS - MS
  • MT - MT
  • PA - PA
  • PB - PB
  • PE - PE
  • PI - PI
  • PR - PR
  • RJ - RJ
  • RN - RN
  • RO - RO
  • RR - RR
  • RS - RS
  • SC - SC
  • SE - SE
  • SP - SP
  • TO - TO
rgDataEmissao N datetime   Data de Expedição do Registro de Identidade Civil.
rgOrgaoEmissor N varchar 8 Órgão Emissor do Registro de Identidade Civil.
rgUf N varchar 2 UF do RG:
  • AC - AC
  • AL - AL
  • AM - AM
  • AP - AP
  • BA - BA
  • CE - CE
  • DF - DF
  • ES - ES
  • GO - GO
  • MA - MA
  • MG - MG
  • MS - MS
  • MT - MT
  • PA - PA
  • PB - PB
  • PE - PE
  • PI - PI
  • PR - PR
  • RJ - RJ
  • RN - RN
  • RO - RO
  • RR - RR
  • RS - RS
  • SC - SC
  • SE - SE
  • SP - SP
  • TO - TO
tituloEleitoral N varchar 15 Título Eleitoral.
zonaEleitoral N varchar 4 Zona Eleitoral.
secaoEleitoral N varchar 4 Seção Eleitoral.
estadoCivil S varchar 2 Estado Civil:
  • 01 – Solteiro
  • 02 – Casado
  • 03 – Viúvo
  • 04 – Separado
  • 05 – Divorciado
  • 06 – União Estável Solteiro 
  • 07 – União Estável Divorciado
  • 08 – União Estável Viúvo
nacionalidade S varchar 2 Nacionalidade (cfe. Tabela da Rais).
pai S varchar 40 Nome do Pai.
mae S varchar 40 Nome da Mãe.
pis S varchar 11 PIS.
pisDataCadastro N datetime   Data do Cadastramento do PIS.
cnh N varchar 15 Registro da Carteira de Habilitação.
cnhValidade N datetime   Data de Validade da Carteira de Habilitação.
cnhCategoria N varchar 3 Categoria da Carteira de Habilitação.
cnhExpedicao N datetime   Data de Expedição da Carteira de Habilitação.
deficienteFisico S char 1 Deficiente Físico:
  • 0 - Não Deficiente
  • 1 - Deficiente Físico
  • 2 - Deficiente Auditivo
  • 3 - Deficiente Visual
  • 4 - Deficiente Intelectual (mental)
  • 5 - Deficiente Múltiplo
Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/recrutamentoSelecao/pessoa


Exemplo de Body:

{
  "empresa": "0001",
  "nome": "Nome",
  "nomeCompleto": "Nome",
  "nascimento": "2000-04-04",
  "localNascimento": "São Paulo",
  "ufNascimento": "SP",
  "sexo": "F",
  "racaCor": "2",
  "rua": "Rua",
  "numeroRua": "50",
  "complemento": "",
  "bairro": "Nova",
  "cidade": "Caxias do Sul",
  "cep": "12345",
  "uf": "SP",
  "ddd": "12",
  "telefone": "545454",
  "email": "email@hotmail.com",
  "cpf": "45454",
  "rg": "5545",
  "ctps": "454",
  "ctpsSerie": "2121",
  "ctpsDataEmissao": "2018-01-19",
  "ctpsUf": "SP",
  "rgDataEmissao": "2020-02-04",
  "rgOrgaoEmissor": "SSP",
  "rgUf": "SP",
  "tituloEleitoral": "5454",
  "zonaEleitoral": "000",
  "secaoEleitoral": "0000",
  "estadoCivil": "06",
  "nacionalidade": "10",
  "pai": "Pai",
  "mae": "Mae",
  "pis": "5454",
  "pisDataCadastro": "2018-07-25",
  "cnh": "454",
  "cnhValidade": "2024-01-07",
  "cnhCategoria": "AB",
  "cnhExpedicao": "2020-10-30",
  "deficienteFisico": "0"
}

Operação: POST

Exemplo de Resposta:

{
  "statusCode": 200,
  "message": "Register successfully created.",
  "info": {
    "empresa": "0001",
    "pessoa": 101000833
  }
}

9.3 /requisicao/{requisicao}

Campos a serem enviados para o recurso requisicao:

Campo Obrigatório Formato Tamanho Descrição
empresa S varchar 4 Código da empresa.
pessoa S int   Código da pessoa.
requisicao S varchar 8 Código da requisição ao qual a pessoa será vinculada.


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/recrutamentoSelecao/requisicao/00000007

 

Path Params:

requisicao


Exemplos de Body:

{
    "pessoas": [
        {
            "empresa": "0001",
            "pessoa": "6"
        }
    ]
}

 

Operação: PATCH

Formato Retorno: JSON

Exemplo de Resposta:

{
    "pessoas": [
    {
        "message": "Register successfully created.",
        "info": {
        "requisicao": "00000007",
        "empresa": "0001",
        "pessoa": 4
        }
    }
    ]
}

10. Saúde Ocupacional

10.1 /aso

Campos a serem enviados para o recurso aso:

Campo Obrigatório Formato Tamanho Descrição
empresa S varchar 4 Código da empresa.
pessoa S int   Código da pessoa.
nroOrdem S int   Código Sequencial do ASO da pessoa.
dataAdmissao N datetime   Data de admissão.
estabelecimento N varchar 4 Código do estabelecimento da pessoa.
postoTrabalho S varchar 8 Código do posto de trabalho da pessoa.
cargo S varchar 8 Código do Cargo da pessoa.
funcao S varchar 8 Código da Função da pessoa.
tipoASO S char 1
  • 1 - Admissional
  • 2 - Periódico
  • 3 - Retorno ao Trabalho
  • 4 - Mudança de Riscos Ocupacionais
  • 5 - Demissional
  • 9 - Complementar
formaSelecaoExames S char 1
  • 1 - Agendados + Realizados
  • 2 - Realizados
dataInicio S datetime   Data início do ASO.
dataTermino S datetime   Data término do ASO.
tipoAvaliacaoASO S char 1
  • 1 - Apto
  • 2 - Não Apto
  • 3 - Apto c/Restrições
  • 4 - Apto c/Restr. Temp.
  • 9 - Não Avaliado
observacoes N text   Observações.
profissional N varchar 4 Código do médico cadastrado no Metadados.
medicoPCMSO N varchar 4 Código do médico cadastrado no Metadados.
cidadeLocal N varchar 20 Cidade.
dataEmissao S datetime   Data de emissão do ASO.
origemRegistro S char 1
  • 1 - Automático
  • 2 - Digitado
  • 3 - Importado
selecExamesMaisAtuais S char 1
  • 1 - Não
  • 2 - Sim
selecItensMaisAtuais S char 1
  • N - Não
  • S - Sim
servicoMedico N varchar 4 Código do serviço médico cadastrado no Metadados.
profissionalMonitoracao N varchar 4 Código do profissional de monitoração cadastrado no Metadados.

Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/aso


Exemplo de Body:

{
  "empresa": "0001",
  "pessoa": 1,
  "nroOrdem": 25,
  "dataAdmissao": null,
  "estabelecimento": null,
  "postoTrabalho": null,
  "cargo": null,
  "funcao": null,
  "tipoASO": null,
  "formaSelecaoExames": null,
  "dataInicio": null,
  "dataTermino": null,
  "tipoAvaliacaoASO": null,
  "observacoes": null,
  "profissional": null,
  "medicoPCMSO": null,
  "cidadeLocal": null,
  "dataEmissao": null,
  "origemRegistro": null,
  "selecExamesMaisAtuais": null,
  "selecItensMaisAtuais": null,
  "servicoMedico": null,
  "profissionalMonitoracao": null
}


Operação: POST

Exemplo de Resposta:
 
{
    "message": "Registros inseridos com sucesso"
}
 

11. Segurança do Trabalho

11.1 /entregasEpi

Campos retornados no recurso entregas de EPI:

Campo Formato Tamanho Descrição
unidade character 4 Código da Unidade, ref. /unidades
contrato numérico 8 Código do Contrato, ref. /contratos
epi character 16 Código do EPI
dataentrega datetime 8 Data da Entrega
codigoestoque character 16 Código do Estoque
quantidadeentregue inteiro inteiro Quantidade Entregue
classificacaocontabil character 8 Código da Classificação Contábil, ref. /classificacoesContabeis
centrocusto1 character 8 Código do Centro de Custo 1, ref. /centrosCusto
centrocusto2 character 8 Código do Centro de Custo 2, ref. /centrosCusto2
centrocusto3 character 8 Código do Centro de Custo 3, ref. /centrosCusto3
centrocusto4 character 8 Código do Centro de Custo 4, ref. /centrosCusto4
setor character 8 Código do Setor, ref. /setores
cargo character 8 Código do Cargo, ref. /cargos
postotrabalho character 8 Código do Posto de Trabalho
classificacaogerencial character 8 Código da Classificação Gerencial, ref. /classificacoesGerenciais
datahoraregistro datetime 8 Data e Hora do Registro
operacao character 1

Tipo da Operação:

  • I - Incluído
  • E - Excluído


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/entregasEpi ?unidade=0001& contrato=266& epi=00000125& dataEntrega>=2020-08-01& dataEntrega <=2020-09-31 & offset=0&limit=100


Query Params:

unidade
contrato 
epi
dataEntrega (YYYY-MM-DD): Podem ser utilizados os operadores >=, <= e =
offset
limit

Operação: GET

Formato Retorno: JSON

 

11.2 /entradaEstoqueEPI

Campos a serem enviados para o recurso entradaEstoqueEPI:

Campo Obrigatório Formato Tamanho Descrição
estoque S character 4 Código do Estoque
codigoEstoque S character 16 Código no Estoque
lote S character 20 Lote do Produto
quantidade S decimal 9,2 Quantidade do Produto
movimento S inteiro inteiro Tipo de Movimento
observacoes N texto 2³¹ Observações do EPI
valorUnitario N decimal 15,2 Valor unitário do EPI

Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/entradaEstoqueEPI


Exemplo de Body:

{
  "estoque": "03",
  "codigoEstoque": "00010001",
  "lote": "00000000000000000011",
  "quantidade": 200,
  "movimento": 1,
  "observacoes": "Lote novo",
}

Operação: POST

Exemplo de Resposta:

{
  "statusCode": 200,
  "message": "Register successfully inserted.",
}

12. Skeel

12.1 /cpf

Campos retornados no recurso registros de cpf:

Campo Formato Tamanho Descrição
cpf varchar 11 Número do CPF.


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/skeel/cpf ?cpf=12345678910& offset=0&limit=100


Query Params:

cpf
offset
limit

Operação: GET

Formato Retorno: JSON

 

12.2 /empregosAnteriores

Campos retornados no recurso registros de empregos anteriores:

Campo Formato Tamanho Descrição
cpf varchar 11 CPF do colaborador.
unidade varchar 4 Código da unidade.
contrato int   Código do contrato.
codSituacao int   Código da situação do contrato.
situacao varchar 60 Descrição da situação do contrato.
dataAdmissao datetime   Data da admissão.
dataRescisao datetime   Data da rescisão.
coigoMotivoRescisao varchar 4 Código do motivo de rescisão.
motivoRescisao varchar 40 Descrição do motivo de rescisão.
motivoRescisaoEsocial varchar 60 Descrição do motivo de rescisão do ESOCIAL.


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/skeel/empregosAnteriores ? cpf=84731488001& situacao<=4 & offset=0&limit=100


Query Params:

cpf
situacao<
offset
limit

Operação: GET

Formato Retorno: JSON

13. Treinamento e Desenvolvimento

13.1 /cursos

Campos retornados no recurso cursos:

Campo Formato Tamanho Descrição
curso character 15 Código do Curso
descricao character 50 Descrição do Curso
datacriacao datetime 8 Data de Criação do Curso
datadesativacao datetime 8 Data de Desativação do Curso
cargahoraria decimal 7,2 Carga Horária do Curso


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ cursos?curso=0001& offset=0&limit=100


Query Params:

curso
offset
limit

Operação: GET

Formato Retorno: JSON

 

13.2 /pessoasCursos

Campos retornados no recurso pessoas cursos:

Campo Formato Tamanho Descrição
empresa character 4 Código da Empresa, ref. /empresas
unidade character 4 Código da Unidade, ref. /unidades
pessoa numérico 8 Código da Pessoa, ref. /contratos
curso character 15 Código do Curso, ref. /cursos
datainicio datetime 8 Data de Início do Curso
dataencerramento datetime 8 Data de Encerramento do Curso
status character 1

Impressão Folha:

  • A - Aprovado
  • C - Cancelado
  • P - Programado
  • R - Reprovado
nota character 15 Nota do Curso
cargahoraria decimal 7,2 Carga Horária do Curso
cargo character 4 Código do Cargo, ref. /cargos
setor character 4 Código do Setor, ref. /setores
evento character 4 Código do Evento
centrocusto1 character 4 Código do Centro de Custo 1, ref. /centrosCusto
centrocusto2 character 4 Código do Centro de Custo 2, ref. /centrosCusto2
centrocusto3 character 4 Código do Centro de Custo 3, ref. /centrosCusto3
centrocusto4 character 4 Código do Centro de Custo 4, ref. /centrosCusto4


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ pessoasCursos?curso=Ambientacao&empresa=0001&pessoa=298& dataInicio=2020-08-01&dataEncerramento=2020-08-31 & offset=0&limit=100


Query Params:

curso
empresa
pessoa
dataInicio (YYYY-MM-DD)
dataEncerramento (YYYY-MM-DD) 
offset
limit

Operação: GET

Formato Retorno: JSON

 

13.3 /eventos

Campos retornados no recurso eventos:

Campo Formato Tamanho Descrição
evento character 7 Código do Evento
datainicio datetime 8 Data de Início do Evento
dataencerramento datetime 8 Data de Encerramento do Evento
observacoes texto 2³¹ Observações do Evento
situacaoevento character 1

Situação do Evento:

  • C - Cancelado
  • F - Finalizado
  • L - Planejado
  • P - Programado


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ eventos?evento=0001&situacaoEvento=F& offset=0&limit=100


Query Params:

evento
situacaoEvento 
offset
limit

Operação: GET

Formato Retorno: JSON

 

13.4 /eventoHoras

Campos retornados no recurso evento horas:

Campo Formato Tamanho Descrição
evento character 7 Código do Evento
dataevento datetime 8 Mês/Ano do Evento
cargahoraria decimal 7,2 Carga Horária do Evento


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/sirh/ eventoHoras?evento=0001&dataEvento>=2020-08-01&dataEvento<=2020-08-31& offset=0&limit=100


Query Params:

evento
dataEvento (YYYY-MM-DD): Podem ser utilizados os operadores >=, <= e =
offset
limit

Operação: GET

Formato Retorno: JSON

 

13.5 /cursos

Campos a serem enviados para o recurso cursos:

Campo Obrigatório Formato Tamanho Descrição
curso S varchar 15 Código do Curso que será criado no Metadados.
descCurso S varchar 50 Descrição do Curso que será criado no Metadados.
dataCriacao S datetime   Data de criação do curso.
cargaHoraria S decimal   Carga horária.
ultimaRevisaoExigida S int   Revisão do curso.
ultimaDataRevisaoExigida S datetime   Data de revisão do curso.
validade N int   Meses de validade do curso.
tipoLocal S char 1
  • E - Externo
  • I - Interno
tipoCurso S varchar 2 Código do tipo do curso previamente cadastrado no Metadados.
programaCurso S text   Descrição do conteúdo do curso.
dataDesativacao S datetime   Data de desativação do curso.

Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/treinamentos/cursos


Exemplo de Body:

{
  "curso": "7778",
  "descCurso": "Cursos 123456789",
  "dataCriacao": "2022-04-19",
  "cargaHoraria": "10",
  "ultimaRevisaoExigida": "0",
  "ultimaDataRevisaoExigida": "2002-03-01",
  "validade": "12",
  "tipoLocal": "I",
  "tipoCurso": "01",
  "programaCurso": "Teste 123",
  "dataDesativacao": "2005-03-05"
}


Operação: POST

Exemplo de Resposta:

{
  "statusCode": 200,
  "message": "Curso persistido com sucesso."
}

 

13.6 /necessidades

Campos a serem enviados para o recurso necessidades:

Campo Obrigatório Formato Tamanho Descrição
curso S varchar 15 Código do Curso que deseja inserir como uma necessidade.
codigo S varchar 8 Código do cargo, função, setor, empresa, unidade ou posto de trabalho ao qual deseja inserir a necessidade de curso.
tipoNecessidade S varchar  
  • S - para inserir uma necessidade a um Setor
  • C - para inserir uma necessidade a um Cargo
  • F - para inserir uma necessidade a uma Função
  • E - para inserir uma necessidade a uma Empresa
  • U - para inserir uma necessidade a uma Unidade
  • PT - para inserir uma necessidade a um Posto de Trabalho
revisao N int   Inteiro identificador da revisão do curso.
dtRevisao N date 2 Data ao qual o curso foi revisado.
necessidade N char 1
  • O - para Obrigatório
  • R - para recomendável
Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/treinamentos/necessidades


Exemplo de Body:

{
  "curso": "7778",
  "codigo": [
        "0002",
        "0004",
        "0001"
  ],
  "tipoNecessidade": "C",
  "revisao": "0",
  "dtRevisao": "2002-03-01",
  "necessidade": "R"
}


Operação: POST

Exemplo de Resposta:

{
  "statusCode": 200,
  "message": "Necessidade persistida com sucesso."
}

 

13.7 /pessoaCursos

Campos a serem enviados para o recurso pessoaCursos:

Campo Obrigatório Formato Tamanho Descrição
empresa S varchar 4 Código da empresa do Metadados.
pessoa S int   Código da pessoa do Metadados.
curso S varchar 15 Código do curso cadastrado no Metadados.
revisao S int   Código da revisão do curso.
dataRevisao S datetime   Data de revisão do curso.
dataInicio S datetime   Data em que a pessoa iniciou o curso.
cargaHoraria S decimal   Carga horária que a pessoa realizou o curso.
status S char 1
  • A - Aprovado
  • C - Cancelado
  • P - Programado
  • R - Reprovado

Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/treinamentos/pessoaCursos


Exemplo de Body:

{
  "empresa": "0001",
  "pessoa": "1",
  "curso": "7778",
  "revisao": "0",
  "dataRevisao": "2002-03-01",
  "dataInicio": "05-01-2002",
  "cargaHoraria": "50",
  "status": "A"
}


Operação: POST

Exemplo de Resposta:

{
  "statusCode": 200,
  "message": "Vínculo persistido com sucesso."
}

13.8 /umentor/cursos

Campos retornados no recurso umentorCursos:

Campo Formato Tamanho Descrição
curso character 15 Código do Curso

ultimaRevisaoExigida

 int   Código da última revisão do Curso
descCurso
 character 50 Descrição do Curso


Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/treinamentos/umentor/cursos?offset=0&limit=100


Query Params:

offset
limit

 

Operação: GET

Formato Retorno: JSON

 

13.9 /umentor/pessoaCursos

Campos a serem enviados para o recurso umentorPessoaCursos:

Campo Obrigatório Formato Tamanho Descrição
descricaoIntegracaoColaborador S varchar 50 Deve ser informado o código da unidade concatenado com ponto mais o código do contrato.
descricaoIntegracaoCurso S varchar 50 Código do Curso concatenado com ponto mais o código da revisão do curso.
dataInicio S datetime   Data de início do curso.
dataTermino S datetime   Data de fim do curso.
status S varchar 1

Status do curso:

A - Aprovado

C - Cancelado

P - Programado

R - Reprovado

Exemplo de Requisição:

https://metadados.gateway.linkapi.com.br/v4/treinamentos/umentor/pessoaCursos


Exemplo de Body:

{
  "descricaoIntegracaoColaborador": "0001.1",
  "descricaoIntegracaoCurso": "0002.0",
  "dataInicio": "2014-01-01",
  "dataTermino": "2014-02-10",
  "status": "C"
}


Operação: POST

Exemplo de Resposta:

{
  "message": "Vículo criado com Sucesso",
  "registro": {
    "descricaoIntegracaoColaborador": "0001.1",
    "descricaoIntegracaoCurso": "0002.0",
    "dataInicio": "2014-01-01",
    "dataTermino": "2014-02-10",
    "status": "C"
  },
  "detail": "Pessoa/curso criado com sucesso"
}