API Extrato de IRPF Ano Base

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 Extrato de IRPF do Beneficiario/IRPFAnoBase tem por objetivo retornar os anos disponíveis para a visualização do demonstrativo de IRPF do beneficiário.

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

a. Rota

/Beneficiario/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 com os anos disponíveis para a visualização do demonstrativo de IRPF do beneficiário. Para apresentar os anos e o demonstrativo são utilizados os dados enviados na DMED. Dessa forma, sempre que for gerado o arquivo da DMED será carregada uma tabela com a competência e valores para apresentação no demonstrativo do IRPF.

04. EXEMPLO DE UTILIZAÇÃO

Exemplo de retorno:

{
  "Result": 1,
  "Data": [
	{
      "titulo": "2018",
      "ano": 2018
    },
	{
      "titulo": "2017",
      "ano": 2017
    },
	{
      "titulo": "2016",
      "ano": 2016
    }
  ],
  "DebugMessage": "",
  "Message": ""
}