01. DADOS GERAIS

Produto:

TOTVS RH

Linha de Produto:

Linha Protheus 

Segmento:

RH 

Módulo:GESTÃO DE PESSOAS (SIGAGPE)
Função:rh.sigagpe.ahgora.tlpp
Ticket:
Requisito/Story/Issue (informe o requisito relacionado) :DRHCALCPRT-16377


02. SITUAÇÃO/REQUISITO

Criação de API para integração das verbas para o Ponto Web da Ahgora.

03. SOLUÇÃO

Foi criado a API 'ahgora/verbas', para enviar as verbas do Protheus para o Ponto Web da Ahgora.


        Este método é responsável por enviar uma lista de verbas da tabela SRV do Protheus.

Parâmetros de Consulta

ParâmetroTipoObrigatórioDescrição
pageNuméricoSimNúmero da página a ser consultada (inicia em 1).
pageSizeNuméricoSimQuantidade de registros por página.



O sistema da Ahgora não está dentro da sua rede, logo, para funcionar a busca das verbas, seu REST no protheus deve permitir esse acesso externo.

Configurações de porta no firewall, IP público, DNS e redirecionamento de portas devem ser verificadas junto com o seu time de TI/Redes.

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

Enviar os CNPJs no body da requisição conforme estrutura abaixo:

{
  "items": [
    "1A.23B.45C/678D-90",
    "14.689.130/0001-98",
    "82.714.573/0001-41",
    "73.612.881/0001-75"
  ]
}


    Retorno

Propriedades APIDescrição
codCódigo da Verba - RV_COD
descDescrição da Verba - RV_DESC
cnpjCNPJ da filial - MO_CGC
categoriaProvento, Desconto ou Base de Cálculo - RV_TIPOCOD


Será retornado uma lista com as verbas referente ao CNPJ da filial que foi enviado na requisição

{
  "response": [
    {
      "items": [
        {
          "cod": "002",
          "desc": "PERICULOSIDADE",
          "cnpj": "14.689.130/0001-98",
          "categoria": "Provento"
        },
        {
          "cod": "080",
          "desc": "PERIC. FERIAS AVISO",
          "cnpj": "14.689.130/0001-98",
          "categoria": "Provento"
        },
		{
          "cod": "460",
          "desc": "HS.  NAO COMPENSADAS",
          "cnpj": "82.714.573/0001-41",
          "categoria": "Desconto"
        },
		{
          "cod": "759",
          "desc": "H.E. DIA DSR",
          "cnpj": "82.714.573/0001-41",
          "categoria": "Base de Cálculo"
        }
      ],
      "hasNext": false
    }
  ]
}


Caso ultrapasse a paginação que é 500 items por página, será enviado o hasNext com true, para prosseguir com a requisição 

{
  "response": [
    {
      "items": [
        {
          "cod": "002",
          "desc": "PERICULOSIDADE",
          "cnpj": "82.714.573/0001-41",
          "categoria": "Provento"
        },
        {
          "cod": "080",
          "desc": "PERIC. FERIAS AVISO",
          "cnpj": "82.714.573/0001-41",
          "categoria": "Provento"
        },
        ....
		{
          "cod": "460",
          "desc": "HS.  NAO COMPENSADAS",
          "cnpj": "82.714.573/0001-41",
          "categoria": "Desconto"
        },
		{
          "cod": "759",
          "desc": "H.E. DIA DSR",
          "cnpj": "82.714.573/0001-41",
          "categoria": "Base de Cálculo"
        }
      ],
      "hasNext": true
    }
  ]
}  

Necessário enviar o body com os CNPJ na requisição

{
  "code": 400,
  "message": "Não foi enviado nenhum CNPJ na requisição para busca das verbas"
}


Verificar se os CNPJS enviados são os mesmo que constam cadastrados nas filiais dentro do SIGAMAT no Protheus

{
  "code": 400,
  "message": "Nenhum CNPJ foi encontrado na base de dados"
}


Verificar se o usuário da requisição possuí acesso a empresa e filial vinculada ao CNPJ que foi passado

{
  "code": 400,
  "message": "Não foi possível abrir a empresa: 02 - Verifique se o usuário possuí acesso a empresa vinculada ao CNPJ: 73612881000175"
}



04. DEMAIS INFORMAÇÕES

Não se aplica

05. ASSUNTOS RELACIONADOS

        Configuração REST