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 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? |
---|---|---|---|---|
header | Integer | 99999999 | Sim | |
ano | query | Integer | 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": [ { "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 | 2021 |
00004155 |
{ "Message": "", "Data": [ { "itens": [ { "valor": 0.0, "valorFormatado": "R$ 0,00", "detalhes": [ { "Campo": "54.012.406/0001-13", "Titulo": "CNPJ" }, { "Campo": "SAUDE PLANOS GPS", "Titulo": "RAZÃO SOCIAL" } ] } ], "categoria": "Dados da operadora" }, { "itens": [ { "valor": 176.77, "valorFormatado": "R$ 176,77", "detalhes": [] } ], "categoria": "IR Título 0000000000002383" }, { "itens": [ { "valor": 65.37, "valorFormatado": "R$ 65,37", "detalhes": [] } ], "categoria": "IR Título 0000000000002384" }, { "itens": [ { "valor": 2714.61, "valorFormatado": "R$ 2.714,61", "detalhes": [] } ], "categoria": "IR Título 0000000000002385" }, { "itens": [ { "valor": 3327.96, "valorFormatado": "R$ 3.327,96", "detalhes": [] } ], "categoria": "IR Título 0000000000002391" }, { "itens": [ { "valor": 1141.86, "valorFormatado": "R$ 1.141,86", "detalhes": [] } ], "categoria": "IR Título 0000000000002393" }, { "itens": [ { "valor": 973.51, "valorFormatado": "R$ 973,51", "detalhes": [] } ], "categoria": "IR Título 0000000000002394" }, { "itens": [ { "valor": 569.65, "valorFormatado": "R$ 569,65", "detalhes": [] } ], "categoria": "IR Título 0000000000002395" }, { "itens": [ { "valor": 8969.73, "valorFormatado": "R$ 8.969,73", "detalhes": [] } ], "categoria": "IR Total" } ], "DebugMessage": "", "Result": 1 }
Para fins de conferência, pode ser gerado o Relatórios Títulos por Prestador (PP0610D), selecionando as opções: Estado Título = E - Exportado e Espécie Título = IRRF, fechando no prestador e na data de produção: