Histórico da Página

...

1. Visão Geral
2. Exemplo de utilização
3. Tela XXX
   1. Outras Ações / Ações relacionadas
      
4. Tela XXX
   1. Principais Campos e Parâmetros
      
5. Tabelas utilizadas

01. VISÃO GERAL

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.

02. EXEMPLO DE UTILIZAÇÃO

Segue os métodos utilizados na API:

• reeExtrato:  Retorna uma lista com todos os protocolos de reembolso do beneficiário e do seu grupo familiar, conforme regra de negócio.
• reeDetalhe: Retorna eventos (itens) de um reembolso especifico.
• reeHistorico: Retorna o histórico de alterações de status do protocolo de reembolso.
• reeStatus: Retorna os status do protocolo de reembolso, para montagem das legendas da listagem.

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.

Método reeExtrato

Este método irá retornar a lista com todos os protocolos de reembolso do beneficiário. Será retornado somente o cabeçalho do reembolso.

Regras de Negocio do Método

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.

Endpoint

Parâmetros de Entrada do Método

Exemplo

{
    "chaveBeneficiario": "00011007000001012",
    "dataInicial": "2022-02-11",
    "dataFinal": "2022-02-11"
}

{
    "status": true,
    "extrato": [
        {
            "beneficiarioNome ": "CATELYN STARK",
            "dataInclusao": "2022-02-11",
            "tipoServicoId": "",
            "cidade": "",
            "prestadorCodigo": "000001",
            "prestadorCpfCnpj": "66579707000102",
            "tipoServicoDescricao": "",
            "estado": "",
            "previsaoPagamento": "2022-02-18",
            "beneficiarioMatricula": "00011007000001012",
            "valorReembolsado": 76.4,
            "statusId": 2,
            "prestadorNome": "HOSPITAL MATER DEI",
            "observacao": "TESTE OBSERVACAO",
            "valorApresentado": 600,
            "chaveReembolso": "00000020180119000054"
        },
        {
            "beneficiarioNome ": "CATELYN STARK",
            "dataInclusao": "2022-02-11",
            "tipoServicoId": "",
            "cidade": "",
            "prestadorCodigo": "000001",
            "prestadorCpfCnpj": "66579707000102",
            "tipoServicoDescricao": "",
            "estado": "",
            "previsaoPagamento": "",
            "beneficiarioMatricula": "00011007000001012",
            "valorReembolsado": 0,
            "statusId": 5,
            "prestadorNome": "HOSPITAL MATER DEI",
            "observacao": "",
            "valorApresentado": 278,
            "chaveReembolso": "00000020180119000055"
        }
    ]
}

{
    "status": false,
    "motivoCritica": "Não existem protocolos de reembolso a serem visualizados"
}

Estrutura de Retorno

03. TELA XXXXX

Outras Ações / Ações relacionadas

...