API IRPF PDF - Médico

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

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:

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": {
    "nome": "Nome do arquivo",
    "file64": "String do arquivo codificado em Base64",
    "mimeType": "Tipo do arquivo: application/pdf"
  },
  "DebugMessage": "string"
}

03. REGRAS DE NEGÓCIO APLICADAS

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

04. EXEMPLO DE UTILIZAÇÃO

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

{
    "Result": 1,
    "Data": {
        "file64": "JVBERi0xLjUKJeLjz9MKNSAwIG9iago8PC9UeXBlL1hPYmplY3QvQ29sb3JTcGFjZS9EZXZpY2VHcmF5L1N1YnR5cGUvSW1hZ2UvQml0c1BlckNvbXBvbmVudCA4L1dpZHRoIDEzMS9MZW5ndGggMTI2OS9IZWlnaHQg==",
        "nome": "IRPF20218462228.pdf",
        "mimeType": "application/pdf"
    },
    "DebugMessage": "",
    "Message": ""
}

Ao decodificar o retorno da API.