Histórico da Página
...
Este documento tem como objetivo demontrar demonstrar a utilização da API Declarações para utilizar na 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.
...
02. EXEMPLO DE UTILIZAÇÃO
Lista de Segue os métodos utilizados na API:
- declaracoes: Retorna uma lista de declarações do beneficiário.
- pdfDeclaracao: 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 dos métodos listados abaixo é realizado realizada através da Api /token, onde será retornado a chave e token a ser adicionado no header de cada método.
Método declaracoes
Este método irá retornar a lista com todas as solicitações de autorização do declarações (Carta de Quitação e Declaração anual de Imposto de Renda) solicitadas pelo beneficiário. Será retornado somente o cabeçalho da autorização.
Regras de Negocio do Método
A quantidade de anos que o sistema irá listar nas declarações deverá ser informado no campo BA0_MSDECL no no cadastro da operadora.
Exemplo: caso seja informado o valor 3, o sistema irá listar as declarações dos últimos 3 anos.
Através do No campo BA0_MSDECD no no cadastro da operadora, deverá ser preenchido as informado os tipos de declarações que serão utilizadas na API. Para imposto de renda, o valor IRPF, para carta de quitação o valor CQ. para adicionar as duas declarações deverá preencher o valor: IRPF,CQ (Obrigatório utilizar a virgula para separar as declarações).
Se o Login for Login 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.
...
| Atributo | Tipo | Descrição |
|---|---|---|
| status | Lógico | True: Indica que a requisição foi bem-sucedida False: Indica que a requisição foi mal sucedida |
| motivoCritica | Caracter | Motivo pelo qual não foi possível realizar a requisição, quando o status for igual a False |
| tipoDeclaracao | Array | Lista de objetos de “tipoDeclaracao“ |
| nome (Objeto tipoDeclaracao) | Caracter | Nome que identifica a lista de declaração |
| declaracoes | Array | Lista de objetos de “declaracoes“ |
| nome (Objeto declaracoes) | Caracter | Nome que identifica a declaração (Ano + Matricula do Beneficiário) |
| idDeclaracao | Caracter | Chave de identificação da declaração no sistema (Ano + Declaração + Matricula) |
| codigoContrato | Caracter | Código do Contrato do Beneficiário (Operadora + Empresa + Matricula) |
Método PdfDeclaracao
Este método irá retornar uma URL ou um caracter BASE64 contendo o arquivo PDF da declaração.
...
| title | Em Construção |
|---|
...
| Matricula) |
Método PdfDeclaracao
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 declaracoes. A Chave deverá conter o ano, tipo da declaração a ser gerada , e a matricula do beneficiário.
Através da configuração da Mobile Saúde BA0_MSPDFM no cadastro da operadora, pelo campo BA0_MSPDFM, será definido o tipo de PDF que será gerado (URL ou base64). Quando utilizado via URL, deverá informar no campo BA0_MSPDFU o caminho para acessar pela internet.
...
Principais Campos e Parâmetros do TOTVS Saúde Planos Linha Protheus
| Campo | Descrição |
|---|---|
| BA0_MSTLOG | Informar o tipo de acesso de login na API da mobile saúde |
| BA0_MSMULT | Indica se o acesso a Mobile Saúde é Multi Contrato |
| BA0_MSPDFM | Informe se o download dos PDF´s das API´s Mobile Saúde será via download através de um URL HTTP ou o arquivo será transmitido via Base 64 no JSON de resposta. |
| BA0_MSPDFU | Informe a URL HTTP para download dos arquivos PDF´s na integração com a Mobile Saúde quando selecionado a opção via URL. |
| BA0_MSDECL | Indica a quantidade de anos que o sistema irá listar nas declarações. Exemplo: caso seja informado o valor 3, o sistema irá listar as declarações dos últimos 3 anos. |
| BA0_MSDECD | Indica as declarações que serão utilizadas na API. Imposto de renda: IRPF, carta de quitação: CQ, ambos: IRPF,CQ (Obrigatório utilizar a virgula para separar as declarações). |
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas