Este documento tem como objetivo orientar a utilização da API Declarações para utilizar na 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 itens e valores relacionados à declaração selecionada.
A API utilizará o padrão REST.
Lista de métodos utilizados na API:
A autenticação dos métodos listados abaixo é realizado através da Api /token, onde será retornado a chave e token a ser adicionado no header de cada método.
Este método irá retornar a lista com todas as solicitações de autorização do beneficiário. Será retornado somente o cabeçalho da autorização.
A quantidade de anos que o sistema irá listar nas declarações deverá ser informado no campo BA0_MSDECL 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 campo BA0_MSDECD no cadastro da operadora, deverá ser preenchido as 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).
Login realizado por CPF, o sistema irá listar as declarações de todos os contratos vinculado aquele CPF.
Login realizado por matricula, o sistema irá listar somente as declarações daquele contrato.
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â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 |
{
"chaveBeneficiarioTipo": "CPF",
"multiContract": true,
"chaveBeneficiario": "76461633090"
} |
{
"status": true,
"tiposDeclaracoes": [
{
"declaracoes": [
{
"nomeDeclaracao": "2021-00010050000002004",
"codigoContrato": "00010050000002",
"idDeclaracao": "2021:IRPF:00010050000002004"
},
{
"nomeDeclaracao": "2020-00010050000002004",
"codigoContrato": "00010050000002",
"idDeclaracao": "2020:IRPF:00010050000002004"
},
{
"nomeDeclaracao": "2019-00010050000002004",
"codigoContrato": "00010050000002",
"idDeclaracao": "2019:IRPF:00010050000002004"
}
],
"nome": "Imposto de Renda"
},
{
"declaracoes": [
{
"nomeDeclaracao": "2021-00010050000002004",
"codigoContrato": "00010050000002",
"idDeclaracao": "2021:CQ:00010050000002004"
},
{
"nomeDeclaracao": "2020-00010050000002004",
"codigoContrato": "00010050000002",
"idDeclaracao": "2020:CQ:00010050000002004"
},
{
"nomeDeclaracao": "2019-00010050000002004",
"codigoContrato": "00010050000002",
"idDeclaracao": "2019:CQ:00010050000002004"
}
],
"nome": "Carta de Quitação"
},
{
"declaracoes": [
{
"nomeDeclaracao": "2021-00010050000008002",
"codigoContrato": "00010050000008",
"idDeclaracao": "2021:IRPF:00010050000008002"
},
{
"nomeDeclaracao": "2020-00010050000008002",
"codigoContrato": "00010050000008",
"idDeclaracao": "2020:IRPF:00010050000008002"
},
{
"nomeDeclaracao": "2019-00010050000008002",
"codigoContrato": "00010050000008",
"idDeclaracao": "2019:IRPF:00010050000008002"
}
],
"nome": "Imposto de Renda"
},
{
"declaracoes": [
{
"nomeDeclaracao": "2021-00010050000008002",
"codigoContrato": "00010050000008",
"idDeclaracao": "2021:CQ:00010050000008002"
},
{
"nomeDeclaracao": "2020-00010050000008002",
"codigoContrato": "00010050000008",
"idDeclaracao": "2020:CQ:00010050000008002"
},
{
"nomeDeclaracao": "2019-00010050000008002",
"codigoContrato": "00010050000008",
"idDeclaracao": "2019:CQ:00010050000008002"
}
],
"nome": "Carta de Quitação"
}
]
} |
{
"status": false,
"motivoCritica": "Nenhum beneficiário encontrado para os parâmetros informados."
} |
| 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) |
Este método irá retornar uma URL ou um caracter BASE64 contendo o arquivo PDF da declaração.
No momento o método que retorno o arquivo gerado PDF das declaração esta sendo desenvolvido, tanto a geração do Imposto de Renda como a Carta de Quitação por utilizar tecnologias antigas para geração do relatório. Estamos trabalhando na revitalização dos mesmo para uma melhor entrega. |
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, matricula do beneficiário.
Através da configuração da Mobile Saúde 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.
| 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âmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| idDeclaracao | Sim | Caracter | Chave de identificação da declaração no sistema (Ano + Declaração + Matricula) |
{
"idDeclaracao": "2020:CQ:00010050000008002"
} |
{
"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"
} |
| 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 |
Outras Ações / Ações relacionadas
| Ação | Descrição |
|---|---|
| Não se aplica | Não se aplica |
Principais Campos e Parâmetros
| 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). |