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 - PEVENTO.CODIGO
desc	Descrição da Verba - PEVENTO.DESCRICAO
cnpj	CNPJ da Coligada- GCOLIGADA.CGC
categoria	Provento - 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 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

language	cpp	theme	Confluencejs
title	Operação realizada com sucesso!
linenumbers	true

{
    "response": [
        {
            "erros": [
                {
                    "mensagem": "05.295.401/0001-30",
                    "cnpj": "Necessário ativar a integração."
                },
                {
                    "mensagem": "07.363.764/0001-90",
                    "cnpj": "Coligada não existe."
                }
            ],
            "items": [
                {
                    "cod": "0001",
                    "desc": "HORAS NORMAIS 2",
                    "cnpj": "07.577.599/0001-70",
                    "categoria": "Provento-Hora"
                },
                {
                    "cod": "0002",
                    "desc": "DIAS TRABALHADOS2",
                    "cnpj": "07.577.599/0001-70",
                    "categoria": "Provento-Dia"
                },
                {
                    "cod": "0003",
                    "desc": "INSS2",
                    "cnpj": "07.577.599/0001-70",
                    "categoria": "Desconto-Valor"
                }
            ],
            "hasNext": true
        }
    ]
}

Informações

title	Importante

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

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	cppjs
theme	Confluence
linenumbers	true

{
    "code": "FE016",
    "message": "O campo CnpjList é obrigatório.\r\n",
    "detailedMessage": "",
    "helpUrl": "",
    "details": null
}

...

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 25

Nova versão 26

Chave