Árvore de páginas

Carregando...

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

A API Extrato de IRPF do Beneficiario/IRPFAnoBase tem por objetivo retornar os períodos anos disponíveis para extração a visualização do demostrativo demonstrativo de IRPF do beneficiário retroativos à data de requisição 12 meses).

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

a. Rota

/Beneficiario/v1/PeriodosDemonstrativoCoparticipacaoIRPFAnoBase

b. Parâmetros de Entrada

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

...

Bloco de código
{
  "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": [
    {
      "idano": "Campo de identificação da competência"2018,
      "nometitulo": "DescriçãoNome aprensentado daao competênciausuário quena serálistagem exibidade noanos aplicativobase"
    }
  ],
  "DebugMessage": "string"
}

...

A API retorna uma lista com de períodos os últimos 12 (doze) meses, à partir da data  em que se está realizando a requisição, para a posterior consulta do extrato de coparticipaçãoos 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

Se a requisição ocorrer no dia 11/03/2020, por exemplo, então a API irá retornarExemplo de retorno:

Bloco de código
{
  "Result": 1,
  "Data": [
	{
      "idtitulo": "03/20202018",
      "nomeano": "02/2020"2018
    },
	{
      "idtitulo": "02/20202017",
      "nomeano": "02/2020"2017
    },
	{
      "idtitulo": "01/20202016",
      "nome": "01/2020"
    },
	{
      "id": "12/2019",
      "nome": "12/2019"
    },
	{
      "id": "11/2019",
      "nome": "11/2019"
    },
	{
      "id": "10/2019",
      "nome": "10/2019"
    },
	{
      "id": "09/2019",
      "nome": "09/2019"
    },
    {
      "id": "08/2019",
      "nome": "08/2019"
    },
    {
      "id": "07/2019",
      "nome": "07/2019"
    },
    {
      "id": "06/2019",
      "nome": "06/2019"
    },
	{
      "id": "05/2019",
      "nome": "05/2019"
    }
	{
      "id": "04/2019",
      "nome": "04/2019"ano": 2016
    }
  ],
  "DebugMessage": "",
  "Message": ""
}

...