CONTEÚDO
- Visão Geral
- Rota
- Parâmetros de Entrada
- Retorno
- Regras de Negócio Aplicadas
- 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? |
|---|---|---|---|---|
| header | Integer | 99999999 | Sim | |
| competencia | query | String | MM/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 o extrato de contas do médico referente à competência informada. Devolve os valores referente aos títulos já integrados com o Contas a Pagar.
04. EXEMPLO DE UTILIZAÇÃO
Realizada uma requisição na API utilizando a matrícula e a competência conforme abaixo:
Parâmetro | Valor |
|---|---|
| competencia | 05/2021 |
| 00031921 |
{
"Result": 1,
"Data": {
"secoes": [
{
"secaoId": "4301",
"nomeSecao": "430PM1",
"eventos": [
{
"nomeEvento": "PRODUCAO",
"valorFormatado": "R$ 3.008,04",
"qtd": 28
}
],
"totalSecao": "R$ 2.135,71"
},
{
"secaoId": "4311",
"nomeSecao": "431PM1",
"eventos": [
{
"nomeEvento": "PAGTO HORAS PLANTAO",
"valorFormatado": "R$ 9.332,00",
"qtd": 1
},
{
"nomeEvento": "DESCONTO",
"valorFormatado": "R$ 124,00",
"qtd": 1
}
],
"totalSecao": "R$ 6.514,12"
},
{
"secaoId": "4341",
"nomeSecao": "434PM1",
"eventos": [],
"totalSecao": "R$ -321,00"
},
{
"secaoId": "4351",
"nomeSecao": "435PM1",
"eventos": [
{
"nomeEvento": "GLOSA",
"valorFormatado": "R$ 5.920,00",
"qtd": 7
},
{
"nomeEvento": "PRODUCAO",
"valorFormatado": "R$ 1.200,00",
"qtd": 3
}
],
"totalSecao": "R$ 852,00"
},
{
"secaoId": "4361",
"nomeSecao": "436PM1",
"eventos": [
{
"nomeEvento": "PRODUCAO",
"valorFormatado": "R$ 3.164,17",
"qtd": 7
},
{
"nomeEvento": "GLOSA",
"valorFormatado": "R$ 402,00",
"qtd": 2
}
],
"totalSecao": "R$ 2.246,55"
},
{
"secaoId": "4371",
"nomeSecao": "437PM1",
"eventos": [
{
"nomeEvento": "PRODUCAO",
"valorFormatado": "R$ 400,00",
"qtd": 1
},
{
"nomeEvento": "GLOSA",
"valorFormatado": "R$ 2.360,00",
"qtd": 2
}
],
"totalSecao": "R$ 284,00"
}
],
"tituloExtrato": "Valor Liquido",
"valorTotal": "R$ 11.711,38"
},
"DebugMessage": "",
"Message": ""
}
Por fim, os registros aqui listados podem ser validados pelo programa "Consulta Pagamento Prestador" - HPP0510C
