### Get Patrimonial Data (C#) Source: https://apidatalake.tesouro.gov.br/docs/siconfi This C# example demonstrates how to call the mscPatrimonialGet API. It includes error handling and uses the Swagger client library. ```csharp using System; using System.Diagnostics; using IO.Swagger.Api; using IO.Swagger.Client; using IO.Swagger.Model; namespace Example { public class mscPatrimonialGetExample { public void main() { var apiInstance = new MSCPatrimonialApi(); var idEnte = 56; // Integer | Código IBGE do Ente. var anReferencia = 789; // Long | Exercício de referência da matriz. var meReferencia = 789; // Long | Mês de referência da matriz var coTipoMatriz = coTipoMatriz_example; // String | Tipo de matriz enviada ao Siconfi: mensal ou agregada (MSCC) ou de encerramento do exercício (MSCE). var classeConta = 56; // Integer | Classe de contas contábeis que recebem lançamentos de natureza patrimonial. var idTv = idTv_example; // String | Os valores detalhados em uma MSC podem ser de três tipos: saldo incial (beginning_balance), saldo final (ending_balance) ou movimento (period_change). try { // Detalhamento dos registros informados nas contas contábeis que recebem lançamentos de natureza patrimonial. MSC-Patrimonial result = apiInstance.mscPatrimonialGet(idEnte, anReferencia, meReferencia, coTipoMatriz, classeConta, idTv); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling MSCPatrimonialApi.mscPatrimonialGet: " + e.Message ); } } } } ``` -------------------------------- ### Fetch DCA Data with C# SDK Source: https://apidatalake.tesouro.gov.br/docs/siconfi This C# example demonstrates how to use the generated SDK to retrieve DCA data. It includes basic error handling and parameter setup. ```csharp using System; using System.Diagnostics; using IO.Swagger.Api; using IO.Swagger.Client; using IO.Swagger.Model; namespace Example { public class dcaGetExample { public void main() { var apiInstance = new DCAApi(); var anExercicio = 789L; // Long | Exercício do relatório. var idEnte = 56; // Integer | Código IBGE do Ente. var noAnexo = "noAnexo_example"; // String | Anexos do relatório. ATENÇÃO: As contas do exercício de 2013 foram entregues em dois formatos: QDCC para entes que não haviam aderido ao PCASP e DCA para todos os demais. Assim apenas os anexos que possuem o prefixo DCA são referentes a esse relatório, os demais anexos referem-se aos dados do QDCC de 2013. (optional) try { // Lista dos dados contidos nos quadros das contas anuais ``` -------------------------------- ### Initialize Python Swagger Client Source: https://apidatalake.tesouro.gov.br/docs/siconfi Imports and setup for the Python Swagger client. ```python from __future__ import print_statement import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint ``` -------------------------------- ### Make GET Request to Siconfi API using Curl Source: https://apidatalake.tesouro.gov.br/docs/siconfi Use this command to make a GET request to the Siconfi API for budgetary data. Ensure all parameters are correctly formatted. ```bash curl -X GET "https://apidatalake.tesouro.gov.br/ords/siconfi/tt//msc_orcamentaria?id_ente=&an_referencia=&me_referencia=&co_tipo_matriz=&classe_conta=&id_tv=" ``` -------------------------------- ### Initialize MSC Patrimonial API in JavaScript Source: https://apidatalake.tesouro.gov.br/docs/siconfi Setup for the MSC Patrimonial API client in a Node.js environment. ```javascript var SiconfiApi = require('siconfi_api'); var api = new SiconfiApi.MSCPatrimonialApi() var idEnte = 56; // {Integer} Código IBGE do Ente. var anReferencia = 789; // {Long} Exercício de referência da matriz. var meReferencia = 789; // {Long} Mês de referência da matriz var coTipoMatriz = coTipoMatriz_example; // {String} Tipo de matriz enviada ao Siconfi: mensal ou agregada (MSCC) ou de encerramento do exercício (MSCE). var classeConta = 56; // {Integer} Classe de contas contábeis que recebem lançamentos de natureza patrimonial. ``` -------------------------------- ### Get RREO Data (Python) Source: https://apidatalake.tesouro.gov.br/docs/siconfi Retrieve RREO data using the Python client. This example includes API instantiation, parameter setting, and exception handling. ```python from __future__ import print_statement import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = swagger_client.RREOApi() anExercicio = 789 # Long | Exercício do relatório. nrPeriodo = 56 # Integer | Bimestre de referência do relatório dentro de um exercício. coTipoDemonstrativo = coTipoDemonstrativo_example # String | Tipo do Demonstrativo. RREO Simplificado aplica-se apenas aos municípios com menos de 50 mil habitantes que optaram pela publicação simplificada. idEnte = 56 # Integer | Código IBGE do Ente. noAnexo = noAnexo_example # String | Os diversos demonstrativos do RREO são agrupados em anexos. (optional) coEsfera = coEsfera_example # String | Filtro de esfera M = Municípios, E = Estados e DF, U = União e C = Consórcio (optional) try: # Lista dos dados contidos nos anexos do RREO. api_response = api_instance.rreo_get(anExercicio, nrPeriodo, coTipoDemonstrativo, idEnte, noAnexo=noAnexo, coEsfera=coEsfera) pprint(api_response) except ApiException as e: print("Exception when calling RREOApi->rreoGet: %s\n" % e) ``` -------------------------------- ### Retrieve MSC Patrimonial data in Java Source: https://apidatalake.tesouro.gov.br/docs/siconfi Example usage of the MSCPatrimonialApi client to fetch patrimonial data. ```java import io.swagger.client.*; import io.swagger.client.auth.*; import io.swagger.client.model.*; import io.swagger.client.api.MSCPatrimonialApi; import java.io.File; import java.util.*; public class MSCPatrimonialApiExample { public static void main(String[] args) { MSCPatrimonialApi apiInstance = new MSCPatrimonialApi(); Integer idEnte = 56; // Integer | Código IBGE do Ente. Long anReferencia = 789; // Long | Exercício de referência da matriz. Long meReferencia = 789; // Long | Mês de referência da matriz String coTipoMatriz = coTipoMatriz_example; // String | Tipo de matriz enviada ao Siconfi: mensal ou agregada (MSCC) ou de encerramento do exercício (MSCE). Integer classeConta = 56; // Integer | Classe de contas contábeis que recebem lançamentos de natureza patrimonial. String idTv = idTv_example; // String | Os valores detalhados em uma MSC podem ser de três tipos: saldo incial (beginning_balance), saldo final (ending_balance) ou movimento (period_change). try { MSC-Patrimonial result = apiInstance.mscPatrimonialGet(idEnte, anReferencia, meReferencia, coTipoMatriz, classeConta, idTv); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MSCPatrimonialApi#mscPatrimonialGet"); e.printStackTrace(); } } } ``` ```java import io.swagger.client.api.MSCPatrimonialApi; public class MSCPatrimonialApiExample { public static void main(String[] args) { MSCPatrimonialApi apiInstance = new MSCPatrimonialApi(); Integer idEnte = 56; // Integer | Código IBGE do Ente. Long anReferencia = 789; // Long | Exercício de referência da matriz. Long meReferencia = 789; // Long | Mês de referência da matriz String coTipoMatriz = coTipoMatriz_example; // String | Tipo de matriz enviada ao Siconfi: mensal ou agregada (MSCC) ou de encerramento do exercício (MSCE). Integer classeConta = 56; // Integer | Classe de contas contábeis que recebem lançamentos de natureza patrimonial. String idTv = idTv_example; // String | Os valores detalhados em uma MSC podem ser de três tipos: saldo incial (beginning_balance), saldo final (ending_balance) ou movimento (period_change). try { MSC-Patrimonial result = apiInstance.mscPatrimonialGet(idEnte, anReferencia, meReferencia, coTipoMatriz, classeConta, idTv); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MSCPatrimonialApi#mscPatrimonialGet"); e.printStackTrace(); } } } ``` -------------------------------- ### Call MSCControleApi Get Method Source: https://apidatalake.tesouro.gov.br/docs/siconfi Use this method to get details of records informed in accounting accounts that receive control nature postings. Ensure all required parameters are provided. ```python api_instance = swagger_client.MSCControleApi() idEnte = 56 # Integer | Código IBGE do Ente. anReferencia = 789 # Long | Exercício de referência da matriz. meReferencia = 789 # Long | Mês de referência da matriz. coTipoMatriz = coTipoMatriz_example # String | Tipo de matriz enviada ao Siconfi: mensal ou agregada (MSCC) ou de encerramento do exercício (MSCE). classeConta = 56 # Integer | CClasse de contas contábeis que recebem lançamentos de natureza de controle. idTv = idTv_example # String | Os valores detalhados em uma MSC podem ser de três tipos: saldo incial (beginning_balance), saldo final (ending_balance) ou movimento (period_change). try: # Detalhamento dos registros informados nas contas contábeis que recebem lançamentos de natureza de controle. api_response = api_instance.msc_controle_get(idEnte, anReferencia, meReferencia, coTipoMatriz, classeConta, idTv) pprint(api_response) except ApiException as e: print("Exception when calling MSCControleApi->mscControleGet: %s\n" % e) ``` -------------------------------- ### Get RREO Data (Perl) Source: https://apidatalake.tesouro.gov.br/docs/siconfi Fetch RREO data using the Perl client. This example demonstrates basic API call structure and error handling. ```perl use Data::Dumper; use WWW::SwaggerClient::Configuration; use WWW::SwaggerClient::RREOApi; my $api_instance = WWW::SwaggerClient::RREOApi->new(); my $anExercicio = 789; # Long | Exercício do relatório. my $nrPeriodo = 56; # Integer | Bimestre de referência do relatório dentro de um exercício. my $coTipoDemonstrativo = coTipoDemonstrativo_example; # String | Tipo do Demonstrativo. RREO Simplificado aplica-se apenas aos municípios com menos de 50 mil habitantes que optaram pela publicação simplificada. my $idEnte = 56; # Integer | Código IBGE do Ente. my $noAnexo = noAnexo_example; # String | Os diversos demonstrativos do RREO são agrupados em anexos. my $coEsfera = coEsfera_example; # String | Filtro de esfera M = Municípios, E = Estados e DF, U = União e C = Consórcio eval { my $result = $api_instance->rreoGet(anExercicio => $anExercicio, nrPeriodo => $nrPeriodo, coTipoDemonstrativo => $coTipoDemonstrativo, idEnte => $idEnte, noAnexo => $noAnexo, coEsfera => $coEsfera); print Dumper($result); }; if ($@) { warn "Exception when calling RREOApi->rreoGet: $@\n"; } ``` -------------------------------- ### C#: Call mscOrcamentariaGet Source: https://apidatalake.tesouro.gov.br/docs/siconfi This C# example demonstrates how to call the mscOrcamentariaGet method. It includes error handling and requires the Swagger client library. ```csharp using System; using System.Diagnostics; using IO.Swagger.Api; using IO.Swagger.Client; using IO.Swagger.Model; namespace Example { public class mscOrcamentariaGetExample { public void main() { var apiInstance = new MSCOramentriaApi(); var idEnte = 56; // Integer | Código IBGE do Ente. var anReferencia = 789; // Long | Exercício de referência da matriz. var meReferencia = 789; // Long | Mês de referência da matriz. var coTipoMatriz = coTipoMatriz_example; // String | Tipo de matriz enviada ao Siconfi: mensal ou agregada (MSCC) ou de encerramento do exercício (MSCE). var classeConta = 56; // Integer | Classe de contas contábeis que recebem lançamentos de natureza orçamentária. var idTv = idTv_example; // String | Os valores detalhados em uma MSC podem ser de três tipos: saldo incial (beginning_balance), saldo final (ending_balance) ou movimento (period_change). try { // Detalhamento dos registros informados nas contas contábeis que recebem lançamentos de natureza orçamentária. MSC-Orcamentaria result = apiInstance.mscOrcamentariaGet(idEnte, anReferencia, meReferencia, coTipoMatriz, classeConta, idTv); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling MSCOramentriaApi.mscOrcamentariaGet: " + e.Message ); } } } } ``` -------------------------------- ### JavaScript: Call mscControleGet Source: https://apidatalake.tesouro.gov.br/docs/siconfi Example of calling the mscControleGet API method using JavaScript. Includes a callback function to handle the response or errors. ```javascript var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.mscControleGet(idEnte, anReferencia, meReferencia, coTipoMatriz, classeConta, idTv, callback); ``` -------------------------------- ### Get DCA Data - PHP Source: https://apidatalake.tesouro.gov.br/docs/siconfi Fetches DCA data using the DCAApi in PHP. Includes setup for the API client and exception handling. ```php dcaGet($anExercicio, $idEnte, $noAnexo); print_r($result); } catch (Exception $e) { echo 'Exception when calling DCAApi->dcaGet: ', $e->getMessage(), PHP_EOL; } ?> ``` -------------------------------- ### Initialize Siconfi API Client with JavaScript SDK Source: https://apidatalake.tesouro.gov.br/docs/siconfi This JavaScript code snippet shows how to initialize the Siconfi API client and set up parameters for retrieving budgetary data. It requires the 'siconfi_api' package. ```javascript var SiconfiApi = require('siconfi_api'); var api = new SiconfiApi.MSCOramentriaApi() var idEnte = 56; // {Integer} Código IBGE do Ente. var anReferencia = 789; // {Long} Exercício de referência da matriz. var meReferencia = 789; // {Long} Mês de referência da matriz. var coTipoMatriz = coTipoMatriz_example; // {String} Tipo de matriz enviada ao Siconfi: mensal ou agregada (MSCC) ou de encerramento do exercício (MSCE). var classeConta = 56; // {Integer} Classe de contas contábeis que recebem lançamentos de natureza orçamentária. ``` -------------------------------- ### Get DCA Data - Python Source: https://apidatalake.tesouro.gov.br/docs/siconfi Fetches DCA data using the DCAApi in Python. Includes API client setup and exception handling for API calls. ```python from __future__ import print_statement import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = swagger_client.DCAApi() anExercicio = 789 # Long | Exercício do relatório. idEnte = 56 # Integer | Código IBGE do Ente. noAnexo = noAnexo_example # String | Anexos do relatório. ATENÇÃO: As contas do exercício de 2013 foram entregues em dois formatos: QDCC para entes que não haviam aderido ao PCASP e DCA para todos os demais. Assim apenas os anexos que possuem o prefixo DCA são referentes a esse relatório, os demais anexos referem-se aos dados do QDCC de 2013. (optional) try: # Lista dos dados contidos nos quadros das contas anuais api_response = api_instance.dca_get(anExercicio, idEnte, noAnexo=noAnexo) pprint(api_response) except ApiException as e: print("Exception when calling DCAApi->dcaGet: %s\n" % e) ``` -------------------------------- ### Fetch Federal Entities using Java SDK Source: https://apidatalake.tesouro.gov.br/docs/siconfi Example of how to retrieve federal entity information using the Java SDK. Ensure the SDK is properly configured. ```java import io.swagger.client.*; import io.swagger.client.auth.*; import io.swagger.client.model.*; import io.swagger.client.api.EntesApi; import java.io.File; import java.util.*; public class EntesApiExample { public static void main(String[] args) { EntesApi apiInstance = new EntesApi(); try { Entes result = apiInstance.entesGet(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling EntesApi#entesGet"); e.printStackTrace(); } } } ``` ```java import io.swagger.client.api.EntesApi; public class EntesApiExample { public static void main(String[] args) { EntesApi apiInstance = new EntesApi(); try { Entes result = apiInstance.entesGet(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling EntesApi#entesGet"); e.printStackTrace(); } } } ``` -------------------------------- ### GET /rreo Source: https://apidatalake.tesouro.gov.br/docs/siconfi Retrieves the list of data contained in the RREO annexes. ```APIDOC ## GET /rreo ### Description Retrieves the list of data contained in the RREO annexes based on the provided filters. ### Method GET ### Endpoint https://apidatalake.tesouro.gov.br/ords/siconfi/tt//rreo ### Parameters #### Query Parameters - **an_exercicio** (Long) - Required - Exercício do relatório. - **nr_periodo** (Integer) - Required - Bimestre de referência do relatório dentro de um exercício. - **co_tipo_demonstrativo** (String) - Required - Tipo do Demonstrativo. RREO Simplificado aplica-se apenas aos municípios com menos de 50 mil habitantes que optaram pela publicação simplificada. - **id_ente** (Integer) - Required - Código IBGE do Ente. - **no_anexo** (String) - Optional - Os diversos demonstrativos do RREO são agrupados em anexos. - **co_esfera** (String) - Optional - Filtro de esfera M = Municípios, E = Estados e DF, U = União e C = Consórcio ### Request Example curl -X GET "https://apidatalake.tesouro.gov.br/ords/siconfi/tt//rreo?an_exercicio=2023&nr_periodo=1&co_tipo_demonstrativo=RREO&id_ente=110001" ``` -------------------------------- ### Python: Import Swagger Client Source: https://apidatalake.tesouro.gov.br/docs/siconfi This Python snippet shows the necessary imports for using the Swagger client library to interact with the Siconfi API. ```python from __future__ import print_statement import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint ``` -------------------------------- ### GET /rgf Source: https://apidatalake.tesouro.gov.br/docs/siconfi Retrieves RGF reports based on specified parameters. ```APIDOC ## GET /rgf ### Description Retrieves RGF reports based on specified parameters such as exercise, periodicity, period, demonstrative type, power, entity, annex, and sphere. ### Method GET ### Endpoint /rgf ### Parameters #### Query Parameters - **anExercicio** (Long) - Required - Exercise of the report. - **inPeriodicidade** (String) - Optional - Periodicity of the report publication (S = Semestral, Q = quadrimestral). Semestral periodicity applies only to municipalities with less than 50,000 inhabitants who opted for simplified publication. The default periodicity is quadrimestral. - **nrPeriodo** (Integer) - Optional - Quarter or semester of reference for the report within an exercise. Semestral periodicity applies only to municipalities with less than 50,000 inhabitants who opted for simplified publication. The default periodicity is quadrimestral. - **coTipoDemonstrativo** (String) - Optional - Type of Demonstrative. RGF Simplificado applies only to municipalities with less than 50,000 inhabitants who opted for semestral publication of reports. - **coPoder** (String) - Optional - Power code (E = Executive, L = Legislative, J = Judiciary, M = Public Ministry, D = Public Defender). - **idEnte** (Integer) - Optional - IBGE code of the Entity. - **noAnexo** (String) - Optional - The various RGF demonstratives are grouped into annexes. - **coEsfera** (String) - Optional - Sphere filter (M = Municipalities, E = States and DF, U = Union, C = Consortium) ### Response #### Success Response (200) - **result** (Object) - The RGF report data. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### GET /websites/apidatalake_tesouro_gov_br_siconfi Source: https://apidatalake.tesouro.gov.br/docs/siconfi Retrieve financial data based on specified query parameters. ```APIDOC ## GET /websites/apidatalake_tesouro_gov_br_siconfi ### Description This endpoint retrieves financial data, such as RREO reports, from the Siconfi system. It allows filtering by various parameters including the fiscal year, reporting period, type of demonstration, and the specific government entity. ### Method GET ### Endpoint /websites/apidatalake_tesouro_gov_br_siconfi ### Parameters #### Query Parameters - **an_exercicio** (Long/int64) - Required - Fiscal year of the report. - **nr_periodo** (Integer) - Required - Reporting period (e.g., bimestre) within a fiscal year. - **co_tipo_demonstrativo** (String) - Required - Type of demonstration. 'RREO Simplificado' is applicable only to municipalities with less than 50,000 inhabitants who opted for simplified publication. - **no_anexo** (String) - Optional - Annex of the RREO report. - **co_esfera** (String) - Optional - Sphere filter: M = Municipalities, E = States and DF, U = Union, C = Consortium. - **id_ente** (Integer) - Required - IBGE code of the entity. ### Response #### Success Response (200) - **exercicio** (integer/int64) - Year of data reference. - **demonstrativo** (string) - Type of report submitted. Enum: `RREO`, `RREO Simplificado`. - **periodo** (integer/int64) - Reporting period of the data. - **periodicidade** (string) - Data periodicity. Always 'B' for bimonthly, even for 'RREO Simplificado'. - **instituicao** (string) - Institution responsible for data submission and publication. - **cod_ibge** (integer/int64) - IBGE code of the Federation entity. - **uf** (string) - Federation unit the municipality belongs to. Enum: `AC`, `AL`, `AM`, `AP`, `BA`, `CE`, `DF`, `ES`, `GO`, `MA`, `MG`, `MS`, `MT`, `PA`, `PB`, `PE`, `PI`, `PR`, `RJ`, `RN`, `RO`, `RR`, `RS`, `SC`, `SE`, `SP`, `TO`. - **populacao** (integer/int64) - Estimated number of inhabitants for the data reference year. - **anexo** (string) - Annex of the Demonstration. - **rotulo** (string) - Data table identifier within the annex (if multiple exist). - **coluna** (string) - Column of the table the value refers to. - **cod_conta** (string) - Textual coding of the table row the value refers to. Used to avoid confusion with different rows having the same label. - **conta** (string) - Label of the table row the value refers to. - **valor** (number/float) - Monetary value reference. #### Response Example ```json { "exercicio": 2014, "demonstrativo": "RREO Simplificado", "periodo": 6, "periodicidade": "B", "instituicao": "Governo do Estado de Rondônia", "cod_ibge": 1718659, "uf": "TO", "populacao": 1728214, "anexo": "RREO-Anexo 01", "rotulo": "Padrão", "coluna": "PREVISÃO INICIAL", "cod_conta": "ReceitasExcetoIntraOrcamentarias", "conta": "RECEITAS (EXCETO INTRA-ORÇAMENTÁRIAS) (I)", "valor": 3.97138269383E9 } ``` ``` -------------------------------- ### Fetch DCA Data with JavaScript SDK Source: https://apidatalake.tesouro.gov.br/docs/siconfi Example using the JavaScript SDK to fetch DCA data. It shows how to instantiate the API client and call the `dcaGet` method with optional parameters. ```javascript var SiconfiApi = require('siconfi_api'); var api = new SiconfiApi.DCAApi() var anExercicio = 789; // {Long} Exercício do relatório. var idEnte = 56; // {Integer} Código IBGE do Ente. var opts = { 'noAnexo': 'noAnexo_example' // {String} Anexos do relatório. ATENÇÃO: As contas do exercício de 2013 foram entregues em dois formatos: QDCC para entes que não haviam aderido ao PCASP e DCA para todos os demais. Assim apenas os anexos que possuem o prefixo DCA são referentes a esse relatório, os demais anexos referem-se aos dados do QDCC de 2013. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.dcaGet(anExercicio, idEnte, opts, callback); ``` -------------------------------- ### Retrieve Budgetary Data - Python Source: https://apidatalake.tesouro.gov.br/docs/siconfi Fetches detailed records for budgetary accounts. Ensure all required parameters such as idEnte, anReferencia, meReferencia, coTipoMatriz, classeConta, and idTv are correctly provided. ```python api_instance = swagger_client.MSCOramentriaApi() idEnte = 56 # Integer | Código IBGE do Ente. anReferencia = 789 # Long | Exercício de referência da matriz. meReferencia = 789 # Long | Mês de referência da matriz. coTipoMatriz = coTipoMatriz_example # String | Tipo de matriz enviada ao Siconfi: mensal ou agregada (MSCC) ou de encerramento do exercício (MSCE). classeConta = 56 # Integer | Classe de contas contábeis que recebem lançamentos de natureza orçamentária. idTv = idTv_example # String | Os valores detalhados em uma MSC podem ser de três tipos: saldo incial (beginning_balance), saldo final (ending_balance) ou movimento (period_change). try: # Detalhamento dos registros informados nas contas contábeis que recebem lançamentos de natureza orçamentária. api_response = api_instance.msc_orcamentaria_get(idEnte, anReferencia, meReferencia, coTipoMatriz, classeConta, idTv) pprint(api_response) except ApiException as e: print("Exception when calling MSCOramentriaApi->mscOrcamentariaGet: %s\n" % e) ``` -------------------------------- ### Fetch Federal Entities using Python Source: https://apidatalake.tesouro.gov.br/docs/siconfi Python example for fetching federal entity data. This snippet demonstrates API instantiation, making the call, and handling potential API exceptions. ```python from __future__ import print_statement import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = swagger_client.EntesApi() try: # Informações básicas dos entes da federação. api_response = api_instance.entes_get() pprint(api_response) except ApiException as e: print("Exception when calling EntesApi->entesGet: %s\n" % e) ``` -------------------------------- ### GET /rgf Source: https://apidatalake.tesouro.gov.br/docs/siconfi Retrieves data contained in the annexes of the RGF (Relatório de Gestão Fiscal). ```APIDOC ## GET /rgf ### Description Retrieves data contained in the annexes of the RGF (Relatório de Gestão Fiscal). ### Method GET ### Endpoint /rgf ### Parameters #### Query Parameters - **an_exercicio** (Long) - Required - Exercício do relatório. - **in_periodicidade** (String) - Required - Periodicidade de publicação do relatório S = Semestral ou Q = quadrimestral. A periodicidade semestral aplica-se apenas aos municípios com menos de 50 mil habitantes que optaram pela publicação simplificada. A periodicidade padrão do relatório é quadrimestral. - **nr_periodo** (Integer) - Required - Quadrimestre ou semestre de referência do relatório dentro de um exercício. A periodicidade semestral aplica-se apenas aos municípios com menos de 50 mil habitantes que optaram pela publicação simplificada. A periodicidade padrão do relatório é quadrimestral. - **co_tipo_demonstrativo** (String) - Required - Tipo do Demonstrativo. RGF Simplificado aplica-se apenas aos municípios com menos de 50 mil habitantes que optaram pela publicação semestral dos relatórios. - **co_poder** (String) - Required - Código do poder E = Executivo, L = Legislativo, J = Judiciário, M = Ministério Público, D = Defensoria Pública - **id_ente** (Integer) - Required - Código IBGE do Ente. - **no_anexo** (String) - Optional - Os diversos demonstrativos do RGF são agrupados em anexos. - **co_esfera** (String) - Optional - Filtro de esfera M = Municípios, E = Estados e DF, U = União e C = Consórcio ### Response #### Success Response (200) - **exercicio** (integer) - Ano de referência dos dados - **periodo** (integer) - Quadrimestre ou semestre de referência dos dados - **periodicidade** (string) - Indica periodicidade dos dados onde Q = quadrimestral ou S = semestral. Este último aplica-se apenas ao RGF Simplificado. - **instituicao** (string) - Orgão responsável pelo envio e publicação dos dados - **cod_ibge** (integer) - Código IBGE do Ente da Federação ao qual pertence a instituição - **uf** (string) - Unidade da federação à qual pertence o município - **co_poder** (string) - Respectivo poder ao qual pertence a instituição E = executivo, L = legislativo, etc. - **populacao** (integer) - Estimativa da quantidade de habitantes para o exercício de referência dos dados - **anexo** (string) - Anexo do Demonstrativo - **rotulo** (string) - Identificador da tabela de dados do anexo (quando houver mais de uma) - **coluna** (string) - Coluna do quadro a que se refere o valor - **cod_conta** (string) - Codificação textual da linha do quadro a que se refere o valor. Serve para evitar confusão linhas diferentes que possuem mesmo rótulo. - **conta** (string) - Rótulo da linha do quadro a que se refere o valor - **valor** (float) - Valor monetário de referência #### Response Example { "exercicio": 2014, "periodo": 2, "periodicidade": "Q", "instituicao": "Governo do Estado de Rondônia", "cod_ibge": 1718659, "uf": "TO", "co_poder": "E", "populacao": 1728214, "anexo": "RGF-Anexo 01", "rotulo": "Padrão", "coluna": "", "cod_conta": "DespesaComPessoalBruta", "conta": "DESPESA BRUTA COM PESSOAL (I)", "valor": 3.97138269383E9 } ``` -------------------------------- ### Initialize MSCControleApi with JavaScript SDK Source: https://apidatalake.tesouro.gov.br/docs/siconfi This JavaScript code initializes the MSCControleApi from the Siconfi SDK. It demonstrates how to set up parameters for retrieving MSC control data. ```javascript var SiconfiApi = require('siconfi_api'); var api = new SiconfiApi.MSCControleApi() var idEnte = 56; // {Integer} Código IBGE do Ente. var anReferencia = 789; // {Long} Exercício de referência da matriz. var meReferencia = 789; // {Long} Mês de referência da matriz. var coTipoMatriz = coTipoMatriz_example; // {String} Tipo de matriz enviada ao Siconfi: mensal ou agregada (MSCC) ou de encerramento do exercício (MSCE). var classeConta = 56; // {Integer} CClasse de contas contábeis que recebem lançamentos de natureza de controle. var idTv = idTv_example; // {String} Os valores detalhados em uma MSC podem ser de três tipos: saldo incial (beginning_balance), saldo final (ending_balance) ou movimento (period_change). ``` -------------------------------- ### GET /msc_patrimonial Source: https://apidatalake.tesouro.gov.br/docs/siconfi Retrieves detailed records from patrimonial accounts that receive entries of an accounting nature. ```APIDOC ## GET /msc_patrimonial ### Description Detalhamento dos registros informados nas contas contábeis que recebem lançamentos de natureza patrimonial. Refere-se às contas contábeis de ativos (classe 1), passivos (classe 2), variações patrimoniais diminutivas (classe 3) e variações patrimoniais aumentativas (classe 4) bem como suas respectivas informações complementares. Todos os filtros são obrigatórios. ### Method GET ### Endpoint /msc_patrimonial ### Parameters #### Query Parameters - **id_ente** (Integer) - Required - Código IBGE do Ente. - **an_referencia** (Long) - Required - Exercício de referência da matriz. - **me_referencia** (Long) - Required - Mês de referência da matriz. - **co_tipo_matriz** (String) - Required - Tipo de matriz enviada ao Siconfi: mensal ou agregada (MSCC) ou de encerramento do exercício (MSCE). - **classe_conta** (Integer) - Required - Classe de contas contábeis que recebem lançamentos de natureza patrimonial. - **id_tv** (String) - Required - Os valores detalhados em uma MSC podem ser de três tipos: saldo incial (beginning_balance), saldo final (ending_balance) ou movimento (period_change). ### Response #### Success Response (200) - **tipo_matriz** (string) - Indica o tipo de matriz a que se referem os dados MSCC - matriz agregada mensal MSCE - matriz de encerramento anual. Enum: `MSCC`, `MSCE`. - **cod_ibge** (integer (int64)) - Código IBGE do Ente da Federação ao qual pertence a instituição. - **classe_conta** (integer (int64)) - Primeiro dígito da conta contábil que indica sua respectiva classe. Enum: `1`, `2`, `3`, `4`. - **conta_contabil** (string) - Código de conta contábil conforme definido no PCASP estendido. - **poder_orgao** (integer (int64)) - Atributo que indica a codificação do poder/órgão. - **ano_fonte_recursos** (integer (int64)) - Primeiro dígito da informação complementar FR que indica o exercício corrente ou anterior dos recursos. Onde 1 = Recursos do Exercício Corrente, 2 = Recursos de Exercícios Anteriores. Enum: `1`, `2`. - **fonte_recursos** (string) - Demais dígitos da informação complementar FR que detalha o atributo. - **funcao** (string) - Classificação da despesa por função. - **subfuncao** (string) - Classificação da despesa por subfunção. - **exercicio** (integer (int64)) - Ano de referência dos dados. - **mes_referencia** (integer (int64)) - Mês de referência dos dados. - **educacao_saude** (integer (int64)) - Identifica se as despesas serão consideradas para cômputo do limite da educação e da saúde. Onde 1 - compõe MDE e 2 - compõe ASPS. Enum: `1`, `2`. - **data_referencia** (string (date-time)) - Data de referência dos dados. Para matrizes entregues mensalmente a data indica o último dia do mês de referência. - **entrada_msc** (integer (int64)) - Identificador da entrada da MSC onde o registro se encontra. Permite identificar o registro no arquivo enviado. - **natureza_despesa** (string) - Natureza da despesa detalhada. - **ano_inscricao** (integer (int64)) - Atributo que indica o ano de inscrição de restos a pagar. - **natureza_receita** (string) - Natureza da receita detalhada. - **valor** (integer (float)) - Valor monetário de referência. - **natureza_conta** (string) - Indica se o valor monetário exibido possui natureza credora ou devedora. Enum: `D`, `C`. - **tipo_valor** (string) - Indicador do tipo de valor da entrada da MSC, onde beginning_balance = saldo inicial, ending_balance = saldo final e period_change = movimento. Enum: `beginning_balance`, `ending_balance`, `period_change`. #### Response Example ```json { "tipo_matriz": "MSCC", "cod_ibge": 1718659, "classe_conta": 1, "conta_contabil": "111100000", "poder_orgao": 10121, "ano_fonte_recursos": 1, "fonte_recursos": "0010000", "funcao": "03", "subfuncao": "122", "exercicio": 2014, "mes_referencia": 4, "educacao_saude": 1, "data_referencia": "2019-04-30T00:00:00Z", "entrada_msc": 10, "natureza_despesa": "31901100", "ano_inscricao": 2018, "natureza_receita": "11130211", "valor": 1.5E9, "natureza_conta": "C", "tipo_valor": "beginning_balance" } ``` ``` -------------------------------- ### Retrieve RGF Data with Python Source: https://apidatalake.tesouro.gov.br/docs/siconfi Initializes the RGFApi client and executes a request to fetch RGF annex data, handling potential API exceptions. ```python # create an instance of the API class api_instance = swagger_client.RGFApi() anExercicio = 789 # Long | Exercício do relatório. inPeriodicidade = inPeriodicidade_example # String | Periodicidade de publicação do relatório S = Semestral ou Q = quadrimestral. A periodicidade semestral aplica-se apenas aos municípios com menos de 50 mil habitantes que optaram pela publicação simplificada. A periodicidade padrão do relatório é quadrimestral. nrPeriodo = 56 # Integer | Quadrimestre ou semestre de referência do relatório dentro de um exercício. A periodicidade semestral aplica-se apenas aos municípios com menos de 50 mil habitantes que optaram pela publicação simplificada. A periodicidade padrão do relatório é quadrimestral. coTipoDemonstrativo = coTipoDemonstrativo_example # String | Tipo do Demonstrativo. RGF Simplificado aplica-se apenas aos municípios com menos de 50 mil habitantes que optaram pela publicação semestral dos relatórios. coPoder = coPoder_example # String | Código do poder E = Executivo, L = Legislativo, J = Judiciário, M = Ministério Público, D = Defensoria Pública idEnte = 56 # Integer | Código IBGE do Ente. noAnexo = noAnexo_example # String | Os diversos demonstrativos do RGF são agrupados em anexos. (optional) coEsfera = coEsfera_example # String | Filtro de esfera M = Municípios, E = Estados e DF, U = União e C = Consórcio (optional) try: # Lista dos dados contidos nos anexos do RGF. api_response = api_instance.rgf_get(anExercicio, inPeriodicidade, nrPeriodo, coTipoDemonstrativo, coPoder, idEnte, noAnexo=noAnexo, coEsfera=coEsfera) pprint(api_response) except ApiException as e: print("Exception when calling RGFApi->rgfGet: %s\n" % e) ```