CONTEÚDO

1. Visão Geral
2. Exemplo de utilização
   1. Método listarDeclaracoes
      1. Regras de Negocio do Método
      2. EndPoint

      3. Parâmetros de Entrada do Método

      4. Exemplo

      5. Estrutura de Retorno

   2. Método declaracaoPdf
      1. Regras de Negocio do Método
      2. EndPoint

      3. Parâmetros de Entrada do Método

      4. Exemplo

      5. Estrutura de Retorno

3. Tela Declarações 
   1. Outras Ações / Ações relacionadas
      
4. Tela Declarações 
   1. Principais Campos e Parâmetros
      
5. Tabelas utilizadas

01. VISÃO GERAL

Este documento tem como objetivo demonstrar a utilização da API Declarações para a integração do TOTVS Saúde Planos Linha Protheus com a Mobile Saúde, onde será disponibilizado ao beneficiário as declarações (Carta de Quitação e Declaração anual de Imposto de Renda) contendo relação de eventos (itens) e valores relacionados à declaração selecionada.

A API utilizará o padrão REST.

02. EXEMPLO DE UTILIZAÇÃO

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.

Abaixo serão apresentados exemplos de cada método.

A autenticação é realizada através da Api /token, onde será retornado a chave e token a ser adicionado no header de cada método.

Método listaDeclaracoes

Este método irá retornar todas as declarações (Carta de Quitação e Declaração anual de Imposto de Renda) solicitadas pelo beneficiário. 

Regras de Negocio do Método

A quantidade de anos que o sistema irá listar nas declarações deverá ser informado no campo Qt. Anos Dec (BA0_MSDECL) no cadastro da operadora.

Exemplo: caso seja informado o valor 3, o sistema irá listar as declarações dos últimos 3 anos.

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

Endpoint

Parâmetros de Entrada do Método

Exemplo

{
    "chaveBeneficiarioTipo": "CPF",
    "multiContract": false,
    "chaveBeneficiario": "71461963990",
    "matriculaContrato": "00011008000013019"
}

{
    "status": true,
    "tipoDeclaracoes": [
        {
            "nome": "Imposto de Renda",
            "declaracoes": [
                {
                    "nome": "2021-00011008000013019",
                    "idDeclaracao": "2021:IRPF:00011008000013019",
                    "codigoContrato": "00011008000013"
                },
                {
                    "nome": "2020-00011008000013019",
                    "idDeclaracao": "2020:IRPF:00011008000013019",
                    "codigoContrato": "00011008000013"
                },
                {
                    "nome": "2019-00011008000013019",
                    "idDeclaracao": "2019:IRPF:00011008000013019",
                    "codigoContrato": "00011008000013"
                }
            ]
        },
        {
            "nome": "Carta de Quitação",
            "declaracoes": [
                {
                    "nome": "2021-00011008000013019",
                    "idDeclaracao": "2021:CQ:00011008000013019",
                    "codigoContrato": "00011008000013"
                },
                {
                    "nome": "2020-00011008000013019",
                    "idDeclaracao": "2020:CQ:00011008000013019",
                    "codigoContrato": "00011008000013"
                },
                {
                    "nome": "2019-00011008000013019",
                    "idDeclaracao": "2019:CQ:00011008000013019",
                    "codigoContrato": "00011008000013"
                }
            ]
        }
    ]
}

{
    "status": false,
    "motivoCritica": "Nenhum beneficiário encontrado para os parâmetros informados."
}

Estrutura de Retorno

Método declaracaoPdf

Este método irá retornar uma URL ou um caracter BASE64 contendo o arquivo PDF da declaração.

Regras de Negocio do Método

Esse método irá receber a chave de identificação da declaração que foi retornado no método listaDeclaracoes. A Chave deverá conter o ano, tipo da declaração a ser gerada e a matricula do beneficiário.

Através Modo PDF (BA0_MSPDFM) no cadastro da operadora, será definido o tipo de PDF que será gerado (URL ou base64). Quando utilizado via URL, deverá informar no campo URL PDF (BA0_MSPDFU) o caminho para acessar pela internet.

Endpoint

Parâmetros de Entrada do Método

Exemplo

{
    "idDeclaracao": "2021:IRPF:00011008000013019"
}

{
    "status": true,
    "url": "c:\\protheus12127\\protheus_data\\web\\pp\\imagens-pls\\relatorios\\impostoRenda.pdf",
    "base64": ""
}

{
    "status": false,
    "motivoCritica": "Não foi possível gerar o PDF"
}

Estrutura de Retorno

03. TELA DECLARAÇÕES

Outras Ações / Ações relacionadas

04. TELA DECLARAÇÕES

Principais Campos e Parâmetros do TOTVS Saúde Planos Linha Protheus

05. TABELAS UTILIZADAS

• SE1 - Contas a Receber
• SE5 - Movimentação Bancaria         
• BBT - Títulos Gerados
• BM1 - Composição da Cobrança
• B44 - Autorização Reembolso
• BA0 - Cadastro de Operadoras