Histórico da Página

...

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

Será retornado uma lista com as verbas 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": [
    {
      "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

Bloco de código

language	cpp
theme	Confluence
title	Verba não encontrada na base de dadosOperaçã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
    }
  ]
}

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

...

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão 3

Chave