Histórico da Página

...

Endpoint:api/rh/v1/ahgora/results
Método: POST
Autenticação: Basic

Cadastros Básicos para integração

Antes da integração dos resultados para o Protheus, é necessário que existam cadastros básicos no sistema da Ahgora, para os resultados, devem ser cadastradas as verbas:

Verbas - Tabela SRV; -

Os códigos deverão ser enviados concatenados com empresa/filial(Quando for exclusiva) e código do registro.

Nota

title	Observação

Os cadastros básicos serão realizados pela equipe de implantação. Quem estiver responsável pela implantação deverá extrair os dados do Protheus e concatenar os códigos correspondentes de cada empresa/filial antes de importá-los no sistema Ahgora.

Para essa extração no protheus, pode ser usada a consulta genérica.

Documentação: RH - Linha Protheus - GPE - Consulta de informações em arquivos por Consulta Genérica

Informações

title	Importante

Autenticação Basic: Enviar usuário e senha do protheus no header da requisição.

Body Body da requisição

Deck of Cards

startHidden	false
id	body

Card

default	true
id	body1
label	Definição das propriedades
title	Definição das propriedades

Campos Protheus	Propriedades API	Descrição
RGB_MAT	matricula	Matrícula do funcionário - Matrícula deve ser enviada concatenada sem o pipe: Empresa + Filial + Matricula
RGB_PERIOD	anocom	Ano do período do resultado
RGB_PERIOD	mescom	Mês do período do resultado
RGB_SEMANA	semana	campoAdicional	Para o protheus será tratado para verificar a semana Semana do período
	codfuncionario	Código do funcionário separado por pipe contendo Empresa + Filial + Matrícula
RGB_PD	rubrica	Código da verba do funcionário
RGB_HORAS	referencia	Referência em horas ou dia da verba
RGB_DTREF	datafalta	Data da falta

Informações

title	Importante

Envio do atributo 'datafalta' vazio, será assumido o primeiro dia do período que está sendo processado, todas as verbas serão gravadas com referência.

Para o atributo 'campoAdicional', para o protheus será usado para enviar a semana do período, caso seja enviado vazio, será assumido a semana aberta do período em questão.

Caso ocorra um segundo envio do resultado para o funcionário no mesmo período, o primeiro envio do resultado será deletado da tabela RGB, e será gravado apenas o último envio.

Card

id	body2
label	Body
title	Body

Bloco de código

language	cpp
theme	Confluence
title	Body

{
  "items": [
    {
      "matricula": "0000010101000001",
      "anocom": "2024",
      "mescom": "08",
      "semanacampoAdicional": "1",
      "codfuncionario": "01|01|000001",
      "resultados": [
        {
          "rubrica": "114",
          "referencia": "1,30",
          "datafalta": ""
        }
      ]
    }
  ]
}

...

Deck of Cards

startHidden	false
id	retorno

Card

default	true
id	200ok
label	200 - OK
title	Sucesso

Propriedades API	Descrição
matricula	Matrícula do funcionário concatenada por Empresa + Filial + Matricula
rubrica	Verba processada
status	Status 'S'(Sucesso) ou 'E'(Erro)
mensagem	Detalhe da mensagem
referencia	Referência da rubrica
datafalta	Data da falta quando houver

Retorno status 'S'

Bloco de código

language	cpp
theme	Confluence
title	Retorno status 'S'Operação realizada com sucesso!

{
  "response": [
    {
      "resultados": [
        {
          "matricula": "0000010101000001",
          "rubrica": "114",
          "status": "S",
          "mensagem": "Operação realizada com sucesso!",
          "referencia": "1",
          "datafalta": "20240722" 
        }        }
      ]
    }
  ]
}

Retorno status 'E'

Bloco de código

language	cpp
theme	Confluence
title	Retorno status 'E'Verba não encontrada na base de dados

{
  "response": [
    {
      "resultados": [
        {
          "matricula": "0000010101000001",
          "rubrica": "ASD",
          "status": "E",
          "mensagem": "Verba não encontrada na base de dados.",
		  "referencia": "1",
          "datafalta": ""  
         }
      ]
    }
  ]
}

Card

id	400bas
label	400 - Solicitação inválida
title	Body

Propriedades API

Descrição

empresa

Código da empresa

filial

Filial do funcionário

user

Usuário do sistema

matricula

Matrícula do funcionário

periodo

Ano/Mês do Período

semana

Semana do período

processo

Código do processo do período

roteiro

Roteiro de cálculo do período

mensagem

