Package 'tceper'

Description

Retrieve state and municipal agreements (convênios).

Usage

tce_agreements(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other procurement: tce_bid_details(), tce_bid_documents(), tce_bid_legal_basis(), tce_bid_modalities(), tce_bid_stages(), tce_bid_statuses(), tce_bids(), tce_contract_amendments(), tce_contract_documents(), tce_contract_items(), tce_contracts(), tce_object_characteristics(), tce_object_classifications(), tce_object_nature()

Description

Lookup table of benefit types (RemessaTCEPE system).

Usage

tce_benefit_types(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other remessa: tce_budget_statuses(), tce_legal_instrument_documents(), tce_legal_instrument_items(), tce_legal_instrument_participants(), tce_legal_instruments(), tce_procurement_process_budget(), tce_procurement_process_documents(), tce_procurement_process_participants(), tce_procurement_processes(), tce_reference_codes(), tce_reference_dates(), tce_reference_sources(), tce_remessa_works(), tce_remessa_works_execution(), tce_remessa_works_geometry(), tce_update_indices()

Description

Retrieve bids with their respective bidders (licitantes).

Usage

tce_bid_details(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other procurement: tce_agreements(), tce_bid_documents(), tce_bid_legal_basis(), tce_bid_modalities(), tce_bid_stages(), tce_bid_statuses(), tce_bids(), tce_contract_amendments(), tce_contract_documents(), tce_contract_items(), tce_contracts(), tce_object_characteristics(), tce_object_classifications(), tce_object_nature()

Description

Retrieve documents associated with bids.

Usage

tce_bid_documents(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other procurement: tce_agreements(), tce_bid_details(), tce_bid_legal_basis(), tce_bid_modalities(), tce_bid_stages(), tce_bid_statuses(), tce_bids(), tce_contract_amendments(), tce_contract_documents(), tce_contract_items(), tce_contracts(), tce_object_characteristics(), tce_object_classifications(), tce_object_nature()

Description

Lookup table of legal basis types for bids.

Usage

tce_bid_legal_basis(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other procurement: tce_agreements(), tce_bid_details(), tce_bid_documents(), tce_bid_modalities(), tce_bid_stages(), tce_bid_statuses(), tce_bids(), tce_contract_amendments(), tce_contract_documents(), tce_contract_items(), tce_contracts(), tce_object_characteristics(), tce_object_classifications(), tce_object_nature()

Description

Lookup table of bid modality types.

Usage

tce_bid_modalities(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other procurement: tce_agreements(), tce_bid_details(), tce_bid_documents(), tce_bid_legal_basis(), tce_bid_stages(), tce_bid_statuses(), tce_bids(), tce_contract_amendments(), tce_contract_documents(), tce_contract_items(), tce_contracts(), tce_object_characteristics(), tce_object_classifications(), tce_object_nature()

Description

Lookup table of bid process stages.

Usage

tce_bid_stages(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other procurement: tce_agreements(), tce_bid_details(), tce_bid_documents(), tce_bid_legal_basis(), tce_bid_modalities(), tce_bid_statuses(), tce_bids(), tce_contract_amendments(), tce_contract_documents(), tce_contract_items(), tce_contracts(), tce_object_characteristics(), tce_object_classifications(), tce_object_nature()

Description

Lookup table of bid status types.

Usage

tce_bid_statuses(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other procurement: tce_agreements(), tce_bid_details(), tce_bid_documents(), tce_bid_legal_basis(), tce_bid_modalities(), tce_bid_stages(), tce_bids(), tce_contract_amendments(), tce_contract_documents(), tce_contract_items(), tce_contracts(), tce_object_characteristics(), tce_object_classifications(), tce_object_nature()

Description

Retrieve public procurement bids (licitações).

Usage

tce_bids(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other procurement: tce_agreements(), tce_bid_details(), tce_bid_documents(), tce_bid_legal_basis(), tce_bid_modalities(), tce_bid_stages(), tce_bid_statuses(), tce_contract_amendments(), tce_contract_documents(), tce_contract_items(), tce_contracts(), tce_object_characteristics(), tce_object_classifications(), tce_object_nature()

Description

Possible statuses for cost-estimate items/lots.

Usage

tce_budget_statuses(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other remessa: tce_benefit_types(), tce_legal_instrument_documents(), tce_legal_instrument_items(), tce_legal_instrument_participants(), tce_legal_instruments(), tce_procurement_process_budget(), tce_procurement_process_documents(), tce_procurement_process_participants(), tce_procurement_processes(), tce_reference_codes(), tce_reference_dates(), tce_reference_sources(), tce_remessa_works(), tce_remessa_works_execution(), tce_remessa_works_geometry(), tce_update_indices()

Description

Retrieve budgeted (forecast) revenue data. Municipal entities only.

Usage

tce_budgeted_revenues(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other revenues: tce_municipal_revenues(), tce_state_revenues()

Description

Removes cached API responses so that subsequent calls hit the API again. By default clears everything; use pattern to selectively clear entries for specific endpoints.

Usage

tce_cache_clear(pattern = NULL)

Arguments

Value

Invisibly returns the number of entries cleared.

See Also

tce_cache_info()

Examples

tce_cache_clear()              # clear everything
tce_cache_clear("Contratos")   # clear contract queries only

Description

Returns a tibble describing all currently cached entries, including the cache key (endpoint + parameters), row count, timestamp and age. Useful for understanding what is cached and when it will expire.

Usage

tce_cache_info()

Value

A tibble with columns key, rows, cached_at and age_secs, or an empty tibble if the cache is empty. The cache TTL is controlled by getOption("tceper.cache_ttl", 3600).

See Also

tce_cache_clear()

Examples

tce_cache_info()

Description

Returns a tibble listing all 71 endpoints available in the TCE-PE Open Data API, with their group, description and URL. Use search to filter by keyword.

Usage

tce_catalog(search = NULL)

Arguments

Value

A tibble with columns endpoint, group, title, and url.

See Also

tce_params(), tce_fields(), tce_endpoint()

Examples

tce_catalog()
tce_catalog(search = "contrat")
tce_catalog(search = "municipio")

Description

Retrieve liquidation records for budget commitments.

Usage

tce_commitment_liquidations(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other commitments: tce_commitment_payments(), tce_commitment_summary(), tce_state_commitment_items(), tce_state_price_comparison()

Description

Retrieve payment records for budget commitments (municipal only).

Usage

tce_commitment_payments(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other commitments: tce_commitment_liquidations(), tce_commitment_summary(), tce_state_commitment_items(), tce_state_price_comparison()

Description

Retrieve original values, reinforcements and cancellations for budget commitments (empenhos), for both municipal and state entities.

Usage

tce_commitment_summary(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other commitments: tce_commitment_liquidations(), tce_commitment_payments(), tce_state_commitment_items(), tce_state_price_comparison()

Description

Retrieve considerandos (findings/grounds) from adjudicated processes.

Usage

tce_consideranda(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other processes: tce_debts_fines(), tce_determinations(), tce_outcomes(), tce_processes(), tce_recommendations(), tce_retirement_outcomes(), tce_special_accountability(), tce_spending_limits()

Description

Retrieve addenda / amendments (termos aditivos) to contracts.

Usage

tce_contract_amendments(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other procurement: tce_agreements(), tce_bid_details(), tce_bid_documents(), tce_bid_legal_basis(), tce_bid_modalities(), tce_bid_stages(), tce_bid_statuses(), tce_bids(), tce_contract_documents(), tce_contract_items(), tce_contracts(), tce_object_characteristics(), tce_object_classifications(), tce_object_nature()

Description

Retrieve documents associated with contracts.

Usage

tce_contract_documents(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other procurement: tce_agreements(), tce_bid_details(), tce_bid_documents(), tce_bid_legal_basis(), tce_bid_modalities(), tce_bid_stages(), tce_bid_statuses(), tce_bids(), tce_contract_amendments(), tce_contract_items(), tce_contracts(), tce_object_characteristics(), tce_object_classifications(), tce_object_nature()

Description

Retrieve the individual items that compose a contract.

Usage

tce_contract_items(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other procurement: tce_agreements(), tce_bid_details(), tce_bid_documents(), tce_bid_legal_basis(), tce_bid_modalities(), tce_bid_stages(), tce_bid_statuses(), tce_bids(), tce_contract_amendments(), tce_contract_documents(), tce_contracts(), tce_object_characteristics(), tce_object_classifications(), tce_object_nature()

Description

Retrieve state and municipal contracts.

Usage

tce_contracts(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

tce_params() to discover available parameters, tce_fields() to see output columns.

Other procurement: tce_agreements(), tce_bid_details(), tce_bid_documents(), tce_bid_legal_basis(), tce_bid_modalities(), tce_bid_stages(), tce_bid_statuses(), tce_bids(), tce_contract_amendments(), tce_contract_documents(), tce_contract_items(), tce_object_characteristics(), tce_object_classifications(), tce_object_nature()

Examples

## Not run: 
# Not run: reaches the live TCE-PE API, which only accepts connections
# from Brazilian IP addresses (unreachable from CRAN / most CI).
tce_contracts(codigo_efisco_ug = "510101", verbose = TRUE)

## End(Not run)

Description

Lookup table of supplier/creditor types.

Usage

tce_creditor_types(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other reference: tce_entities(), tce_funding_sources(), tce_inactivation_reasons(), tce_municipal_entities(), tce_municipalities(), tce_payroll_types(), tce_state_entities(), tce_sub_units()

Description

Retrieve debts and fines imposed.

Usage

tce_debts_fines(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other processes: tce_consideranda(), tce_determinations(), tce_outcomes(), tce_processes(), tce_recommendations(), tce_retirement_outcomes(), tce_special_accountability(), tce_spending_limits()

Description

Retrieve determinations from adjudicated electronic processes.

Usage

tce_determinations(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other processes: tce_consideranda(), tce_debts_fines(), tce_outcomes(), tce_processes(), tce_recommendations(), tce_retirement_outcomes(), tce_special_accountability(), tce_spending_limits()

Description

Returns the full metadata for a single endpoint, including its input parameters (entrada) and output fields (saida). Useful for programmatic access to endpoint metadata.

Usage

tce_endpoint(endpoint)

Arguments

Value

A list with endpoint metadata, including entrada (input parameters) and saida (output fields) when available.

See Also

tce_catalog(), tce_params(), tce_fields()

Examples

tce_endpoint("Contratos")

Description

Retrieve all managed entities (unidades jurisdicionadas), state and municipal.

Usage

tce_entities(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other reference: tce_creditor_types(), tce_funding_sources(), tce_inactivation_reasons(), tce_municipal_entities(), tce_municipalities(), tce_payroll_types(), tce_state_entities(), tce_sub_units()

Description

Returns a tibble describing the columns returned by a given endpoint. When clean_names = TRUE (the default), column names are converted from the API's original names to snake_case.

Usage

tce_fields(endpoint)

Arguments

Value

A tibble with columns name, type, and description. Has a custom print method that summarises the field names at the top.

See Also

tce_params(), tce_catalog(), tce_endpoint()

Examples

tce_fields("Contratos")
tce_fields("Municipios")

Description

Lookup table of funding source types.

Usage

tce_funding_sources(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other reference: tce_creditor_types(), tce_entities(), tce_inactivation_reasons(), tce_municipal_entities(), tce_municipalities(), tce_payroll_types(), tce_state_entities(), tce_sub_units()

Description

Lookup table of inactivation reason types.

Usage

tce_inactivation_reasons(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other reference: tce_creditor_types(), tce_entities(), tce_funding_sources(), tce_municipal_entities(), tce_municipalities(), tce_payroll_types(), tce_state_entities(), tce_sub_units()

Description

Legal instrument documents (Remessa)

Usage

tce_legal_instrument_documents(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other remessa: tce_benefit_types(), tce_budget_statuses(), tce_legal_instrument_items(), tce_legal_instrument_participants(), tce_legal_instruments(), tce_procurement_process_budget(), tce_procurement_process_documents(), tce_procurement_process_participants(), tce_procurement_processes(), tce_reference_codes(), tce_reference_dates(), tce_reference_sources(), tce_remessa_works(), tce_remessa_works_execution(), tce_remessa_works_geometry(), tce_update_indices()

Description

Legal instrument items (Remessa)

Usage

tce_legal_instrument_items(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other remessa: tce_benefit_types(), tce_budget_statuses(), tce_legal_instrument_documents(), tce_legal_instrument_participants(), tce_legal_instruments(), tce_procurement_process_budget(), tce_procurement_process_documents(), tce_procurement_process_participants(), tce_procurement_processes(), tce_reference_codes(), tce_reference_dates(), tce_reference_sources(), tce_remessa_works(), tce_remessa_works_execution(), tce_remessa_works_geometry(), tce_update_indices()

Description

Legal instrument participants (Remessa)

Usage

tce_legal_instrument_participants(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other remessa: tce_benefit_types(), tce_budget_statuses(), tce_legal_instrument_documents(), tce_legal_instrument_items(), tce_legal_instruments(), tce_procurement_process_budget(), tce_procurement_process_documents(), tce_procurement_process_participants(), tce_procurement_processes(), tce_reference_codes(), tce_reference_dates(), tce_reference_sources(), tce_remessa_works(), tce_remessa_works_execution(), tce_remessa_works_geometry(), tce_update_indices()

Description

Retrieve legal instruments from RemessaTCEPE.

Usage

tce_legal_instruments(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other remessa: tce_benefit_types(), tce_budget_statuses(), tce_legal_instrument_documents(), tce_legal_instrument_items(), tce_legal_instrument_participants(), tce_procurement_process_budget(), tce_procurement_process_documents(), tce_procurement_process_participants(), tce_procurement_processes(), tce_reference_codes(), tce_reference_dates(), tce_reference_sources(), tce_remessa_works(), tce_remessa_works_execution(), tce_remessa_works_geometry(), tce_update_indices()

Description

Lookup table of municipal creditor types.

Usage

tce_municipal_creditor_types(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other expenditures: tce_municipal_expenditures(), tce_municipal_transfers(), tce_state_creditor_types(), tce_state_expenditures()

Description

Retrieve municipal-level managed entities.

Usage

tce_municipal_entities(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other reference: tce_creditor_types(), tce_entities(), tce_funding_sources(), tce_inactivation_reasons(), tce_municipalities(), tce_payroll_types(), tce_state_entities(), tce_sub_units()

Description

Retrieve municipal-level expenditure data.

Usage

tce_municipal_expenditures(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other expenditures: tce_municipal_creditor_types(), tce_municipal_transfers(), tce_state_creditor_types(), tce_state_expenditures()

Description

Retrieve municipal-level revenue data.

Usage

tce_municipal_revenues(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other revenues: tce_budgeted_revenues(), tce_state_revenues()

Examples

## Not run: 
# Not run: reaches the live TCE-PE API, which only accepts connections
# from Brazilian IP addresses (unreachable from CRAN / most CI).
tce_municipal_revenues(id_unidade_gestora = "384")

## End(Not run)

Description

Retrieve inter-unit transfers granted within the same municipality.

Usage

tce_municipal_transfers(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other expenditures: tce_municipal_creditor_types(), tce_municipal_expenditures(), tce_state_creditor_types(), tce_state_expenditures()

Description

Retrieve the list of municipalities in Pernambuco.

Usage

tce_municipalities(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other reference: tce_creditor_types(), tce_entities(), tce_funding_sources(), tce_inactivation_reasons(), tce_municipal_entities(), tce_payroll_types(), tce_state_entities(), tce_sub_units()

Description

Lookup table of procurement object characteristic types.

Usage

tce_object_characteristics(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other procurement: tce_agreements(), tce_bid_details(), tce_bid_documents(), tce_bid_legal_basis(), tce_bid_modalities(), tce_bid_stages(), tce_bid_statuses(), tce_bids(), tce_contract_amendments(), tce_contract_documents(), tce_contract_items(), tce_contracts(), tce_object_classifications(), tce_object_nature()

Description

Lookup table of procurement object classification types.

Usage

tce_object_classifications(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other procurement: tce_agreements(), tce_bid_details(), tce_bid_documents(), tce_bid_legal_basis(), tce_bid_modalities(), tce_bid_stages(), tce_bid_statuses(), tce_bids(), tce_contract_amendments(), tce_contract_documents(), tce_contract_items(), tce_contracts(), tce_object_characteristics(), tce_object_nature()

Description

Lookup table of procurement object nature types.

Usage

tce_object_nature(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other procurement: tce_agreements(), tce_bid_details(), tce_bid_documents(), tce_bid_legal_basis(), tce_bid_modalities(), tce_bid_stages(), tce_bid_statuses(), tce_bids(), tce_contract_amendments(), tce_contract_documents(), tce_contract_items(), tce_contracts(), tce_object_characteristics(), tce_object_classifications()

Description

Retrieve outcomes of adjudicated electronic processes.

Usage

tce_outcomes(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other processes: tce_consideranda(), tce_debts_fines(), tce_determinations(), tce_processes(), tce_recommendations(), tce_retirement_outcomes(), tce_special_accountability(), tce_spending_limits()

Description

Returns a tibble describing the query parameters accepted by a given endpoint. The api_name column shows the exact name expected by the API; the r_name column shows the snake_case equivalent that you can pass to wrapper functions.

Usage

tce_params(endpoint)

Arguments

Value

A tibble with columns api_name, r_name, required, type, and description. Has a custom print method that summarises the parameter names at the top.

See Also

tce_fields(), tce_catalog(), tce_endpoint()

Examples

tce_params("Contratos")
tce_params("Municipios")
tce_params("LicitacaoUG")

Description

Lookup table of payroll (folha) types.

Usage

tce_payroll_types(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other reference: tce_creditor_types(), tce_entities(), tce_funding_sources(), tce_inactivation_reasons(), tce_municipal_entities(), tce_municipalities(), tce_state_entities(), tce_sub_units()

Description

Lookup table of person creditor types.

Usage

tce_person_creditor_types(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other suppliers: tce_sanctions(), tce_suppliers()

Description

Retrieve the list of formalized physical and electronic processes.

Usage

tce_processes(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other processes: tce_consideranda(), tce_debts_fines(), tce_determinations(), tce_outcomes(), tce_recommendations(), tce_retirement_outcomes(), tce_special_accountability(), tce_spending_limits()

Description

Procurement process budget (Remessa)

Usage

tce_procurement_process_budget(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other remessa: tce_benefit_types(), tce_budget_statuses(), tce_legal_instrument_documents(), tce_legal_instrument_items(), tce_legal_instrument_participants(), tce_legal_instruments(), tce_procurement_process_documents(), tce_procurement_process_participants(), tce_procurement_processes(), tce_reference_codes(), tce_reference_dates(), tce_reference_sources(), tce_remessa_works(), tce_remessa_works_execution(), tce_remessa_works_geometry(), tce_update_indices()

Description

Procurement process documents (Remessa)

Usage

tce_procurement_process_documents(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other remessa: tce_benefit_types(), tce_budget_statuses(), tce_legal_instrument_documents(), tce_legal_instrument_items(), tce_legal_instrument_participants(), tce_legal_instruments(), tce_procurement_process_budget(), tce_procurement_process_participants(), tce_procurement_processes(), tce_reference_codes(), tce_reference_dates(), tce_reference_sources(), tce_remessa_works(), tce_remessa_works_execution(), tce_remessa_works_geometry(), tce_update_indices()

Description

Procurement process participants (Remessa)

Usage

tce_procurement_process_participants(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other remessa: tce_benefit_types(), tce_budget_statuses(), tce_legal_instrument_documents(), tce_legal_instrument_items(), tce_legal_instrument_participants(), tce_legal_instruments(), tce_procurement_process_budget(), tce_procurement_process_documents(), tce_procurement_processes(), tce_reference_codes(), tce_reference_dates(), tce_reference_sources(), tce_remessa_works(), tce_remessa_works_execution(), tce_remessa_works_geometry(), tce_update_indices()

Description

Retrieve procurement processes from RemessaTCEPE.

Usage

tce_procurement_processes(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other remessa: tce_benefit_types(), tce_budget_statuses(), tce_legal_instrument_documents(), tce_legal_instrument_items(), tce_legal_instrument_participants(), tce_legal_instruments(), tce_procurement_process_budget(), tce_procurement_process_documents(), tce_procurement_process_participants(), tce_reference_codes(), tce_reference_dates(), tce_reference_sources(), tce_remessa_works(), tce_remessa_works_execution(), tce_remessa_works_geometry(), tce_update_indices()

Description

Retrieve engineering works and services overseen by the Court of Accounts.

Usage

tce_public_works(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other public_works: tce_public_works_audits(), tce_public_works_contractors()

Description

Retrieve audit data on public works.

Usage

tce_public_works_audits(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other public_works: tce_public_works(), tce_public_works_contractors()

Description

Retrieve data on companies contracted for public works.

Usage

tce_public_works_contractors(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other public_works: tce_public_works(), tce_public_works_audits()

Description

Retrieve recommendations from adjudicated electronic processes.

Usage

tce_recommendations(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other processes: tce_consideranda(), tce_debts_fines(), tce_determinations(), tce_outcomes(), tce_processes(), tce_retirement_outcomes(), tce_special_accountability(), tce_spending_limits()

Description

Reference codes for cost-estimate item imports.

Usage

tce_reference_codes(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other remessa: tce_benefit_types(), tce_budget_statuses(), tce_legal_instrument_documents(), tce_legal_instrument_items(), tce_legal_instrument_participants(), tce_legal_instruments(), tce_procurement_process_budget(), tce_procurement_process_documents(), tce_procurement_process_participants(), tce_procurement_processes(), tce_reference_dates(), tce_reference_sources(), tce_remessa_works(), tce_remessa_works_execution(), tce_remessa_works_geometry(), tce_update_indices()

Description

Available dates for reference sources in cost-estimate imports.

Usage

tce_reference_dates(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other remessa: tce_benefit_types(), tce_budget_statuses(), tce_legal_instrument_documents(), tce_legal_instrument_items(), tce_legal_instrument_participants(), tce_legal_instruments(), tce_procurement_process_budget(), tce_procurement_process_documents(), tce_procurement_process_participants(), tce_procurement_processes(), tce_reference_codes(), tce_reference_sources(), tce_remessa_works(), tce_remessa_works_execution(), tce_remessa_works_geometry(), tce_update_indices()

Description

Lookup table of reference sources for cost-estimate imports.

Usage

tce_reference_sources(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other remessa: tce_benefit_types(), tce_budget_statuses(), tce_legal_instrument_documents(), tce_legal_instrument_items(), tce_legal_instrument_participants(), tce_legal_instruments(), tce_procurement_process_budget(), tce_procurement_process_documents(), tce_procurement_process_participants(), tce_procurement_processes(), tce_reference_codes(), tce_reference_dates(), tce_remessa_works(), tce_remessa_works_execution(), tce_remessa_works_geometry(), tce_update_indices()

Description

Public works details (Remessa)

Usage

tce_remessa_works(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other remessa: tce_benefit_types(), tce_budget_statuses(), tce_legal_instrument_documents(), tce_legal_instrument_items(), tce_legal_instrument_participants(), tce_legal_instruments(), tce_procurement_process_budget(), tce_procurement_process_documents(), tce_procurement_process_participants(), tce_procurement_processes(), tce_reference_codes(), tce_reference_dates(), tce_reference_sources(), tce_remessa_works_execution(), tce_remessa_works_geometry(), tce_update_indices()

Description

Public works execution (Remessa)

Usage

tce_remessa_works_execution(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other remessa: tce_benefit_types(), tce_budget_statuses(), tce_legal_instrument_documents(), tce_legal_instrument_items(), tce_legal_instrument_participants(), tce_legal_instruments(), tce_procurement_process_budget(), tce_procurement_process_documents(), tce_procurement_process_participants(), tce_procurement_processes(), tce_reference_codes(), tce_reference_dates(), tce_reference_sources(), tce_remessa_works(), tce_remessa_works_geometry(), tce_update_indices()

Description

Public works geometry (Remessa)

Usage

tce_remessa_works_geometry(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other remessa: tce_benefit_types(), tce_budget_statuses(), tce_legal_instrument_documents(), tce_legal_instrument_items(), tce_legal_instrument_participants(), tce_legal_instruments(), tce_procurement_process_budget(), tce_procurement_process_documents(), tce_procurement_process_participants(), tce_procurement_processes(), tce_reference_codes(), tce_reference_dates(), tce_reference_sources(), tce_remessa_works(), tce_remessa_works_execution(), tce_update_indices()

Description

Low-level function that sends a GET request to the TCE-PE Open Data API and returns the response content as a tibble. Higher-level wrapper functions such as tce_contracts(), tce_state_expenditures(), etc. call this function internally.

You can use tce_request() directly to access any API endpoint, including those that do not yet have a dedicated wrapper.

Usage

tce_request(
  endpoint,
  ...,
  clean_names = TRUE,
  max_tries = 3,
  progress = getOption("tceper.progress", TRUE),
  verbose = getOption("tceper.verbose", FALSE)
)

Arguments

Details

API base URL

⁠https://sistemas.tcepe.tc.br/DadosAbertos/⁠

Network access

The API host only accepts connections from Brazilian IP addresses. Calls from outside Brazil are dropped at the network level and surface as a connection or TLS error. The offline discovery functions (tce_catalog(), tce_params(), tce_fields()) do not require network access and work anywhere.

URL construction

The TCE-PE API uses Struts2-style URLs where ! invokes a method (e.g. ⁠Contratos!json⁠). The URL is built with paste0() to preserve the literal ! – using httr2::req_url_path_append() would encode it as ⁠%21⁠, causing the server to ignore all query parameters.

Response limit

The API returns at most 100,000 records per request. When this limit is reached, a warning is issued suggesting the use of additional filters.

Encoding

The TCE-PE backend runs on ISO-8859-1 (Latin-1), not UTF-8. The package handles this transparently in both directions:

• Response body is decoded as Latin-1 and returned as UTF-8 R strings, so accented Portuguese characters come through cleanly (São, Município, Conceição, etc.).

• Query parameters are transcoded UTF-8 -> Latin-1 before percent-encoding, so filtering by accented values works as expected (e.g. tce_municipalities(municipio = "São José da Coroa Grande")). You can pass any R string with accents – the conversion is automatic.

Options

• tceper.progress – set to FALSE to suppress all progress messages.

• tceper.verbose – set to TRUE to always print request/response details.

• tceper.cache_ttl – cache time-to-live in seconds (default: 3600).

Value

A tibble with the response content. Returns a zero-row tibble if no records are found.

Examples

## Not run: 
# Not run: these examples reach the live TCE-PE API, which only accepts
# connections from Brazilian IP addresses and is therefore unreachable
# from CRAN check machines and most CI runners.

# Direct query to any endpoint
tce_request("Contratos", CodigoEfiscoUG = "510101")

# Show full request/response details
tce_request("Contratos", CodigoEfiscoUG = "510101", verbose = TRUE)

# Keep original column names
tce_request("Municipios", clean_names = FALSE)

## End(Not run)

Description

Retrieve outcomes from processes related to retirement, pension and reform (Aposentadoria, Pensão e Reforma).

Usage

tce_retirement_outcomes(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other processes: tce_consideranda(), tce_debts_fines(), tce_determinations(), tce_outcomes(), tce_processes(), tce_recommendations(), tce_special_accountability(), tce_spending_limits()

Description

Retrieve sanctions applied to suppliers.

Usage

tce_sanctions(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other suppliers: tce_person_creditor_types(), tce_suppliers()

Description

Retrieve school transport services overseen by the Court of Accounts.

Usage

tce_school_transport(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

Description

Retrieve municipal and state public servants (SAGRES Personnel).

Usage

tce_servants(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

Description

Retrieve outcomes from special accountability processes (Tomada de Conta Especial).

Usage

tce_special_accountability(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other processes: tce_consideranda(), tce_debts_fines(), tce_determinations(), tce_outcomes(), tce_processes(), tce_recommendations(), tce_retirement_outcomes(), tce_spending_limits()

Description

Retrieve spending-limit data from government account processes.

Usage

tce_spending_limits(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other processes: tce_consideranda(), tce_debts_fines(), tce_determinations(), tce_outcomes(), tce_processes(), tce_recommendations(), tce_retirement_outcomes(), tce_special_accountability()

Description

Retrieve individual line items of state-level commitments.

Usage

tce_state_commitment_items(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other commitments: tce_commitment_liquidations(), tce_commitment_payments(), tce_commitment_summary(), tce_state_price_comparison()

Description

Lookup table of state creditor types.

Usage

tce_state_creditor_types(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other expenditures: tce_municipal_creditor_types(), tce_municipal_expenditures(), tce_municipal_transfers(), tce_state_expenditures()

Description

Retrieve state-level managed entities.

Usage

tce_state_entities(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other reference: tce_creditor_types(), tce_entities(), tce_funding_sources(), tce_inactivation_reasons(), tce_municipal_entities(), tce_municipalities(), tce_payroll_types(), tce_sub_units()

Description

Retrieve state-level expenditure data.

Usage

tce_state_expenditures(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

tce_params() to discover available parameters, tce_fields() to see output columns.

Other expenditures: tce_municipal_creditor_types(), tce_municipal_expenditures(), tce_municipal_transfers(), tce_state_creditor_types()

Examples

## Not run: 
# Not run: reaches the live TCE-PE API, which only accepts connections
# from Brazilian IP addresses (unreachable from CRAN / most CI).
tce_state_expenditures(id_unidade_gestora = "510101")

## End(Not run)

Description

Retrieve state commitment items with values for price comparison.

Usage

tce_state_price_comparison(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other commitments: tce_commitment_liquidations(), tce_commitment_payments(), tce_commitment_summary(), tce_state_commitment_items()

Description

Retrieve state-level revenue data from the TCE-PE API.

Usage

tce_state_revenues(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

tce_params() to discover available parameters, tce_fields() to see output columns.

Other revenues: tce_budgeted_revenues(), tce_municipal_revenues()

Examples

## Not run: 
# Not run: reaches the live TCE-PE API, which only accepts connections
# from Brazilian IP addresses (unreachable from CRAN / most CI).
tce_state_revenues(id_unidade_gestora = "510101")

## End(Not run)

Description

Retrieve sub-units belonging to managed entities.

Usage

tce_sub_units(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other reference: tce_creditor_types(), tce_entities(), tce_funding_sources(), tce_inactivation_reasons(), tce_municipal_entities(), tce_municipalities(), tce_payroll_types(), tce_state_entities()

Description

Retrieve registered suppliers. Partial matching is supported.

Usage

tce_suppliers(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other suppliers: tce_person_creditor_types(), tce_sanctions()

Description

Indices for updating prices in cost-estimate spreadsheets.

Usage

tce_update_indices(
  ...,
  verbose = getOption("tceper.verbose", FALSE),
  cache = TRUE,
  clean_names = TRUE
)

Arguments

Value

A tibble.

See Also

Other remessa: tce_benefit_types(), tce_budget_statuses(), tce_legal_instrument_documents(), tce_legal_instrument_items(), tce_legal_instrument_participants(), tce_legal_instruments(), tce_procurement_process_budget(), tce_procurement_process_documents(), tce_procurement_process_participants(), tce_procurement_processes(), tce_reference_codes(), tce_reference_dates(), tce_reference_sources(), tce_remessa_works(), tce_remessa_works_execution(), tce_remessa_works_geometry()