Restituição do IRPF (Receita Federal)

{
  "type": "object",
  "properties": {
    "status": {
      "type": [
        "string",
        "null"
      ],
      "description": "Frase-resumo do desfecho, pronta para exibir (ex.: 'Restituição creditada.', 'Declaração processada: imposto a pagar (sem restituição).', 'Nada consta: não há declaração processada para o CPF e exercício informados.')."
    },
    "situacao": {
      "type": [
        "string",
        "null"
      ],
      "description": "Texto da fonte descrevendo a situação da declaração (ex.: 'Os dados da liberação de sua restituição estão descritos abaixo:'). Já vem como texto puro — o HTML e as entidades da origem são removidos."
    },
    "exercicio": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Ano-exercício ao qual a resposta se refere, confirmado pela própria fonte (ex.: 2025). É o exercício que você pediu ou, na ausência do parâmetro, o ano corrente."
    },
    "resultado": {
      "type": [
        "string",
        "null"
      ],
      "description": "Código do resultado do processamento, como a Receita o informa: 'iar' = imposto a restituir, 'iap' = imposto a pagar, 'indeterminado' = sem declaração processada. Para leitura humana, prefira o campo `status`."
    },
    "observacoes": {
      "type": [
        "string",
        "null"
      ],
      "description": "Observações e instruções ao contribuinte, quando a fonte as traz (ex.: telefone da central do banco pagador, aviso de débito automático). Texto puro; o texto de eventuais links é preservado."
    },
    "restituicao": {
      "type": "object",
      "properties": {
        "lote": {
          "type": [
            "string",
            "null"
          ],
          "description": "Lote em que a restituição foi (ou será) paga (ex.: '003')."
        },
        "mensagem": {
          "type": [
            "string",
            "null"
          ],
          "description": "Mensagem adicional da fonte sobre este crédito, quando houver."
        },
        "dataDisponibilidade": {
          "type": [
            "string",
            "null"
          ],
          "description": "Data em que o valor fica disponível no banco, em DD/MM/AAAA."
        },
        "situacaoRestituicao": {
          "type": [
            "string",
            "null"
          ],
          "description": "Situação da restituição segundo a Receita (ex.: 'Creditada')."
        }
      },
      "description": "Dados do crédito da restituição. Sempre presente; campos em null quando não há restituição liberada."
    },
    "cpfConsultado": {
      "type": [
        "string",
        "null"
      ],
      "description": "CPF consultado, formatado com máscara (ex.: '111.111.111-11')."
    },
    "dadosBancarios": {
      "type": "object",
      "properties": {
        "banco": {
          "type": [
            "string",
            "null"
          ],
          "description": "Nome do banco do crédito (ex.: 'ITAU UNIBANCO S.A.')."
        },
        "conta": {
          "type": [
            "string",
            "null"
          ],
          "description": "Conta informada na declaração, quando a fonte a devolve."
        },
        "agencia": {
          "type": [
            "string",
            "null"
          ],
          "description": "Agência informada na declaração."
        },
        "chavePix": {
          "type": [
            "string",
            "null"
          ],
          "description": "Chave PIX usada para o crédito, quando a restituição foi indicada por PIX."
        }
      },
      "description": "Conta em que o crédito da restituição foi (ou será) depositado. Sempre presente; campos em null quando a fonte não informa."
    },
    "tipoDeclaracao": {
      "type": [
        "string",
        "null"
      ],
      "description": "Tipo da declaração, quando informado pela fonte (ex.: retificadora)."
    },
    "debitoAutomatico": {
      "type": "object",
      "properties": {
        "situacao": {
          "type": [
            "string",
            "null"
          ],
          "description": "Situação do débito automático informada pela fonte."
        }
      },
      "description": "Situação do débito automático do imposto a pagar. Sempre presente; campo em null quando não se aplica."
    },
    "existeDeclaracao": {
      "type": "boolean",
      "description": "true = há declaração processada para o CPF neste exercício; false = NADA CONSTA (o contribuinte não declarou nesse ano ou a declaração ainda não entrou na base). false é resultado legítimo, não erro."
    },
    "nomeContribuinte": {
      "type": [
        "string",
        "null"
      ],
      "description": "Nome do contribuinte como consta no cadastro da Receita Federal."
    },
    "emFilaRestituicao": {
      "type": "boolean",
      "description": "true = a restituição está na fila de pagamento dos próximos lotes."
    },
    "possuiRestituicao": {
      "type": "boolean",
      "description": "true = há restituição com situação definida pela fonte (creditada, a ser creditada, em fila etc.); false = sem restituição liberada até o momento (inclui o caso de imposto a pagar)."
    },
    "valorRestituicaoOriginal": {
      "type": [
        "string",
        "null"
      ],
      "description": "Valor original da restituição, como a fonte o informa. null quando a fonte não traz o valor."
    },
    "valorRestituicaoCorrigido": {
      "type": [
        "string",
        "null"
      ],
      "description": "Valor da restituição corrigido (com a atualização aplicada pela Receita até o pagamento). null quando a fonte não traz o valor."
    }
  },
  "description": "Andamento do pedido de restituição do IRPF de um CPF num exercício, direto na fonte oficial e gratuita da Receita Federal (restituicao.receita.fazenda.gov.br). Quando há restituição liberada, traz lote, data de disponibilidade e o banco/agência do crédito. Os sub-objetos `restituicao`, `dadosBancarios` e `debitoAutomatico` estão SEMPRE presentes: quando a fonte não informa, vêm com os campos em null — nunca null no lugar do objeto, nunca chave ausente."
}