...
- Visão Geral
- Exemplo de utilização
- Método declaracoes
- Regras de Negocio do Método
- EndPoint
Parâmetros de Entrada do Método
Exemplo
Estrutura de Retorno
- Método pdfDeclaracao
- Regras de Negocio do Método
- EndPoint
Parâmetros de Entrada do Método
Exemplo
Estrutura de Retorno
- Tela Declarações
- Outras Ações / Ações relacionadas
- Tela Declarações
- Principais Campos e Parâmetros
- Tabelas utilizadas
...
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 declaracoes
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| Âncora |
|---|
| DECLARACAOREGRA |
|---|
| DECLARACAOREGRA |
|---|
|
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.
...
Se o Login for realizado por matricula, o sistema irá listar somente as declarações daquele contrato.
Endpoint
Url | Método | Header Content-Type | Descrição |
|---|
| https://<url>:<porta>/rest/mobileSaude/v1/declaracoes | POST | application/json | Retorna uma lista de declarações |
Parâmetros de Entrada do Método
Parâmetro | Obrigatório | Tipo | Descrição |
|---|
| chaveBeneficiario | Sim | Caracter | Chave do Beneficiário (CPF ou Matricula) |
| chaveBeneficiarioTipo | Sim | Caracter | Tipo de Login do Beneficiário (CPF ou Matricula) |
| multiContract | Sim | Lógico | Utilização de Multi Contratos pelo Beneficiário |
Exemplo
| Bloco de código |
|---|
| language | c# |
|---|
| theme | Midnight |
|---|
| title | Request body |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"chaveBeneficiarioTipo": "CPF",
"multiContract": true,
"chaveBeneficiario": "76461633090"
} |
...
| Bloco de código |
|---|
| language | c# |
|---|
| theme | Midnight |
|---|
| title | Retorno API - Falha |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"status": false,
"motivoCritica": "Nenhum beneficiário encontrado para os parâmetros informados."
} |
Estrutura de Retorno
| 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.
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 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
| Url | Método | Header Content-Type | Descrição |
|---|
| https://<url>:<porta>/rest/mobileSaude/v1/pdfDeclaracao | POST | application/json | Retorna a declaração em PDF |
Parâmetros de Entrada do Método
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|
| idDeclaracao | Sim | Caracter | Chave de identificação da declaração no sistema (Ano + Declaração + Matricula) |
Exemplo
| Bloco de código |
|---|
| language | c# |
|---|
| theme | Midnight |
|---|
| title | Request body |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"idDeclaracao": "2020:CQ:00010050000008002"
} |
...
| Bloco de código |
|---|
| language | c# |
|---|
| theme | Midnight |
|---|
| title | Retorno API - Falha |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"status": false,
"motivoCritica": "Não foi possível gerar o PDF"
} |
Estrutura de Retorno
| 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 |
| base64 | Caracter em base64 | Conteúdo binário do tipo base64, do arquivo PDF da declaração. |
| url | Caracter | URL completo do arquivo PDF informado no cadastro da Operadora |
...
Veja um exemplo de como a comunicação com a API é feita na prática:
03. TELA DECLARAÇÕES
Outras Ações / Ações relacionadas
| Ação | Descrição |
|---|
| Não se aplica | Não se aplica |
04. TELA DECLARAÇÕES
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, carta de quitação ou ambas. |
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
...
