Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Lembrando que, será a partir dos patches:

  • 12.1.2410.xxx
  • 12.1.2502.xxx
  • 12.1.2506 e superiores

03. SITUAÇÃO/REQUISITO

...

  • Endpoint: api/rh/v1/ahgora/sindicatos?page=1&pageSize=500&cnpjList='CNPJ da COLIGADA'
  • 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).

pageSizeNuméricoSimQuantidade de registros por página.
cnpjListStringSimCNPJ(s) da(s) Coligada(s) que serão consultadas na base do RM



Nota
titleImportante:

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.

Informações
titleImportanteAtenção:

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

...

Deck of Cards
startHiddenfalse
idretorno


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

Card
defaulttrue
id200ok
label200 - OK
titleSucesso
Propriedades APIDescrição
codCódigo
da Verba - RV_COD
do Sindicato - PSINDIC.CODIGO
descDescrição
da Verba - RV_DESC
do Sindicato - PSINDIC.NOME
cnpjCNPJ da
filial
Coligada-
M0_
GCOLIGADA.CGC
categoria
Provento - Hora ou Dia; Desconto - Hora ou Dia; Base de Cálculo - Hora ou Dia; - RV_TIPOCOD + RV_TIPO
Bloco de código
languagecppjs
themeConfluence
titleOperação realizada com sucesso!
linenumberstrue
{
  "response": [
    {
      "errosresponse": [
        {
          "mensagem": "CNPJ não encontrado na base de dados",
          "cnpj": "1A.23B.45C/678D-90""erros": [
        },
        {
          "mensagem": "CNPJ não encontrado na base de dados",
          "cnpjmensagem": "1F05.CFB295.57C401/9FG40001-8930",
        },
        {
          "mensagemcnpj": "NãoNecessário foi possívelativar abrir a empresa: 02 - Verifique se o usuário possuí acesso a filial vinculada ao CNPJ: 49342767000198",a integração."
          "cnpj": "49.342.767/0001-98"
        },         
        {
        {
  "mensagem": "Não existe cadastro de verbas para o CNPJ",
          "cnpjmensagem": "5307.113363.791764/00120001-85"
        }
      ],
      "items": [
        {90",
          "cod": "002",
          "desccnpj": "PERICULOSIDADE",
Coligada          "cnpj": "14.689.130/0001-98",
     não existe."
     "categoria": "Provento - Hora"
        },
        {
          "cod": "080",
       ],
   "desc": "PERIC. FERIAS AVISO",
          "cnpjitems": "14.689.130/0001-98",
   [
       "categoria": "Provento - Hora"
        },
		{
          "cod": "419",
          "desc": "Faltas",
          "cnpj""cod": "82.714.573/0001-41",
          "categoria": "Desconto - Dia"
        },
		{
          "coddesc": "759SINDADOS",
          "desc": "H.E. DIA DSR",
          "cnpj": "8207.714577.573599/0001-4170",
           "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 

Bloco de código
languagecpp
themeConfluence
titleOperação realizada com sucesso!
{
  "response": [
    {
      "erroscod": []"0002",
      "items": [
        {
          "coddesc": "002SINDICATO COMERCIO",
          "desc": "PERICULOSIDADE",
          "cnpj": "8207.714577.573599/0001-4170",
          "categoria": "Provento - Hora"
        },
        {
          "cod": "080",{
          "desc": "PERIC. FERIAS AVISO",
          "cnpjcod": "82.714.573/0001-41",
          "categoria": "Provento - Hora"0003",
        },
        ....
		{
          "cod"desc": "460",
SINDICATO DOS ADMINISTRADORES DE EMPRESA",
      "desc": "HS.  NAO COMPENSADAS",
          "cnpj": "8207.714577.573599/0001-4170",
          "categoria": "Desconto - Hora"
        },
		{
          "cod": "759",
          "desc": "H.E. DIA DSR"],
          "cnpj": "82.714.573/0001-41",
          "categoriahasNext": "Base de Cálculo - Hora"false
        }
      ],
      "hasNext": true
    }
  ]
}   
}



Informações
titleImportante:

Caso o número de itens ultrapasse o limite da página, o campo hasNext será retornado como true, indicando que há mais dados a serem requisitados.
O recomendável é solicitar 500 itens por página.

Card
id400bas
label400 - Solicitação inválida
titleBody

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

Bloco de código
languagecppjs
themeConfluence
linenumberstrue
{
    "code": 400"FE016",
    "message": "Necessário enviar o page, pageSize e cnpjList na requisição""O campo CnpjList é obrigatório.\r\n",
    "detailedMessage": "",
    "helpUrl": "",
    "details": null
}

05. DEMAIS INFORMAÇÕES

Integração RM X Ahgora