Histórico da Página

...

Visão Geral
Exemplo de utilização
1. Método declaracoeslistarDeclaracoes
  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 pdfDeclaracaodeclaracaoPdf
  1. Regras de Negocio do Método
  2. EndPoint
  3. Parâmetros de Entrada do Método
  4. Exemplo
  5. Estrutura de Retorno
Tela Declarações
1. Outras Ações / Ações relacionadas
Tela Declarações
1. Principais Campos e Parâmetros
Tabelas utilizadas

...

Segue os métodos utilizados na API:

declaracoeslistaDeclaracoes: Retorna uma lista de declarações do beneficiário.
pdfDeclaracaodeclaracaoPdf: Retorna uma URL ou um caracter BASE64 contendo o arquivo PDF da declaração.

...

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
Âncora
DECLARACAO
DECLARACAO

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.

...

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

Url	Método	Header Content-Type	Descrição
https://<url>:<porta>/rest/mobileSaude/v1/declaracoeslistaDeclaracoes	POST	application/json	Retorna uma lista de declarações

...

Parâmetro	Obrigatório	Tipo	Descrição
chaveBeneficiario	SimNão	Caracter	Chave do Beneficiário (CPF ou Matricula)
chaveBeneficiarioTipo	SimNão	Caracter	Tipo de Login do Beneficiário (CPF ou Matricula)
multiContract	SimNão	Lógico	Utilização de Multi Contratos pelo Beneficiário
matriculaContrato	Sim	Caracter	Matricula do Beneficiário

Exemplo Âncora
DECLARACAOEXEMPLO
DECLARACAOEXEMPLO

...

Bloco de código

language	c#
theme	Midnight
title	Request body
linenumbers	true
collapse	true

{
    "chaveBeneficiarioTipo": "CPF",
    "multiContract": truefalse,
    "chaveBeneficiario": "71461963990",
    "matriculaContrato": "7646163309000011008000013019"
}

Bloco de código

language	c#
theme	Midnight
title	API Retorno - Sucesso
linenumbers	true
collapse	true

{
    "status": true,
    "tiposDeclaracoestipoDeclaracoes": [
        {
            "declaracoes": [
                {
                    "nomeDeclaracao": "2021-00010050000002004",
                    "codigoContrato": "00010050000002",
      nome": "Imposto de Renda",
              "idDeclaracaodeclaracoes": "2021:IRPF:00010050000002004"
                },[
                {
                    "nomeDeclaracaonome": "20202021-0001005000000200400011008000013019",
                    "codigoContratoidDeclaracao": "000100500000022021:IRPF:00011008000013019",
                    "idDeclaracaocodigoContrato": "2020:IRPF:0001005000000200400011008000013"
                },
                {
                    "nomeDeclaracaonome": "2019-00010050000002004",
                    "codigoContrato": "000100500000022020-00011008000013019",
                    "idDeclaracao": "20192020:IRPF:00010050000002004"
                }
            ]00011008000013019",
            "nome": "Imposto de Renda"
        },
        {
            "declaracoes": [
                {
                    "nomeDeclaracao": "2021-00010050000002004",
                    "codigoContrato": "00010050000002",
                    "idDeclaracao": "2021:CQ:00010050000002004"00011008000013"
                },
                {
                    "nomeDeclaracaonome": "2020-00010050000002004",
                    "codigoContrato": "00010050000002"2019-00011008000013019",
                    "idDeclaracao": "20202019:CQIRPF:00010050000002004"
                },
     00011008000013019",
           {
                    "nomeDeclaracao"codigoContrato": "2019-0001005000000200400011008000013",
                    "codigoContrato": "00010050000002",}
                    "idDeclaracao": "2019:CQ:00010050000002004"
   ]
             },
            ],{
            "nome": "Carta de Quitação"
        },
        {
            "declaracoes": [
                {
                    "nomeDeclaracaonome": "2021-00010050000008002",
                    "codigoContrato": "00010050000008"00011008000013019",
                    "idDeclaracao": "2021:IRPF:00010050000008002"
                },
                {
                    "nomeDeclaracao": "2020-00010050000008002"CQ:00011008000013019",
                    "codigoContrato": "00010050000008",
                    "idDeclaracao": "2020:IRPF:00010050000008002"00011008000013"
                },
                {
                    "nomeDeclaracaonome": "20192020-0001005000000800200011008000013019",
                    "codigoContrato": "00010050000008",
                    "idDeclaracao": "20192020:IRPF:00010050000008002"
                }
            ],
            "nome": "Imposto de Renda"
        },
        {
            "declaracoes": [
                {
                    "nomeDeclaracao": "2021-00010050000008002"CQ:00011008000013019",
                    "codigoContrato": "00010050000008",
                    "idDeclaracao": "2021:CQ:0001005000000800200011008000013"
                },
                {
                    "nomeDeclaracaonome": "2020-00010050000008002",
                    "codigoContrato": "000100500000082019-00011008000013019",
                    "idDeclaracao": "20202019:CQ:00010050000008002"
                },
                {00011008000013019",
                    "nomeDeclaracao": "2019-00010050000008002",
                    "codigoContrato": "00010050000008",
                    "idDeclaracao": "2019:CQ:0001005000000800200011008000013"
                }
            ],
            "nome": "Carta de Quitação"
        }
    ]
}

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."
}

