CONTEÚDO

Visão Geral
Regras de Negócio Aplicadas
1. Parâmetros de Entrada
2. Retorno
Exemplo de Utilização

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 Extrato de Utilização do Beneficiário tem por objetivo retornar o extrato de utilização do beneficiário, isto é, todos os procedimentos e insumos realizados pelo beneficiário em determinado período.

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

02. REGRAS DE NEGÓCIO APLICADAS

a. Rota

/Beneficiario/v1/Extrato.

b. Parâmetros de Entrada

Para esta API devem ser informados os cabeçalhos abaixo no header da requisição:

Cabeçalho	Tipo de dados	Formato
X-CPF	String	99999999999
X-Carteira	String	99999999999999999
periodoId	String	MM/AAAA

Devem ser informados, obrigatoriamente, o CPF e/ou carteira do beneficiário e o período.

b. Retorno

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": [
 	{
 	 "nome": "Nome da categoria de agrupamento do extrato",
 	 "valor": "Valor total da categoria de agrupamento do extrato",
 	 "procedimentos": [
		{
	 	 "procedimentoId": "Código do procedimento realizado",
	 	 "nomeProcedimento": "Nome do procedimento realizado",
	 	 "dtRealizacao": "Data de realização do procedimento em formato de exibição",
	 	 "nomePrestador": "Nome do prestador executante"
		}	
	 ]
 	}
 ],
 "DebugMessage": "string"
}

A API irá retornar apenas os movimentos dos beneficiários que já estiverem sidos liberados.
O valor será preenchido apenas caso o serviço tenha cobrança em Custo Operacional ou então possua Participação.
Para classificar os serviços, o programa irá se valer do parâmetro da Manutenção da Transação X, que poderá estar classificado como.....
Todos os insumos serão agrupados como Outras Despesas, etc, etc.

03. EXEMPLO DE UTILIZAÇÃO

Se a requisição ocorrer no dia 01/07/2020, por exemplo, então a API irá retornar:

{
  "Result": 1,
  "Data": [
	{
      "id": "07/2020",
      "nome": "07/2020"
    },
	{
      "id": "06/2020",
      "nome": "06/2020"
    },
	{
      "id": "05/2020",
      "nome": "05/2020"
    },
	{
      "id": "04/2020",
      "nome": "04/2020"
    },
	{
      "id": "03/2020",
      "nome": "03/2020"
    },
	{
      "id": "02/2020",
      "nome": "02/2020"
    },
	{
      "id": "01/2020",
      "nome": "01/2020"
    },
    {
      "id": "12/2019",
      "nome": "12/2019"
    },
    {
      "id": "11/2019",
      "nome": "11/2019"
    },
    {
      "id": "10/2019",
      "nome": "10/2019"
    },
	{
      "id": "09/2019",
      "nome": "09/2019"
    }
	{
      "id": "08/2019",
      "nome": "08/2019"
    }
  ],
  "DebugMessage": "",
  "Message": ""
}

<!-- esconder o menu --> 


<style>
div.theme-default .ia-splitter #main {
    margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
    display: none;
}
#main {
    padding-left: 10px;
    padding-right: 10px;
    overflow-x: hidden;
}

.aui-header-primary .aui-nav,  .aui-page-panel {
    margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
    margin-left: 0px !important;
}
</style>