Histórico da Página

...

Produto:

TOTVS RH

Solucoes_totvs

Solucao

Solucoes_totvs_cross

SolucaoCross

Solucoes_totvs_parceiros

SolucaoParceiros

Solucoes_totvs_parceirosexptotvs

SolucaoParcsExpsTOTVS

Linha de Produto:

Linha Protheus

Linhas_totvs

Segmento:

RH

Segmentos_totvs

Segmento

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

DRHCALCPRT-16632

02. SITUAÇÃO/REQUISITO

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

...

Totvs custom tabs box

tabs	1.API Verbas,2.API Sindicatos
ids	verbas,sindicatos

Totvs custom tabs box items

default	yes
referencia	verbas

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&cnpjList=1A23B45C678D90,14689130000198,82714573000141,73612881000175
Método: GET
Autenticação: Basic

Parâmetros de Consulta

Parâmetro	Tipo	Obrigatório	Descrição
`page`	Numérico	Sim	Número da página a ser consultada (inicia em 1).
`pageSize`	Numérico	Sim	Quantidade de registros por página.
cnpjList	String	Sim	CNPJs das filiais que serão consultadas na base do Protheus

Nota

title	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.

Informações

title	Importante

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

Retorno

body2 Body da requisição

Deck of Cards

startHidden	false
id	retorno

Card

id
default	true

label
200ok

title
200 - OK

Body da requisição

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

Bloco de código

language	cpp
theme	Confluence
title	Body

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

Retorno

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

Sucesso

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 - Hora ou Dia; Desconto - Hora ou Dia; Base de Cálculo - Hora ou Dia; - RV_TIPOCOD + RV_TIPO

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

Bloco de código

language	cpp
theme	Confluence
title	Operação realizada com sucesso!

{
  "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",

Deck of Cards

startHidden	false
id	retorno

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

Card

default	true
id	200ok
label	200 - OK
title	Sucesso

Propriedades API

Descrição

cod

Código da Verba - RV_COD

desc

Descrição da Verba - RV_DESC

cnpj

CNPJ da filial - MO_CGC

categoria

Provento, Desconto ou Base de Cálculo - RV_TIPOCOD

Bloco de código

language	cpp
theme	Confluence
title	Operação realizada com sucesso!

{
  "response": [
    {
      "itemscnpj": [
"1F.CFB.57C/9FG4-89"
        },
        {
          "codmensagem": "002",
          "desc": "PERICULOSIDADENão foi possível abrir a empresa: 02 - Verifique se o usuário possuí acesso a filial vinculada ao CNPJ: 49342767000198",
          "cnpj": "1449.689342.130767/0001-98",
        },       "categoria": "Provento"  
        },{
        {
  "mensagem": "Não existe cadastro de verbas para  "cod": "080o CNPJ",
          "desccnpj": "PERIC. FERIAS AVISO",53.113.791/0012-85"
          "cnpj": "14.689.130/0001-98",}
      ],
       "categoriaitems": "Provento"[
        },
		{
          "cod": "460002",
          "desc": "HS.  NAO COMPENSADASPERICULOSIDADE",
          "cnpj": "8214.714689.573130/0001-4198",
          "categoria": "DescontoProvento - Hora"
        },
		        {
          "cod": "759080",
          "desc": "H.EPERIC. DIAFERIAS DSRAVISO",
          "cnpj": "8214.714689.573130/0001-4198",
          "categoria": "BaseProvento de- CálculoHora"
        },
		{
           ]"cod": "419",
          "hasNextdesc": false"Faltas",
     }
  ]
}

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

Bloco de código

language	cpp
theme	Confluence
title	Operação realizada com sucesso!

{
     "responsecnpj": ["82.714.573/0001-41",
    {
       "itemscategoria": [ "Desconto - Dia"
        },
		{
          "cod": "002759",
          "desc": "PERICULOSIDADEH.E. DIA DSR",
          "cnpj": "82.714.573/0001-41",
          "categoria": "ProventoBase de Cálculo - Hora"
        },
        {
    ],
      "codhasNext": "080",false
    }
  ]
}

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

Bloco de código

language	cpp
theme	Confluence
title	Operação realizada com sucesso!

{
  "response": [      "desc": "PERIC. FERIAS AVISO",
    {
       "cnpjerros": "82.714.573/0001-41"[],
          "categoriaitems": "Provento"
        },[
        ....
		{
          "cod": "460002",
          "desc": "HS.  NAO COMPENSADASPERICULOSIDADE",
          "cnpj": "82.714.573/0001-41",
          "categoria": "DescontoProvento - Hora"
        },
		{
        {
          "cod": "759080",
          "desc": "H.EPERIC. DIAFERIAS DSRAVISO",
          "cnpj": "82.714.573/0001-41",
          "categoria": "BaseProvento de- CálculoHora"
        },
        ],
....
		{
          "hasNextcod": true
"460",
      }
  ]
}

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

Bloco de código

language	cpp
theme	Confluence

{
  "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

Bloco de código

language	cpp
theme	Confluence

{
  "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"
}

Totvs custom tabs box items

default	no
referencia	sindicatos

 "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
    }
  ]
}

