Este documento tem como objetivo demonstrar a utilização da API Extrato de Reembolso para a integração do TOTVS Saúde Planos Linha Protheus com a Mobile Saúde, onde será disponibilizado ao beneficiário a relação dos seus protocolos de reembolso e seus status, a visualização dos itens do protocolo e o histórico de alterações de status.
A API utilizará o padrão REST.
Segue os métodos utilizados na API:
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.
Este método irá retornar a lista com todos os protocolos de reembolso do beneficiário. Será retornado somente o cabeçalho do reembolso.
Se os parâmetros Data Inicial e Data Final não forem informados, será retornado uma lista de reembolsos de acordo com a quantidade de meses cadastrado no campo Qt. Meses G. (BA0_MSGUIA). Caso o campo não seja encontrado na base de dados, será utilizado o período de verificação dos últimos 12 meses.
Quando o beneficiário solicitado for o titular, será retornado os seus reembolsos e de todo o grupo familiar.
Quando o beneficiário solicitado for um dependente, será retornado apenas os seus próprios reembolsos.
Url | Método | Header Content-Type | Descrição |
|---|---|---|---|
| https://<url>:<porta>/rest/mobileSaude/v1/extratoReembolso | POST | application/json | Retorna uma lista com os protocolos de reembolso |
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| chaveBeneficiario | Sim | Caracter | Chave do Beneficiário (CPF) |
| dataInicial | Não | Caracter | Data inicial do extrato de reembolso |
| dataFinal | Não | Caracter | Data final do extrato de reembolso |
{
"chaveBeneficiario": "82737323800",
"dataInicial": "2022-07-04",
"dataFinal": "2022-07-04"
} |
{
"status": true,
"extrato": [
{
"chaveReembolso": "00000020180119000056",
"beneficiarioMatricula": "00011008000019017",
"beneficiarioNome": "RUAN CAUA DA COSTA",
"statusId": 1,
"cidade": "",
"estado": "",
"dataInclusao": "2022-07-04",
"previsaoPagamento": "",
"prestadorCodigo": "000001",
"prestadorNome": "HOSPITAL MATER DEI",
"prestadorCpfCnpj": "66579707000102",
"tipoServicoId": "",
"tipoServicoDescricao": "",
"valorApresentado": 100,
"valorReembolsado": 0,
"observacao": ""
}
]
} |
{
"status": false,
"motivoCritica": "Não existem protocolos de reembolso a serem visualizados"
} |
| 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 |
| extrato | Array | Lista de objetos de “extrato“ |
| chaveReembolso | Caracter | Numero do Protocolo de Reembolso no sistema |
| beneficiarioMatricula | Caracter | Matricula do Beneficiário (Operadora + Empresa + Matricula + Tipo Registro + Digito) |
| beneficiarioNome | Caracter | Nome do Beneficiário |
| statusId | Numérico | Código do status, conforme retorno do método statusReembolso. |
| cidade | Caracter | Cidade do Atendimento |
| estado | Caracter | Estado do Atendimento |
| dataInclusao | Caracter | Data de Digitação do Protocolo de Reembolso (Formato: YYYY-MM-DD) |
| previsaoPagamento | Caracter | Data de Pagamento (Formato: YYYY-MM-DD) |
| prestadorCodigo | Caracter | Código da Rede de Atendimento |
| prestadorNome | Caracter | Nome da Rede de Atendimento |
| prestadorCpfCnpj | Caracter | CPF/CNPJ da Rede de Atendimento |
| tipoServicoId | Caracter | Não utilizado |
| tipoServicoDescricao | Caracter | Não utilizado |
| valorApresentado | Numérico | Valor apresentado no Protocolo de Reembolso |
| valorReembolsado | Numérico | Valor Reembolsado pelo Operadora |
| observacao | Caracter | Observação do Protocolo de Reembolso |
Este método irá retornar os detalhes dos eventos (itens) de um protocolo de reembolso.
Esse método irá receber a chave do reembolso que foi retornado no método extratoReembolso.
Através do campo URL Document (BA0_MSURDO) no cadastro da operadora, deverá ser informado o caminho de acesso dos arquivos anexados no protocolo para download .
| Url | Método | Header Content-Type | Descrição |
|---|---|---|---|
| https://<url>:<porta>/rest/mobileSaude/v1/detalheReembolso | POST | application/json | Retorna os itens de um protocolo especifico |
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| chaveReembolso | Sim | Caracter | Numero do Protocolo de Reembolso no Sistema |
{
"chaveReembolso": "00000020180119000055"
} |
{
"status": true,
"itens": [
{
"procedimentoDescricao": "SANGUE OCULTO, PESQUISA NAS FEZES",
"quantidadeExecutada": 1,
"dataExecucao": "2022-02-11",
"cidade": "ACARAU",
"valorApresentado": 25,
"estado": "CE",
"documentoTipo": "NOTA FISCAL",
"documentoNumero": "2513",
"itemId": "00000020180119000055001",
"statusId": 4,
"valorReembolsado": 0,
"observacao": "",
"procedimento": "40303136"
},
{
"procedimentoDescricao": "CONSULTA EM CONSULTORIO",
"quantidadeExecutada": 1,
"dataExecucao": "2022-02-11",
"cidade": "AGUA BRANCA",
"valorApresentado": 253,
"estado": "AL",
"documentoTipo": "NOTA FISCAL",
"documentoNumero": "2134",
"itemId": "00000020180119000055002",
"statusId": 3,
"valorReembolsado": 0,
"observacao": "",
"procedimento": "10101012"
}
],
"documentos": [
{
"nomeArquivo": "LOG NO SCHEDULE DO RATEIO DAS BAIXAS.ZIP",
"caminhoArquivo": "http://www.seudominio.com.br/documentos/reembolso/LOG NO SCHEDULE DO RATEIO DAS BAIXAS.ZIP",
"nomeApresentacao": "log no schedule do rateio das baixas"
},
{
"nomeArquivo": "PATCH SISPAC.RAR",
"caminhoArquivo": "http://www.seudominio.com.br/documentos/reembolso/PATCH SISPAC.RAR",
"nomeApresentacao": "PATCH SISPAC"
},
{
"nomeArquivo": "06581736341-IRPF-2021-2020-ORIGI-IMAGEM-RECIBO.PDF",
"caminhoArquivo": "http://www.seudominio.com.br/documentos/reembolso/06581736341-IRPF-2021-2020-ORIGI-IMAGEM-RECIBO.PDF",
"nomeApresentacao": "06581736341-irpf-2021-2020-origi-imagem-recibo"
}
]
} |
{
"status": false,
"motivoCritica": "Não existem detalhes a serem visualizados"
} |
| 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 |
| itens | Array | Lista de objetos de “itens“ |
| documentos | Array | Lista de objetos de “documentos“ |
| itemId | Caracter | Numero do Protocolo do Reembolso no sistema mais o sequencial do item. |
| procedimento | Caracter | Código do procedimento |
| procedimentoDescricao | Caracter | Descrição do procedimento |
| statusId | Numérico | Código do status, conforme retorno do método statusReembolso. |
| cidade | Caracter | Cidade do Atendimento |
| estado | Caracter | Estado do Atendimento |
| dataExecucao | Caracter | Data de execução do procedimento (Formato: YYYY-MM-DD) |
| documentoTipo | Caracter | Tipo do Documento do Reembolso |
| documentoNumero | Caracter | Numero do Documento |
| quantidadeExecutada | Numérico | Quantidade Realizada |
| valorApresentado | Numérico | Valor apresentado no Protocolo |
| valorReembolsado | Numérico | Valor reembolsado pela Operadora |
| observacao | Caracter | Não utilizado |
| nomeApresentacao | Caracter | Descrição do Arquivo |
| nomeArquivo | Caracter | Arquivo com a extensão. |
| caminhoArquivo | Caracter | URL do Arquivo no servidor para download. |
Este método irá retornar o histórico de alterações de status do protocolo de reembolso.
Esse método irá receber a chave do reembolso que foi retornado no método extratoReembolso.
| Url | Método | Header Content-Type | Descrição |
|---|---|---|---|
| https://<url>:<porta>/rest/mobileSaude/v1/historicoReembolso | POST | application/json | Retorna o histórico de alterações de status do protocolo de reembolso |
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| chaveReembolso | Sim | Caracter | Numero do Protocolo de Reembolso no Sistema |
{
"chaveReembolso": "00000020180119000055"
} |
{
"status": true,
"historico": [
{
"dataHora": "2022-02-11 10:59",
"statusId": "2"
},
{
"dataHora": "2022-02-11 10:57",
"statusId": "1"
},
{
"dataHora": "2022-02-11 10:57",
"statusId": "2"
},
{
"dataHora": "2022-02-14 18:23",
"statusId": "5"
}
]
} |
{
"status": false,
"motivoCritica": "Não existem históricos a serem visualizados"
} |
| 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 |
| historico | Array | Lista de objetos de “historico“ |
| dataHora | Caracter | Data e Hora da movimentação do status do Reembolso |
| statusId | Caracter | Código do status, conforme retorno do método statusReembolso. |
Retorna os status do protocolo de reembolso, para montagem das legendas da listagem referente aos métodos extratoReembolso, detalheReembolso e historicoReembolso.
Segue tabela abaixo dos status da API relacionados com os status do protocolo de reembolso no remote:
| Status na API | Status no Remote |
|---|---|
| 0 = Solicitação não concluida | A = Solicitação não concluída |
| 1 = Protocolado | 0 = Solicitado (Portal) ; 1 = Protocolado |
| 2 = Em Analise | 2 = Em analise ; 3 = Deferido ; 5 = Em digitacao ; 9 = Auditoria |
3 = Aprovado | 6 = Lib. financeiro ; Legenda Verde do Item do Reembolso |
| 4 = Rejeitado | 4 = Indeferido ; 7 = Nao lib. financeiro ; 8 = Glosado ; Legenda Vermelho do Item do Reembolso |
| 5 = Aguardando informação do beneficiário | B = Aguardando informação do Beneficiário |
| 6 = Aprovado parcialmente | C = Aprovado Parcialmente |
| 7 = Cancelado | D = Cancelado |
| 8 = Reembolso revertido | E = Reembolso Revertido |
| Url | Método | Header Content-Type | Descrição |
|---|---|---|---|
| https://<url>:<porta>/rest/mobileSaude/v1/statusReembolso | POST | application/json | Retorna os status do protocolo de reembolso |
Não é necessário enviar parâmetros para este método.
{} |
{
"status": true,
"reembolsoStatus": [
{
"chaveStatus": "0",
"descricao": "Solicitação não concluida"
},
{
"chaveStatus": "1",
"descricao": "Protocolado"
},
{
"chaveStatus": "2",
"descricao": "Em Analise"
},
{
"chaveStatus": "3",
"descricao": "Aprovado"
},
{
"chaveStatus": "4",
"descricao": "Rejeitado"
},
{
"chaveStatus": "5",
"descricao": "Aguardando informação do beneficiário"
},
{
"chaveStatus": "6",
"descricao": "Aprovado parcialmente"
},
{
"chaveStatus": "7",
"descricao": "Cancelado"
},
{
"chaveStatus": "8",
"descricao": "Reembolso revertido"
}
]
} |
| 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 |
reembolsoStatus | Array | Lista de objetos de “reembolsoStatus“ |
| chaveStatus | Caracter | Código de identificação do status do Reembolso |
| descricao | Caracter | Descrição do status |
Outras Ações / Ações relacionadas
| Ação | Descrição |
|---|---|
| Não se aplica | Não se aplica |
Principais Campos e Parâmetros do TOTVS Saúde Planos Linha Protheus
| Campo | Descrição |
|---|---|
| BA0_MSGUIA | Indica a quantidade de meses que o sistema irá verificar os protocolos de reembolso. Por exemplo: valor 6, será verificado os reembolsos dos últimos 6 meses |
| BA0_MSURDO | Informe a URL HTTP para download dos arquivos anexados do protocolo de reembolso. |