CONTEÚDO

  1. Visão Geral
    1. Rota
    2. Parâmetros de Entrada
    3. Retorno
  2. Regras de Negócio Aplicadas
  3. 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 (Medico/Extrato) tem por objetivo retornar o extrato de contas do médico.

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

a. Rota

/Medico/v1/Extrato

b. Parâmetros de Entrada

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?

headerInteger99999999Sim
competenciaqueryStringMM/AAAA

Sim

c. 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": {
    "tituloExtrato": "Título que será mostrado junto ao valor total do extrato",
    "valorTotal": "Valor total do extrato",
    "secoes": [
      {
        "secaoId": 0,
        "nomeSecao": "Nome da seção que será apresentado no extrato",
        "totalSecao": "Valor total da seção",
        "eventos": [
          {
            "nomeEvento": "Nome do evento do extrato",
            "qtd": 0,
            "valorFormatado": "Valor do evento do extrato"
          }
        ]
      }
    ]
  },
  "DebugMessage": "string"
}

03. REGRAS DE NEGÓCIO APLICADAS

A API retorna uma lista contendo os últimos seis (6) competências referente ao extrato de contas do médico

04. EXEMPLO DE UTILIZAÇÃO

Se a requisição ocorrer no dia 04/08/2021, por exemplo, então a API irá retornar:

{
    "Result": 1,
    "Data": [
        {
            "valor": "08/2021",
            "nome": "08/2021"
        },
        {
            "valor": "07/2021",
            "nome": "07/2021"
        },
        {
            "valor": "06/2021",
            "nome": "06/2021"
        },
        {
            "valor": "05/2021",
            "nome": "05/2021"
        },
        {
            "valor": "04/2021",
            "nome": "04/2021"
        },
        {
            "valor": "03/2021",
            "nome": "03/2021"
        }
    ],
    "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>