1. DADOS GERAIS

Produto:

RM

Linha de Produto:

Linha RM

Segmento:

RH

Módulo:TOTVS Folha de Pagamento 
Função:Integração RM X Ahgora - API de Eventos/Verbas
País:Brasil

Requisito/Story/Issue (informe o requisito relacionado) :

DRHROTRM-13585


02. LIBERAÇÃO

Lembrando que, será a partir dos patches:

03. SITUAÇÃO/REQUISITO

Criação de API para integração dos dados dos eventos/verbas para o Ponto Web da Ahgora.

04. SOLUÇÃO

Visando otimizar a integração entre os sistemas, foi disponibilizada a API ahgora/verbas. Essa API é responsável por enviar automaticamente as informações dos Eventos/Verbas cadastradas na Folha de Pagamento para o Ponto Web da Ahgora, garantindo mais agilidade, padronização e segurança no compartilhamento de informações.


Este método é responsável por enviar uma lista de verbas da tabela GCOLIGADA da linha de produto RM.

Parâmetros de Consulta

Parâmetro

Tipo

Obrigatório

Descrição

pageNuméricoSimNúmero da página a ser consultada (inicia em 1).
pageSizeNuméricoSimQuantidade de registros por página.
cnpjListStringSimCNPJ(s) da(s) Coligada(s) que serão consultadas na base do RM



O sistema da Ahgora não está dentro da sua rede, logo, para funcionar a busca das verbas, seu REST no RM 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 RM no header da requisição.



Propriedades APIDescrição
codCódigo da Verba - PEVENTO.CODIGO
descDescrição da Verba - PEVENTO.DESCRICAO
cnpjCNPJ da filial - GCOLIGADA.CGC
categoriaProvento - Hora ou Dia; Desconto - Hora ou Dia; Base de Cálculo - Hora ou Dia; - PEVENTO.PROVDESCBASE e PEVENTO.VALHORDIAREF


Será retornado uma lista com as verbas referente ao CNPJ da filial que foi enviado na requisição e caso tenha algum erro será enviado no array de erros dentro do response

{
  "response": [
    {
      "erros": [
        {
          "mensagem": "CNPJ não encontrado na base de dados",
          "cnpj": "1A.23B.45C/678D-90"
        },
        {
          "mensagem": "CNPJ não encontrado na base de dados",
          "cnpj": "1F.CFB.57C/9FG4-89"
        },
        {
          "mensagem": "Não foi possível abrir a empresa: 02 - Verifique se o usuário possuí acesso a filial vinculada ao CNPJ: 49342767000198",
          "cnpj": "49.342.767/0001-98"
        },         
        {
          "mensagem": "Não existe cadastro de verbas para o CNPJ",
          "cnpj": "53.113.791/0012-85"
        }
      ],
      "items": [
        {
          "cod": "002",
          "desc": "PERICULOSIDADE",
          "cnpj": "14.689.130/0001-98",
          "categoria": "Provento - Hora"
        },
        {
          "cod": "080",
          "desc": "PERIC. FERIAS AVISO",
          "cnpj": "14.689.130/0001-98",
          "categoria": "Provento - Hora"
        },
		{
          "cod": "419",
          "desc": "Faltas",
          "cnpj": "82.714.573/0001-41",
          "categoria": "Desconto - Dia"
        },
		{
          "cod": "759",
          "desc": "H.E. DIA DSR",
          "cnpj": "82.714.573/0001-41",
          "categoria": "Base de Cálculo - Hora"
        }
      ],
      "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": [
    {
      "erros": [],
      "items": [
        {
          "cod": "002",
          "desc": "PERICULOSIDADE",
          "cnpj": "82.714.573/0001-41",
          "categoria": "Provento - Hora"
        },
        {
          "cod": "080",
          "desc": "PERIC. FERIAS AVISO",
          "cnpj": "82.714.573/0001-41",
          "categoria": "Provento - Hora"
        },
        ....
		{
          "cod": "460",
          "desc": "HS.  NAO COMPENSADAS",
          "cnpj": "82.714.573/0001-41",
          "categoria": "Desconto - Hora"
        },
		{
          "cod": "759",
          "desc": "H.E. DIA DSR",
          "cnpj": "82.714.573/0001-41",
          "categoria": "Base de Cálculo - Hora"
        }
      ],
      "hasNext": true
    }
  ]
}  

Verificar se todos os parâmetros foram passados na requisição

{
  "code": 400,
  "message": "Necessário enviar o page, pageSize e cnpjList na requisição""
}





Colocar mais detalhes semelhante ao TDN do Protheus : DT Integração Ahgora - API Verbas e Sindicatos

05. DEMAIS INFORMAÇÕES