Histórico da Página

...

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).
`pageSize`	Numérico	Sim	Quantidade de registros por página.
cnpjList	String	Sim	CNPJ(s) da(s) Coligada(s) que serão consultadas na base do RM

Nota

title	Importante

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

title	Importante

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

Retorno

Será retornado uma lista com

as verbas

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

Deck of Cards

startHidden	false
id	retorno

Card

default	true
id	200ok
label	200 - OK
title	Sucesso

Propriedades API	Descrição
cod	Código

da Verba

do Sindicato -

RV

RCE_

COD

CODIGO
desc	Descrição

da Verba

do Sindicato -

RV

RCE_

DESC

DESCRI
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

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

foi

existe

possível

cadastro

abrir

de

a empresa: 02 - Verifique se o usuário possuí acesso a filial vinculada ao CNPJ: 49342767000198

sindicatos para o CNPJ",
          "cnpj": "

49

53.

342

113.

767

791/

0001

0012-

98

85"
        }
      ],


      "items": [
        {
          "

mensagem

cod": "

Não existe cadastro de verbas para o CNPJ

00",
          "desc": "SIND MEDIAS",
          "cnpj": "53.113.791/

0012

0001-

85

22"
        }

]

"items":

[

{
          "cod": "

002

01",
          "desc": "

PERICULOSIDADE

SIND.EMPRE.INST.BENEF.REL.FILANTROPICOS",
          "cnpj": "14.689.130/0001-98",

"categoria": "Provento - Hora"

},
        {
          "cod": "

080

51",
          "desc": "

PERIC. FERIAS AVISO

SIND INTER EMP INST BEN RELIG FIL EST SP",
          "cnpj": "14.689.130/0001-98",

"categoria": "Provento - Hora"

},

},

{
          "cod": "

419

52",
          "desc": "

Faltas

SIND EMP TURE HOSP PIRACICABA E REGIAO",
          "cnpj": "82.714.573/0001-41",

"categoria": "Desconto - Dia"

},

},

{
          "cod": "

759

53",
          "desc": "

H.E. DIA DSR

SIND EMP ESTAB SERVICOS SAUDE-SAO PAULO",
          "cnpj": "82.714.573/0001-41",
        },
        {

"categoria

        "cod": "01",
          "desc":

"Base de Cálculo - Hora"

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

   "erros": [],

"items": [
        {
          "cod": "

002

00",
          "desc": "

PERICULOSIDADE

SIND MEDIAS",
          "cnpj": "

82

53.

714

113.

573

791/0001-

41

22"

,

"categoria": "Provento - Hora"

},
        {

},

{

"cod": "01",
          "

cod

desc": "

080

SIND.EMPRE.INST.BENEF.REL.FILANTROPICOS",
          "

desc

cnpj": "

PERIC. FERIAS AVISO",

14.689.130/0001-98",
        },
        {
          "

cnpj

cod": "

82.714.573/0001-41

51",
          "

categoria

desc": "

Provento - Hora"

SIND INTER EMP INST BEN RELIG FIL EST SP",

}

  "cnpj": "14.689.130/0001-98",
        },
		....

        {
          "cod": "

460

52",
          "desc": "

HS. NAO COMPENSADAS

SIND EMP TURE HOSP PIRACICABA E REGIAO",
          "cnpj": "82.714.573/0001-41",

"categoria": "Desconto - Hora"

},

},

{
          "cod": "

759

53",
          "desc": "

H.E. DIA DSR

SIND EMP ESTAB SERVICOS SAUDE-SAO PAULO",
          "cnpj": "82.714.573/0001-41",
        },
        {
          "cod": "01",
          "

categoria

desc":

"Base de Cálculo - Hora"

"S001",
          "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ção

Bloco de código

language	cpp
theme	Confluence

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

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 4

Nova versão 5

Chave

Parâmetros de Consulta

05. DEMAIS INFORMAÇÕES

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 4

Nova versão 5

Chave

Parâmetros de Consulta

05. DEMAIS INFORMAÇÕES

Integração RM X Ahgora