Detalhe da mensagem

Bloco de código

language	cpp
theme	Confluence
title	Retorno funcionário não encontrada na base de dados

{
  "response": [
    {
      "resultados": [
        {
          "matricula": "0101XXXXXX",
          "rubrica": "001",
          "status": "E",
          "mensagem": "Funcionário não localizado na base de dados.",
          "filialreferencia": "D MG 01 ",
 "1",
          "datafalta": "20240722"  
        },
        {
          "matricula": "XXXXX",
  "message"0101XXXXXX",
          "rubrica": "001",
          "status": "E",
          "mensagem": "Funcionário não localizado na base de dados.",
          "referencia": "1",
          "datafalta": "20240723"           
        }
      ]
    }
  ]
}

Bloco de código

language	cpp
theme	Confluence
title	Retorno de usuário sem permissão de acesso

{
  "response": [
    {
      "resultados": [
        {
          "matricula": "0101000001",
          "rubrica": "Z52",
          "status": "E",
          "mensagem": "Usuário sem permissão de acesso na Empresa/Filial.",
          "empresareferencia": "T21",
          "datafalta": ""  
        },
        {
 "filial         "matricula": "D MG 01 ",
  "user0101000001",
          "rubrica": "Z53",
          "status": "ahgoraE",
           "messagemensagem": "Usuário sem permissão de acesso na Empresa/Filial.",
		  "referencia": "1",
          "datafalta": ""  
        }
      ]
    }
  ]
}

Bloco de código

language	cpp
theme	Confluence
title	Retorno de empresa/filial inexistente na base de dados

{
  "empresa  "response": [
    {
      "resultados": [
        {
          "matricula": "Z10101000001",
           "filialrubrica": "D MG 01 ",
  "messageZ52",
          "status": "E",
          "mensagem": "Empresa/Filial não encontradas na base de dados.",
          "referencia": "1",
          "datafalta": ""  
        }
      ]
    }
  ]
}

Bloco de código

language	cpp
theme	Confluence
title	Retorno de usuário sem acesso a filial processadaperíodo do processamento não encontrado ou fechado

{
  "empresaresponse": [
    {
      "T1",
resultados": [
        {
          "filialmatricula": "D MG 02 "0101000001",
          "rubrica": "202",
  "user        "status": "ahgoraE",
    "message      "mensagem": "Usuário sem permissãoPeríodo/Semana não encontrados na base de acesso na filial."
}

Bloco de código

language	cpp
theme	Confluence
title	Retorno de período do processamento não encontrado ou fechado

{
  "periodo": "202403",
  "semana": "01",
  "processo": "02117",
  "roteiro": "FOL",
  "messagedados ou o período está fechado. Necessário verificar o cadastro de períodos!",
          "referencia": "1",
          "datafalta": "20240722" 
        },
        {
          "matricula": "0101000002",
          "rubrica": "203",
          "status": "E",
          "mensagem": "Período/Semana não encontrados na base de dados ou o período está fechado. Necessário verificar o cadastro de períodos!"
		  "referencia": "1",
          "datafalta": ""  
        }
      ]
    }
  ]
}

Bloco de código

language	cpp
theme	Confluence
title	Retorno de limite de lançamentos diários para a mesma verba

{
  "response": [
    {
      "resultados": [
        {
          "matricula": "T2D MG 02 600528",
          "rubrica": "003",
          "status": "S",
          "mensagem": "Operação realizada com sucesso!",
          "referencia": "1,30",
          "datafalta": ""
        },
        {
          "matricula": "T2D MG 02 600528",
          "rubrica": "003",
          "status": "E",
          "mensagem": "Verba ultrapassou o limite de lançamentos diários, verificar o cadastro da verba.",
          "referencia": "1,30",
          "datafalta": "20220102"
        },
        {
          "matricula": "T2D MG 02 600528",
          "rubrica": "003",
          "status": "E",
          "mensagem": "Verba ultrapassou o limite de lançamentos diários, verificar o cadastro da verba.",
          "referencia": "1,30",
          "datafalta": "20220103"
        }
      ]
    }
  ]
}

Card

id	400bas
label	400 - Solicitação inválida
title	Body

Bloco de código

language	cpp
theme	Confluence

{
  "code": 400,
  "message": "Não foi enviado nenhum registro na requisição para ser gravado."
}

04. DEMAIS INFORMAÇÕES

...

Árvore de páginas

Versões comparadas

Versão antiga 8

Nova versão Atual

Chave

04. DEMAIS INFORMAÇÕES