...

1. Visão Geral
   1. Rota
   2. Parâmetros de Entrada
   3. Retorno
2. Regras de Negócio Aplicadas
3. Como Validar as Informações
4. Exemplo de Como Validar as Informações

01. VISÃO GERAL

O TOTVS Saúde Planos (Linha Datasul) oferece uma série de APIs para integração com o APP da Unimed Brasil.

A API B Beneficiário - Histórico de Boletos/TitulosLiquidados tem por objetivo retornar o extrato de coparticipação do beneficiário, isto é, todos os procedimentos e insumos realizados pelo beneficiário em determinado período e que tiveram coparticipação cobrada do a lista de títulos já pagos pelo beneficiário.

A API foi desenvolvida seguindo as definições disponibilizadas no Swagger da Unimed Brasil. 

a. Rota 

/Beneficiario/v1/DemonstrativoCoparticipacaoTitulosLiquidados

b. Parâmetros de Entrada

Esta API deve receber os seguintes parâmetros via header ou via query parameters:

Deve ser informado obrigatoriamente um CPF ou uma carteira de beneficiário.

...

{
  "Result": "Domínio: 0 = Erro na execução do serviço, 1 = Processamento Ok",
  "Message": "Mensagem de retorno que deverá ser exibida ao usuário (obrigatória em caso de erro, ou seja, Result = 0)",
  "Data": {
    "tituloTotal": "Titulo do totalizador de valores",
    "valorTotal": "Somatório de valores dos títulos",
    "titulos": [
      {
        "categoriatituloId": "categoriaIdentificador do título",
        "valordtVencimento": 0,
 "Data de vencimento do título em formato de exibição",
        "valorFormatadodtVencimentoAtualizado": "Valor total da seção noData de vencimento do título atualizado em formato de exibição desejado, caso seja uma prorrogação ou algo do tipo",
        "itensstatusId": [ "Identificador de status do título",
        "status": "Descrição  {
  de status do título: PAGO, ABERTO, VENCIDO",
        "valor": 0,
   "Valor do título em formato numérico",
        "valorFormatado": "Valor do título formatado para exibição",
        "valorFormatadovalorAtualizado": "Valor atualizado do itemtítulo noem formato de exibição desejadonumérico",
        "valorAtualizadoFormatado": "Valor atualizado do título formatado para exibição",
          "detalheslinhaDigitavel": [
"Linha digital do boleto, possibilitando que o cliente possa copiar e realizar {
o pagamento",
        "cedente": "Nome do cedente",
        "TitulourlBoleto": "TítuloURL apresentadoExterna para download do boleto",
        "exibirBotaoSegundaVia": "Indica que o botão de segunda via do boleto deve ou não ser exibido no detalhe do itemtítulo",
        "detalhamento": [
          "Campo{
            "descricao": "CampoDescrição comda acomposição descriçãode dovalores detalheo do itemboleto",
            "quantidade": "Quantidade do item }
descrito",
            "valorFormatado": "Valor formatado para ]exibição"
          }
        ]
      }
    ]
  },
  "DebugMessage": "string"
}

02. REGRAS DE NEGÓCIO APLICADAS

• A API irá retornar os movimentos (procedimentos/insumos) onde a data de realização esteja dentro do primeiro e último dia do período selecionado.
  • Sempre que o movimento indicar que houve recolhimento de valor no prestador (vl-desconto-prestador) será apresentado no demonstrativo.
  • Sempre que o movimento estiver amarrado a uma nota de coparticipação, e essa nota amarrada a uma fatura integrada ao financeiro (contas a receber) será apresentado no demonstrativo.

...

• verificar se o beneficiário consultado é cliente (contratante), e listará todos os títulos pagos desse cliente. Somente irá apresentar no APP os títulos que já foram gerados os boletos (processo de boletos do sistema).
• Irá retornar o histórico de 1 ano, considerando a data que está sendo realizada a consulta.

03. VALIDAR AS INFORMAÇÕES

Os resultados apresentados pela API podem ser validados e visualizados no programa 'Central de Movimentação Guias TISS - hrc-document'.
Para tanto, deve-se realizar a busca por beneficiário e data de realização do movimento conforme período desejado.

Na tela inicial, clique em 'Busca Avançada':

Image Removed

Na tela da busca, na aba 'Documento', selecione o tipo de exibição 'Por Movimento' e o beneficiário desejado:

Image Removed

E, na aba 'Movimento', selecione o intervalo de data de realização de acordo com o período desejado (se período informado na API foi 04/2018, por exemplo, o intervalo de datas deverá ser 01/04/2018 a 30/04/2018):

Image Removed

Ao clicar em buscar, serão listados na tela principal, os movimentos do beneficiário para o período. Os movimentos que estiverem nas situações, conforme as regras da API, serão os movimetnos listados no APP.

Image Removed

EXEMPLO DE UTILIZAÇÃO

nos seguintes programas/relatórios: Consulta Unificada de Pessoas (hvp.personInformation)

Ao acessar o programa na tela inicial está disponível a opção de Busca Avançada:

Image Added

Através da Busca Avançada é possível pesquisar o beneficiário pelo CPF ou pela Carteira do Beneficiário:

Image Added

Ao informar um dos campos e clicar em buscar será retornado os dados do beneficiário e habilitado a opção Faturamento:

Image Added

Ao clicar em Faturamento abrirá a tela para consulta de títulos. Nessa tela é possível informar o intervalor inicial e final. Ao pesquisar será retornado uma lista com todos os títulos do beneficiário no período determinado:

Image Added

No APP será listado o histórico de 1 ano, considerando a data que está sendo realizada a consulta.

04. EXEMPLO DE COMO VALIDAR AS INFORMAÇÕES

Segue abaixo exemplo Segue abaixo exemplos prático de como pode ser realizada a validação da API.

a) Realizada uma requisição na API utilizando a carteira do beneficiário e período de acordo com os parâmetros visualizados abaixo:

A API retornou os seguintes dados:

...