tesouror (version 0.2.2)

get_msc_controle: Get MSC control accounts data

Description

Retrieves control accounts data (classes 7 and 8) from the Accounting Balances Matrix (MSC).

Usage

get_msc_controle(
  id_ente,
  an_referencia,
  me_referencia,
  co_tipo_matriz,
  classe_conta,
  id_tv,
  use_cache = TRUE,
  verbose = FALSE,
  page_size = NULL,
  max_rows = Inf
)
get_msc_control(entity_id, year, month, matrix_type, account_class,
  value_type, use_cache = TRUE, verbose = FALSE,
  page_size = NULL, max_rows = Inf)

Value

A tibble with MSC control account data.

Arguments

id_ente

Integer. IBGE code of the entity. Required.

an_referencia

Integer. Reference year. Required.

me_referencia

Integer. Reference month (1-12). Required.

co_tipo_matriz

Character. Matrix type: "MSCC" (monthly aggregate) or "MSCE" (annual closing). Required.

classe_conta

Integer. Account class: 7 or 8. Required.

id_tv

Character. Value type: "beginning_balance", "ending_balance", or "period_change". 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).

entity_id

Integer. IBGE code of the entity. Required. Maps to id_ente.

year

Integer. Reference year. Required. Maps to an_referencia.

month

Integer. Reference month (1-12). Required. Maps to me_referencia.

matrix_type

Character. Matrix type: "MSCC" (monthly aggregate) or "MSCE" (annual closing). Required. Maps to co_tipo_matriz.

account_class

Integer. Account class: 7 or 8. Required. Maps to classe_conta.

value_type

Character. Value type: "beginning_balance", "ending_balance", or "period_change". Required. Maps to id_tv.

Details

get_msc_control() is an English alias for get_msc_controle().

See Also

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

Examples

if (FALSE) {
msc_ctrl <- get_msc_controle(
  id_ente = 17, an_referencia = 2022, me_referencia = 12,
  co_tipo_matriz = "MSCC", classe_conta = 8,
  id_tv = "ending_balance"
)
}