Árvore de páginas

Versões comparadas

Chave

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

...

Segue os métodos utilizados na API:

  • listaDeclaracoes: Retorna uma lista de declarações do beneficiário.
  • declaracaoPdf: Retorna uma URL ou um caracter BASE64 contendo o arquivo PDF da declaração.

...

Bloco de código
languagec#
themeMidnight
titleAPI Retorno - Sucesso
linenumberstrue
collapsetrue
{
    "status": true,
    "tiposDeclaracoestipoDeclaracoes": [
        {
            "declaracoes": [
                {
                    "nomeDeclaracaonome": "2021-00010050000002004",
                    "codigoContrato": "00010050000002",
                    "idDeclaracao": "2021:IRPF:00010050000002004"
                },
                {
                    "nomeDeclaracaonome": "2020-00010050000002004",
                    "codigoContrato": "00010050000002",
                    "idDeclaracao": "2020:IRPF:00010050000002004"
                },
                {
                    "nomeDeclaracaonome": "2019-00010050000002004",
                    "codigoContrato": "00010050000002",
                    "idDeclaracao": "2019:IRPF:00010050000002004"
                }
            ],
            "nome": "Imposto de Renda"
        },
        {
            "declaracoes": [
                {
                    "nomeDeclaracaonome": "2021-00010050000002004",
                    "codigoContrato": "00010050000002",
                    "idDeclaracao": "2021:CQ:00010050000002004"
                },
                {
                    "nomeDeclaracaonome": "2020-00010050000002004",
                    "codigoContrato": "00010050000002",
                    "idDeclaracao": "2020:CQ:00010050000002004"
                },
                {
                    "nomeDeclaracaonome": "2019-00010050000002004",
                    "codigoContrato": "00010050000002",
                    "idDeclaracao": "2019:CQ:00010050000002004"
                }
            ],
            "nome": "Carta de Quitação"
        },
        {
            "declaracoes": [
                {
                    "nomeDeclaracaonome": "2021-00010050000008002",
                    "codigoContrato": "00010050000008",
                    "idDeclaracao": "2021:IRPF:00010050000008002"
                },
                {
                    "nomeDeclaracaonome": "2020-00010050000008002",
                    "codigoContrato": "00010050000008",
                    "idDeclaracao": "2020:IRPF:00010050000008002"
                },
                {
                    "nomeDeclaracaonome": "2019-00010050000008002",
                    "codigoContrato": "00010050000008",
                    "idDeclaracao": "2019:IRPF:00010050000008002"
                }
            ],
            "nome": "Imposto de Renda"
        },
        {
            "declaracoes": [
                {
                    "nomeDeclaracaonome": "2021-00010050000008002",
                    "codigoContrato": "00010050000008",
                    "idDeclaracao": "2021:CQ:00010050000008002"
                },
                {
                    "nomeDeclaracaonome": "2020-00010050000008002",
                    "codigoContrato": "00010050000008",
                    "idDeclaracao": "2020:CQ:00010050000008002"
                },
                {
                    "nomeDeclaracaonome": "2019-00010050000008002",
                    "codigoContrato": "00010050000008",
                    "idDeclaracao": "2019:CQ:00010050000008002"
                }
            ],
            "nome": "Carta de Quitação"
        }
    ]
}

...

AtributoTipoDescrição
statusLógico

True: Indica que a requisição foi bem-sucedida

False: Indica que a requisição foi mal sucedida

motivoCriticaCaracterMotivo pelo qual não foi possível realizar a requisição, quando o status for igual a False
tipoDeclaracaotipoDeclaracoesArrayLista de objetos de “tipoDeclaracao
nome (Objeto tipoDeclaracaotipoDeclaracoes)CaracterNome que identifica a lista de declaração
declaracoesArrayLista de objetos de “declaracoes
nome (Objeto declaracoes)CaracterNome que identifica a declaração (Ano + Matricula do Beneficiário)
idDeclaracaoCaracterChave de identificação da declaração no sistema (Ano + Declaração + Matricula)
codigoContratoCaracterCódigo do Contrato do Beneficiário (Operadora + Empresa + Matricula)

...