...

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
tipoDeclaracaotipoDeclaracoes	Array	Lista de objetos de “tipoDeclaracao“
nome (Objeto tipoDeclaracaotipoDeclaracoes)	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

...

declaracaoPdf
Âncora
PDF
PDF

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

...

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

...

Url	Método	Header Content-Type	Descrição
https://<url>:<porta>/rest/mobileSaude/v1/pdfDeclaracaodeclaracaoPdf	POST	application/json	Retorna a declaração em PDF

...

Bloco de código

language	c#
theme	Midnight
title	Request body
linenumbers	true
collapse	true

{
    "idDeclaracao": "20202021:CQIRPF:0001005000000800200011008000013019"
}

Bloco de código

language	c#
theme	Midnight
title	API Retorno - Sucesso
linenumbers	true
collapse	true

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

...

Card documentos

Informacao	A impressão do PDF da Carta de Quitação utiliza o ponto de entrada PLSQTDEB, por tanto é necessário compila-lo no ambiente. O mesmo estar disponível para download no portal do cliente. Lembrando que o Ponto de entrada deverá retornar um array nesse formato: {,T,, "", "nomeArquivo.PDF"}
Titulo	Importante!

Veja um exemplo de como a comunicação com a API é feita na prática:

Image Removed

03. TELA DECLARAÇÕES Âncora
TELADECLARACOES1
TELADECLARACOES1

...

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

Âncora

	TELADECLARACOES2
	TELADECLARACOES2

Indica se o acesso a Mobile Saúde é Multi Contrato

Campo	Descrição
BA0_MSTLOG	Informar o tipo de acesso de login na API da mobile saúde
BA0_MSMULT
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.

...

Árvore de páginas

Versões comparadas

Versão antiga 14

Nova versão Atual

Chave

Parâmetros de Entrada do Método

Exemplo

Estrutura de Retorno

Parâmetros de Entrada do Método

Exemplo

Estrutura de Retorno

Método

listaDeclaracoes
Âncora
DECLARACAO
DECLARACAO

Endpoint Âncora
DECLARACAOENDPOINT
DECLARACAOENDPOINT

Exemplo Âncora
DECLARACAOEXEMPLO
DECLARACAOEXEMPLO

Método

declaracaoPdf
Âncora
PDF
PDF

03. TELA DECLARAÇÕES Âncora
TELADECLARACOES1
TELADECLARACOES1

Árvore de páginas

Histórico da Página

Versões comparadas

Chave

Método

listaDeclaracoes ÂncoraDECLARACAODECLARACAO

Endpoint ÂncoraDECLARACAOENDPOINTDECLARACAOENDPOINT

Exemplo ÂncoraDECLARACAOEXEMPLODECLARACAOEXEMPLO

Método

declaracaoPdf ÂncoraPDFPDF

03. TELA DECLARAÇÕES ÂncoraTELADECLARACOES1TELADECLARACOES1

listaDeclaracoes
Âncora
DECLARACAO
DECLARACAO

Endpoint Âncora
DECLARACAOENDPOINT
DECLARACAOENDPOINT

Exemplo Âncora
DECLARACAOEXEMPLO
DECLARACAOEXEMPLO

declaracaoPdf
Âncora
PDF
PDF

03. TELA DECLARAÇÕES Âncora
TELADECLARACOES1
TELADECLARACOES1