API Competências do IRPF - 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 IRPF Ano Base (Medico/IRPFAnoBase) tem por objetivo retornar as últimos (3) competências referente ao demonstrativo de IRPF.

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

a. Rota

/Medico/v1/IRPFAnoBase

b. Parâmetros de Entrada

Esta API não exige parâmetros de entrada.

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": [
    {
      "ano": 2018,
      "titulo": "Nome aprensentado ao usuário na listagem de anos base"
    }
  ],
  "DebugMessage": "string"
}

03. REGRAS DE NEGÓCIO APLICADAS

A API retorna uma lista contendo as últimas três (3) competências referente ao demonstrativo de IRPF.

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": [
        {
            "titulo": "2021",
            "ano": 2021
        },
        {
            "titulo": "2020",
            "ano": 2020
        },
        {
            "titulo": "2019",
            "ano": 2019
        }
    ],
    "DebugMessage": "",
    "Message": ""
}