get_rreo: Get Budget Execution Summary Report data (RREO)

In tesouror: Access Brazilian National Treasury Open Data APIs

Get Budget Execution Summary Report data (RREO)

Description

Retrieves data from the Budget Execution Summary Report (RREO) for specific filtering criteria. The RREO is published bimonthly and contains information about revenues, expenses, and other budgetary data.

Usage

get_rreo(
  an_exercicio,
  nr_periodo,
  co_tipo_demonstrativo,
  no_anexo,
  co_esfera,
  id_ente,
  use_cache = TRUE,
  verbose = FALSE,
  page_size = NULL,
  max_rows = Inf
)

get_budget_report(fiscal_year, period, report_type, appendix,
  sphere, entity_id, use_cache = TRUE, verbose = FALSE,
  page_size = NULL, max_rows = Inf)

Arguments

an_exercicio	Integer. Fiscal year (e.g., 2022). Required.
nr_periodo	Integer. Bimester number (1-6). Required.
co_tipo_demonstrativo	Character. Report type: "RREO" or "RREO Simplificado". Required. Note: "RREO Simplificado" applies only to municipalities with fewer than 50,000 inhabitants that opted for simplified reporting.
no_anexo	Character. Appendix name (e.g., "RREO-Anexo 01"). Required.
co_esfera	Character. Government sphere: "M" (municipalities), "E" (states), or "U" (union). Required.
id_ente	Integer. IBGE code of the entity. Required.
use_cache	Logical. If TRUE (default), uses an in-memory cache.
verbose	Logical. If TRUE, prints the full API URL being called. Useful for debugging or testing in a browser. Defaults to getOption("tesouror.verbose", FALSE).
page_size	Integer or NULL. Number of rows per API page. If NULL (default), uses the API server default (5000 for SICONFI/SADIPEM).
max_rows	Numeric. Maximum number of rows to return. Defaults to Inf (all rows). Useful for quick tests with large datasets (e.g., max_rows = 100).
fiscal_year	Integer. Fiscal year (e.g., 2022). Required. Maps to an_exercicio.
period	Integer. Bimester number (1-6). Required. Maps to nr_periodo.
report_type	Character. Report type: "RREO" or "RREO Simplificado". Required. Maps to co_tipo_demonstrativo.
appendix	Character. Appendix name (e.g., "RREO-Anexo 01"). Required. Maps to no_anexo.
sphere	Character. Government sphere: "M" (municipalities), "E" (states), or "U" (union). Required. Maps to co_esfera.
entity_id	Integer. IBGE code of the entity. Required. Maps to id_ente.

Details

get_budget_report() is an English-parameter alias for this function.

Value

A tibble with RREO data including columns such as exercicio, demonstrativo, periodo, periodicidade, instituicao, cod_ibge, uf, populacao, anexo, rotulo, coluna, cod_conta, conta, and valor.

See Also

Other SICONFI: get_anexos(), get_dca(), get_dca_for_state(), get_entes(), get_extrato(), get_msc_controle(), get_msc_orcamentaria(), get_msc_patrimonial(), get_rgf(), get_rgf_for_state(), get_rreo_for_state()

Examples

## Not run: 
rreo <- get_rreo(
  an_exercicio = 2022, nr_periodo = 6,
  co_tipo_demonstrativo = "RREO",
  no_anexo = "RREO-Anexo 01",
  co_esfera = "E", id_ente = 17
)

## End(Not run)

tesouror documentation built on May 7, 2026, 1:06 a.m.