Card

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

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

Bloco de código

language	cpp
theme	Confluence

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

Totvs custom tabs box items

default	no
referencia	sindicatos

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&cnpjList=1A23B45C678D90,14689130000198,82714573000141,73612881000175
Método: GET
Autenticação: Basic

Parâmetros de Consulta

Parâmetro	Tipo	Obrigatório	Descrição
`page`	Numérico	Sim	Número da página a ser consultada (inicia em 1).
`pageSize`	Numérico	Sim	Quantidade de registros por página.
cnpjList	String	Sim	CNPJs das filiais que serão consultadas na base do Protheus

Nota

title	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.

Informações

title	Importante

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

Retorno

Deck of Cards

startHidden	false
id	retorno

Card

default	true
id	200ok
label	200 - OK
title	Sucesso

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

Bloco de código

language	cpp
theme	Confluence
title	Operação realizada com sucesso!

{
  "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 existe cadastro de sindicatos para o CNPJ",
          "cnpj": "53.113.791/0012-85"
        }
      ],

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âmetro	Tipo	Obrigatório	Descrição
`page`	Numérico	Sim	Número da página a ser consultada (inicia em 1).
`pageSize`	Numérico	Sim	Quantidade de registros por página.

Nota

title	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.

Informações

title	Importante

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

Card

id	body2
label	Body da requisição
title	Body da requisição

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

Bloco de código

language	cpp
theme	Confluence
title	Body

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

Retorno

Deck of Cards

startHidden	false
id	retorno

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

Card

default	true
id	200ok
label	200 - OK
title	Sucesso

Propriedades API

Descrição

cod

Código do Sindicato - RCE_CODIGO

desc

Descrição do Sindicato - RCE_DESCRI

cnpj

CNPJ da filial - MO_CGC

Bloco de código

language	cpp
theme	Confluence
title	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

Bloco de código

language	cpp
theme	Confluence
title	Operação realizada com sucesso!

{
{
  "response": [
    {
      "items": [
        {
          "codresponse": "00",[
    {
         "descerros": "SIND MEDIAS"[],
             "cnpjitems": "53.113.791/0001-22"
        },[
        {
          "cod": "0100",
          "desc": "SIND.EMPRE.INST.BENEF.REL.FILANTROPICOS MEDIAS",
          "cnpj": "1453.689113.130791/0001-9822",
        },
        {
          "cod": "5101",
          "desc": "SIND INTER EMP INST BEN RELIG FIL EST SP.EMPRE.INST.BENEF.REL.FILANTROPICOS",
          "cnpj": "14.689.130/0001-98",
        },
		....
        {
          "cod": "5251",
          "desc": "SIND INTER EMP INST TUREBEN HOSPRELIG PIRACICABAFIL EEST REGIAOSP",
          "cnpj": "8214.714689.573130/0001-4198",
        },
		....
        {
          "cod": "5352",
          "desc": "SIND EMP TURE ESTABHOSP SERVICOSPIRACICABA SAUDE-SAOE PAULOREGIAO",
          "cnpj": "82.714.573/0001-41",
        },
        {
          "cod": "0153",
          "desc": "S001SIND EMP ESTAB SERVICOS SAUDE-SAO PAULO",
          "cnpj": "82.714.573/0001-41",
        },
        }{
      ],
      "hasNextcod": true
  "01",
  }
  ]
}

Card

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

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

Bloco de código

language	cpp
theme	Confluence

{
  "code": 400,
      "messagedesc": "S001"Não,
  foi enviado nenhum CNPJ na requisição para busca dos sindicatos"
}

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

Bloco de código

language	cpp
theme	Confluence

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

"cnpj": "82.714.573/0001-41",
        }
      ],
      "hasNext": true
    }
  ]
}

Card

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

Verificar se todos os parâmetros foram passados na requisiçãoVerificar se o usuário da requisição possuí acesso a empresa e filial vinculada ao CNPJ que foi passado

Bloco de código

language	cpp
theme	Confluence

{
  "code": 400,
  "message": "Não foi possível abrir a empresa: 02 - Verifique seNecessário enviar o usuáriopage, possuípageSize acessoe acnpjList empresa vinculada ao CNPJ: 73612881000175na requisição""
}

04. DEMAIS INFORMAÇÕES

...

Árvore de páginas

Versões comparadas

Versão antiga 9

Nova versão Atual

Chave

02. SITUAÇÃO/REQUISITO

Parâmetros de Consulta

Parâmetros de Consulta

Parâmetros de Consulta

04. DEMAIS INFORMAÇÕES