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

...

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



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.


   Retorno

Deck of Cards
startHiddenfalse
idretorno
Card
defaulttrue
id200ok
label200 - OK
titleSucesso
Propriedades APIDescrição
codCódigo da Verba - PEVENTO.CODIGO
descDescrição da Verba - PEVENTO.DESCRICAO
cnpjCNPJ da filial Coligada- 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 coligada que foi enviado na requisição e caso tenha algum erro será enviado no array de erros dentro do response.

Bloco de código
languagecppjs
themeConfluence
titleOperação realizada com sucesso!
linenumberstrue
{
  "response": [
    {
      "erros"response": [
        {
          "mensagem": "CNPJ não encontrado na base de dados",
          "cnpj"erros": "1A.23B.45C/678D-90"[
        },
        {
          "mensagem": "CNPJ não encontrado na base de dados",
          "cnpj"mensagem": "1F05.CFB295.57C401/9FG40001-8930",
        },
        {
          "mensagemcnpj": "Não foi possível abrir a empresa: 02 - Verifique se o usuário possuí acesso a filial vinculada ao CNPJ: 49342767000198",Necessário ativar a integração."
          "cnpj": "49.342.767/0001-98"
        },         
        {
        {
  "mensagem": "Não existe cadastro de verbas para o CNPJ",
          "cnpjmensagem": "5307.113363.791764/00120001-8590",
           }
      ],
      "itemscnpj": [
"Coligada não existe."
      {
          "cod": "002",
}
           "desc": "PERICULOSIDADE" ],
          "cnpj": "14.689.130/0001-98",
          "categoriaitems": "Provento - Hora"[
        },
        {
          "cod": "080",
          "desccod": "PERIC. FERIAS AVISO0001",
          "cnpj": "14.689.130/0001-98",
          "categoriadesc": "ProventoHORAS - Hora"
        },
		{
          "cod": "419NORMAIS 2",
          "desc": "Faltas",
          "cnpj": "8207.714577.573599/0001-4170",
          "categoria": "Desconto - Dia"
        },
		{
          "cod"categoria": "759Provento-Hora",
          "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 

Bloco de código
languagecpp
themeConfluence
titleOperação realizada com sucesso!
{
  "responsecod": [
    {
      "erros0002": [],
      "items": [
        {
          "coddesc": "002DIAS TRABALHADOS2",
          "desc": "PERICULOSIDADE",
          "cnpj": "8207.714577.573599/0001-4170",
          "categoria": "Provento - Hora"
        },"categoria": "Provento-Dia"
        {
        },
  "cod": "080",
          "desc": "PERIC. FERIAS AVISO",{
          "cnpj": "82.714.573/0001-41",
          "categoriacod": "Provento - Hora0003",
        },
        ....
		{
          "coddesc": "460INSS2",
          "desc": "HS.  NAO COMPENSADAS",
          "cnpj": "8207.714577.573599/0001-4170",
          "categoria": "Desconto - Hora"
        },
		{
          "cod"categoria": "759Desconto-Valor",
          "desc": "H.E. DIA DSR",
      }
           "cnpj": "82.714.573/0001-41" ],
            "categoriahasNext": "Base de Cálculo - Hora"true
        }
      ],
      "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