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 IRPF(Medico/IRPF) tem por objetivo retornar o demonstrativo de IRPF do médico.

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

a. Rota

/Medico/v1/IRPF

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
anoqueryIntegerAAAA

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": [
    {
      "categoria": "categoria",
      "itens": [
        {
          "valor": 0,
          "valorFormatado": "Valor do item no formato de exibição desejado",
          "detalhes": [
            {
              "Titulo": "Título apresentado para o detalhe do item",
              "Campo": "Campo com a descrição do detalhe do item"
            }
          ]
        }
      ]
    }
  ],
  "DebugMessage": "string"
}

03. REGRAS DE NEGÓCIO APLICADAS

A API retorna uma lista contendo o demonstrativo de IRPF do médico.

04. EXEMPLO DE UTILIZAÇÃO

Realizada uma requisição na API utilizando a matrícula e a competência conforme abaixo:

Parâmetro

Valor

ano

2016

00031921
{
    "Result": 1,
    "Data": [
        {
            "categoria": "Dados da operadora",
            "itens": [
                {
                    "valor": 0.0,
                    "valorFormatado": "R$ 0,00",
                    "detalhes": [
                        {
                            "Titulo": "CNPJ",
                            "Campo": "46.542.613/0001-51"
                        },
                        {
                            "Titulo": "RAZÃO SOCIAL",
                            "Campo": "OPERADORA DE SAUDE TOTVS"
                        }
                    ]
                }
            ]
        },
        {
            "categoria": "IR Título 0000000000000098",
            "itens": [
                {
                    "valor": 39814.53,
                    "valorFormatado": "R$ 39.814,53",
                    "detalhes": []
                }
            ]
        },
        {
            "categoria": "IR Título 0000000000000106",
            "itens": [
                {
                    "valor": 156165.09,
                    "valorFormatado": "R$ 156.165,09",
                    "detalhes": []
                }
            ]
        },
        {
            "categoria": "IR Título 0000000000000127",
            "itens": [
                {
                    "valor": 630.79,
                    "valorFormatado": "R$ 630,79",
                    "detalhes": []
                }
            ]
        },
        {
            "categoria": "IR Título 0000000000000139",
            "itens": [
                {
                    "valor": 1970.1,
                    "valorFormatado": "R$ 1.970,10",
                    "detalhes": []
                }
            ]
        },
        {
            "categoria": "IR Título 0000000000000156",
            "itens": [
                {
                    "valor": 243.19,
                    "valorFormatado": "R$ 243,19",
                    "detalhes": []
                }
            ]
        },
        {
            "categoria": "IR Título 0000000000000157",
            "itens": [
                {
                    "valor": 312.31,
                    "valorFormatado": "R$ 312,31",
                    "detalhes": []
                }
            ]
        },
        {
            "categoria": "IR Título 0000000000000166",
            "itens": [
                {
                    "valor": 1921.0,
                    "valorFormatado": "R$ 1.921,00",
                    "detalhes": []
                }
            ]
        },
        {
            "categoria": "IR Total",
            "itens": [
                {
                    "valor": 201057.01,
                    "valorFormatado": "R$ 201.057,01",
                    "detalhes": []
                }
            ]
        }
    ],
    "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>