Linha Microsiga Protheus

Árvore de páginas

Carregando...
Tempo aproximado para leitura: superior a 15 minutos


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-16376

DRHCALCPRT-16377


02. SITUAÇÃO/REQUISITO

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

03. SOLUÇÃO

Foram criadas as APIs 'ahgora/verbas' e 'ahgora/sindicatos', responsáveis por enviar as verbas e os sindicatos do Protheus para o Ponto Web da Ahgora.


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

  • Endpoint: api/rh/v1/ahgora/verbas?page=1&pageSize=500
  • Método: GET
  • Autenticação: Basic

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.



Importante

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.

Importante

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:

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


    Retorno

Propriedades API Descrição
cod Código da Verba - RV_COD
desc Descrição da Verba - RV_DESC
cnpj CNPJ da filial - M0_CGC
categoria Provento, 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

Operação realizada com sucesso! 
{
  "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 

Operação realizada com sucesso! 
{
  "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
    }
  ]
}  

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

  • Endpoint: api/rh/v1/ahgora/sindicatos?page=1&pageSize=500
  • Método: GET
  • Autenticação: Basic

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.



Importante

O sistema da Ahgora não está dentro da sua rede, logo, para funcionar a busca dos sindicatos, 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.

Importante

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:

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


    Retorno

Propriedades API Descrição
cod Código do Sindicato - RCE_CODIGO
desc Descrição do Sindicato - RCE_DESCRI
cnpj CNPJ da filial - M0_CGC


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

Operação realizada com sucesso! 
{
  "response": [
    {
      "items": [
        {
          "cod": "00",
          "desc": "SIND MEDIAS",
          "cnpj": "53.113.791/0001-22"
        },
        {
          "cod": "01",
          "desc": "SIND.EMPRE.INST.BENEF.REL.FILANTROPICOS",
          "cnpj": "14.689.130/0001-98",
        },
        {
          "cod": "51",
          "desc": "SIND INTER EMP INST BEN RELIG FIL EST SP",
          "cnpj": "14.689.130/0001-98",
        },
        {
          "cod": "52",
          "desc": "SIND EMP TURE HOSP PIRACICABA E REGIAO",
          "cnpj": "82.714.573/0001-41",
        },
        {
          "cod": "53",
          "desc": "SIND EMP ESTAB SERVICOS SAUDE-SAO PAULO",
          "cnpj": "82.714.573/0001-41",
        },
        {
          "cod": "01",
          "desc": "S001",
          "cnpj": "82.714.573/0001-41",
        }
      ],
      "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 

Operação realizada com sucesso! 
{
  "response": [
    {
      "items": [
        {
          "cod": "00",
          "desc": "SIND MEDIAS",
          "cnpj": "53.113.791/0001-22"
        },
        {
          "cod": "01",
          "desc": "SIND.EMPRE.INST.BENEF.REL.FILANTROPICOS",
          "cnpj": "14.689.130/0001-98",
        },
        {
          "cod": "51",
          "desc": "SIND INTER EMP INST BEN RELIG FIL EST SP",
          "cnpj": "14.689.130/0001-98",
        },
		....
        {
          "cod": "52",
          "desc": "SIND EMP TURE HOSP PIRACICABA E REGIAO",
          "cnpj": "82.714.573/0001-41",
        },
        {
          "cod": "53",
          "desc": "SIND EMP ESTAB SERVICOS SAUDE-SAO PAULO",
          "cnpj": "82.714.573/0001-41",
        },
        {
          "cod": "01",
          "desc": "S001",
          "cnpj": "82.714.573/0001-41",
        }
      ],
      "hasNext": true
    }
  ]
}

       

04. DEMAIS INFORMAÇÕES

Não se aplica

05. ASSUNTOS RELACIONADOS

        Configuração REST