O TOTVS Saúde Planos (Linha Datasul) oferece uma série de APIs para integração com o APP da Unimed Brasil.
A API Beneficiário - Histórico de Boletos/TitulosLiquidados tem por objetivo retornar a lista de títulos já pagos pelo beneficiário.
A API foi desenvolvida seguindo as definições disponibilizadas no Swagger da Unimed Brasil.
/Beneficiario/v1/TitulosLiquidados
Esta API deve receber os seguintes parâmetros via header ou via query parameters:
Parâmetro | Tipo de Parâmetro | Tipo de dados | Formato | Obrigatório? |
|---|---|---|---|---|
| header | String | 99999999999 | ||
| header | String | 99999999999999999 |
Deve ser informado obrigatoriamente um CPF ou uma carteira de beneficiário.
O objeto Json de retorno da API possui a seguinte estrutura:
{
"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": [
{
"tituloId": "Identificador do título",
"dtVencimento": "Data de vencimento do título em formato de exibição",
"dtVencimentoAtualizado": "Data de vencimento do título atualizado em formato de exibição, caso seja uma prorrogação ou algo do tipo",
"statusId": "Identificador de status do título",
"status": "Descrição de status do título: PAGO, ABERTO, VENCIDO",
"valor": "Valor do título em formato numérico",
"valorFormatado": "Valor do título formatado para exibição",
"valorAtualizado": "Valor atualizado do título em formato numérico",
"valorAtualizadoFormatado": "Valor atualizado do título formatado para exibição",
"linhaDigitavel": "Linha digital do boleto, possibilitando que o cliente possa copiar e realizar o pagamento",
"cedente": "Nome do cedente",
"urlBoleto": "URL Externa para download do boleto",
"exibirBotaoSegundaVia": "Indica que o botão de segunda via do boleto deve ou não ser exibido no detalhe do título",
"detalhamento": [
{
"descricao": "Descrição da composição de valores o boleto",
"quantidade": "Quantidade do item descrito",
"valorFormatado": "Valor formatado para exibição"
}
]
}
]
},
"DebugMessage": "string"
}
Os resultados apresentados pela API podem ser validados e visualizados 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:
Através da Busca Avançada é possível pesquisar o beneficiário pelo CPF ou pela Carteira do Beneficiário:
Ao informar um dos campos e clicar em buscar será retornado os dados do beneficiário e habilitado a opção Faturamento:
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:
No APP será listado o histórico de 1 ano, considerando a data que está sendo realizada a consulta.
Segue abaixo exemplo prático de como pode ser realizada a validação da API
Realizada uma requisição na API utilizando a carteira do beneficiário e período de acordo com os parâmetros visualizados abaixo:
Parâmetro | Valor |
|---|---|
| 0109206000014 |
A API retornou os seguintes dados:
{
"Result": 1,
"Data": [
{
"categoria": "SENHOR CHOW",
"valor": 441.83,
"valorFormatado": "R$ 441,83",
"itens": [
{
"valor": 441.83,
"valorFormatado": "R$ 441,83",
"detalhes": [
{
"Titulo": "Realizacao",
"Campo": "22/08/17"
},
{
"Titulo": "Quantidade",
"Campo": "100"
},
{
"Titulo": "Procedimento",
"Campo": "CONSULTA EM PRONTO SOCORRO"
}
]
}
]
}
],
"DebugMessage": "",
"Message": ""
}
Os movimentos listados no programa 'Central de Movimentação Guias TISS - hrc-document' para a mesma carteira e período foram:
Ao detalhar o movimento pode ser verificado o valor faturado: