{"id":21220795,"url":"https://github.com/aspeddro/siconfir","last_synced_at":"2025-07-10T12:31:12.979Z","repository":{"id":44738326,"uuid":"333241417","full_name":"aspeddro/siconfir","owner":"aspeddro","description":"R package to access tax and accounting data of Brazilian states and municipalities provided by the Brazilian Public Sector Accounting and Tax Information System (Siconfi/National Treasure)","archived":false,"fork":false,"pushed_at":"2023-03-25T11:23:24.000Z","size":343,"stargazers_count":13,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-17T22:11:00.746Z","etag":null,"topics":["accounts","brazil","brazilian","budget","economics","r","r-package","rstats","siconfi"],"latest_commit_sha":null,"homepage":"","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aspeddro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null}},"created_at":"2021-01-26T23:05:10.000Z","updated_at":"2024-01-09T13:32:54.000Z","dependencies_parsed_at":"2023-02-09T23:45:52.649Z","dependency_job_id":null,"html_url":"https://github.com/aspeddro/siconfir","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aspeddro%2Fsiconfir","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aspeddro%2Fsiconfir/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aspeddro%2Fsiconfir/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aspeddro%2Fsiconfir/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aspeddro","download_url":"https://codeload.github.com/aspeddro/siconfir/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225637112,"owners_count":17500365,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["accounts","brazil","brazilian","budget","economics","r","r-package","rstats","siconfi"],"created_at":"2024-11-20T22:14:07.141Z","updated_at":"2024-11-20T22:14:07.616Z","avatar_url":"https://github.com/aspeddro.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"# siconfir\n\nR package to access tax and accounting data of Brazilian states and municipalities provided by the Brazilian Public Sector Accounting and Tax Information System (SICONFI/[National Treasure](https://www.gov.br/tesouronacional/en?set_language=en))\n\n## Installation\n\n```r\ninstall.packages(\"remotes\")\nremotes::install_github(\"aspeddro/siconfir\")\n```\n\n## Using\n\n- [get_fiscal()](#get_fiscal): Fiscal management report\n- [get_budget()](#get_budget): Budget execution summary report\n- [get_annual_acc()](#get_annual_acc): Annual statement of accounts\n- [msc_budget()](#msc_budget): Budget accounts, accounting balances matrix\n- [msc_control()](#msc_control): Control accounts, accounting balances matrix\n- [msc_equity()](#msc_equity): Equity accounts, accounting balances matrix\n- [report_status()](#report_status): Report status\n- [get_annex()](#get_annex): Attachments of reports by sphere of government\n- [get_info()](#get_info): Basic information of the federation entities\n- [find_cod()](#find_cod): Find state or municipality information\n\nDatasets:\n\n- [`br_cods`](#br_cods)\n\n## Examples\n\n```r\nlibrary(siconfir)\n```\n\n### get_fiscal()\n\nFiscal management report for the state of Sao Paulo (`35`) for the first four months of 2020:\n\n```r\nsiconfir::get_fiscal(year = 2020, period = 1, cod = 35)\n```\n\n\u003e `cod` is an id assigned to each city and state. See [IBGE, Cities and States](https://www.ibge.gov.br/en/cities-and-states.html?view=municipio), `find_cod()`, `get_info()` or `br_cods`\n\n### get_budget()\n\nSummary of the budget execution report for the state of Rio de Janeiro (`33`) of 2018 for the first two months:\n\n```r\nsiconfir::get_budget(year = 2018, period = 1, cod = 33)\n```\n\n### get_annual_acc()\n\nDeclaration of annual accounts of the municipality of Sao Paulo (`3550308`) 2018:\n\n```r\nsiconfir::get_annual_acc(year = 2018, cod = 3550308)\n```\n\n### msc_budget()\n\nBudget accounts, accounting balances matrix:\n\n```r\nsiconfir::msc_budget(year = 2020, month = 1, cod = 1, matrix_type = \"MSCC\", class = 5, value = \"period_change\")\n```\n\n### msc_control()\n\nControl accounts, accounting balances matrix:\n\n```r\nsiconfir::msc_control(year = 2020, month = 6, cod = 17, matrix_type = \"MSCC\", class = 7, value = \"ending_balance\")\n```\n\n### msc_equity()\n\nEquity accounts, accounting balances matrix:\n\n```r\nsiconfir::msc_equity(year = 2020, month = 12, cod = 1, matrix_type = \"MSCE\", class = 1, value = \"beginning_balance\") # cod = 1 is id of Brazil\n```\n\n### report_status()\n\nInformation on approved and corrected reports as well as matrices delivered to SICONFI:\n\n```r\nsiconfir::report_status(year = 2020, cod = 43)\n```\n### get_annex()\n\nAttachments of reports by sphere of government:\n\n```r\nsiconfir::get_annex()\n```\n\n### get_info()\n\nAcess basic information of the federation entities:\n\n```r\nsiconfir::get_info()\n```\n\n### find_cod()\n\nFind state or municipality information:\n\n```r\nsiconfir::find_cod(\"distrito federal\")\n```\n\n### br_cods\n\nBasic information of Brazilian municipalities and states. `br_cods` provides results similar to `get_info()`, but with some corrections, see [`utils/build_datasets.R`](utils/build_datasets.R)\n\n```r\nsiconfir::br_cods\n```\n\n## Resources\n\n- [SICONFI API](http://apidatalake.tesouro.gov.br/docs/siconfi/)\n- [Fiscal Statement Manual 9th Edition, National Treasure (pt-br)](https://conteudo.tesouro.gov.br/manuais/index.php?option=com_content\u0026view=categories\u0026id=560\u0026Itemid=675)\n\n## Contributing\n\nBugs or suggestions: open an [issue](https://github.com/aspeddro/siconfir/issues) detailing the problem/suggestion, be as reproducible as possible.\n\n## License\n\nThis project is released under the MIT License.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faspeddro%2Fsiconfir","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faspeddro%2Fsiconfir","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faspeddro%2Fsiconfir/lists"}