Árvore de páginas

Versões comparadas

Chave

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

...

No campo List. Decla. (BA0_MSDECD) no cadastro da operadora, deverá ser informado os tipos de declarações que serão utilizadas na API. 

Se o Login for realizado por CPF, o sistema irá listar as declarações de todos os contratos vinculado aquele CPF.

Se o Login for realizado por matricula, o sistema irá listar somente as declarações daquele contrato.

Endpoint
Âncora
DECLARACAOENDPOINT
DECLARACAOENDPOINT

...

Parâmetro

Obrigatório

Tipo

Descrição

chaveBeneficiarioSimNãoCaracterChave do Beneficiário (CPF ou Matricula)
chaveBeneficiarioTipoSimNãoCaracterTipo de Login do Beneficiário (CPF ou Matricula)
multiContractSimNãoLógicoUtilização de Multi Contratos pelo Beneficiário

...

matriculaContrato

...

SimCaracterMatricula do Beneficiário 

Exemplo
Âncora
DECLARACAOEXEMPLO
DECLARACAOEXEMPLODECLARACAOEXEMPLODECLARACAOEXEMPLO


Bloco de código
languagec#
themeMidnight
titleRequest body
linenumberstrue
collapsetrue
{
    "chaveBeneficiarioTipo": "CPF",
    "multiContract": truefalse,
    "chaveBeneficiario": "71461963990",
    "matriculaContrato": "7646163309000011008000013019"
}
Bloco de código
languagec#
themeMidnight
titleAPI Retorno - Sucesso
linenumberstrue
collapsetrue
{
    "status": true,
    "tipoDeclaracoes": [
        {
            "declaracoes": [
                {
                    "nome": "2021-00010050000002004",
                    "codigoContrato": "00010050000002",
                    "idDeclaracao": "2021:IRPF:00010050000002004"
                },
                {
                    "nome": "2020-00010050000002004",
                    "codigoContrato": "00010050000002",
                    "idDeclaracao": "2020:IRPF:00010050000002004"
                },
                {
                    "nome": "2019-00010050000002004",
                    "codigoContrato": "00010050000002",
                    "idDeclaracao": "2019:IRPF:00010050000002004"
                }
            ],
            "nome": "Imposto de Renda"
        },
        {
            "declaracoes": [
                {
                    "nome": "2021-00010050000002004",
                    "codigoContrato": "00010050000002",
                    "idDeclaracao": "2021:CQ:00010050000002004"
                },
                {
                    "nome": "2020-00010050000002004",
                    "codigoContrato": "00010050000002",
                    "idDeclaracao": "2020:CQ:00010050000002004"
                },
                {
                    "nome": "2019-00010050000002004",
                    "codigoContrato": "00010050000002",
                    "idDeclaracao": "2019:CQ:00010050000002004"
                }
    
    "tipoDeclaracoes": [
        ],{
            "nome": "CartaImposto de Quitação"
        },
        {Renda",
            "declaracoes": [
                {
                    "nome": "2021-0001005000000800200011008000013019",
                    "codigoContratoidDeclaracao": "000100500000082021:IRPF:00011008000013019",
                    "idDeclaracaocodigoContrato": "2021:IRPF:0001005000000800200011008000013"
                },
                {
                    "nome": "2020-0001005000000800200011008000013019",
                    "codigoContratoidDeclaracao": "000100500000082020:IRPF:00011008000013019",
                    "idDeclaracaocodigoContrato": "2020:IRPF:0001005000000800200011008000013"
                },
                {
                    "nome": "2019-0001005000000800200011008000013019",
                    "codigoContratoidDeclaracao": "000100500000082019:IRPF:00011008000013019",
                    "idDeclaracaocodigoContrato": "2019:IRPF:0001005000000800200011008000013"
                }
            ]
        },
         ],{
            "nome": "ImpostoCarta de Renda"
        },
        {Quitação",
            "declaracoes": [
                {
                    "nome": "2021-0001005000000800200011008000013019",
                    "codigoContratoidDeclaracao": "000100500000082021:CQ:00011008000013019",
                    "idDeclaracaocodigoContrato": "2021:CQ:0001005000000800200011008000013"
                },
                {
                    "nome": "2020-0001005000000800200011008000013019",
                    "idDeclaracao"codigoContrato: ": "000100500000082020:CQ:00011008000013019",
                    "idDeclaracaocodigoContrato": "2020:CQ:0001005000000800200011008000013"
                },
                {
                    "nome": "2019-0001005000000800200011008000013019",
                    "codigoContratoidDeclaracao": "000100500000082019:CQ:00011008000013019",
                    "idDeclaracaocodigoContrato": "2019:CQ:0001005000000800200011008000013"
                }
            ],
            "nome": "Carta de Quitação"
        }
    ]
}
Bloco de código
languagec#
themeMidnight
titleRetorno API - Falha
linenumberstrue
collapsetrue
{
    "status": false,
    "motivoCritica": "Nenhum beneficiário encontrado para os parâmetros informados."
}

...