¶ ¶ Endpoint: Despesas (GET /api/v1/despesas)
Este endpoint da API Públicas - CGE permite consultar despesas públicas registradas no Portal da Transparência. A operação é do tipo GET, utilizada apenas para leitura de dados. O retorno é em formato JSON e pode ser consumido por sistemas, dashboards e integrações institucionais.
¶ Como funciona
- Método: GET
- Rota:
/api/v1/despesas - Parâmetros: enviados via query
- Paginação: obrigatória
- Retorno: JSON com lista de despesas
¶ Exemplo de requisição
https://transparencia.api.ro.gov.br/api/v1/despesas?page=1&pageSize=10
Exemplo com filtro por período:
https://transparencia.api.ro.gov.br/api/v1/despesas?DataInicial=2024-01-01&DataFinal=2024-12-31&page=1&pageSize=10
¶ Parâmetros de consulta
| Parâmetro | Tipo | Descrição | Exemplo |
|---|---|---|---|
| DataInicial | date | Data inicial da despesa. | 2024-01-01 |
| DataFinal | date | Data final da despesa. | 2024-12-31 |
| CodigoUg | string | Código da unidade gestora. | 0101 |
| CodigoFuncao | string | Código da função. | 12 |
| CodigoSubFuncao | string | Código da subfunção. | 361 |
| CodigoPrograma | string | Código do programa. | 2001 |
| CodigoFonteRecurso | string | Fonte do recurso. | 0100 |
| CodigoAcao | string | Código da ação. | 2045 |
| CodigoCategoriaEconomica | string | Categoria econômica. | 3 |
| CodigoGrupoNaturezaDespesa | string | Grupo da despesa. | 33 |
| CodigoModalidadeAplicacao | string | Modalidade de aplicação. | 90 |
| CodigoElementoDespesa | string | Elemento da despesa. | 30 |
| OrderBy | string | Ordenação dos resultados. | data |
| page | int | Página. | 1 |
| pageSize | int | Quantidade por página. | 10 |
¶ Onde visualizar o retorno
Após preencher os parâmetros no Swagger e clicar em Try it out → Execute, a resposta será exibida logo abaixo do endpoint.
- URL da requisição
- Status da resposta
- JSON retornado
- Dados de paginação
- Lista de despesas
O retorno pode ser utilizado para integração com sistemas, dashboards e análises institucionais.
¶ ¶ Endpoint: Dotação Inicial (GET /api/v1/despesas/dotacao-inicial)
Este endpoint permite consultar a dotação inicial orçamentária por exercício e unidade gestora no Portal da Transparência. A requisição é do tipo GET e o retorno é em JSON.
¶ Como funciona
- Método: GET
- Rota:
/api/v1/despesas/dotacao-inicial - Paginação: obrigatória
- Retorno: dados orçamentários em JSON
¶ Exemplo de requisição
https://transparencia.api.ro.gov.br/api/v1/despesas/dotacao-inicial?Exercicio=2024&page=1&pageSize=10
https://transparencia.api.ro.gov.br/api/v1/despesas/dotacao-inicial?Exercicio=2024&CodigoUg=01001&page=1&pageSize=10
¶ Parâmetros
| Parâmetro | Tipo | Descrição | Exemplo |
|---|---|---|---|
| Exercicio | int | Ano do exercício orçamentário. | 2024 |
| CodigoUg | string | Código da unidade gestora. | 01001 |
| CodigoNatureza | string | Código da natureza da despesa. | 339030 |
| OrderBy | string | Ordenação dos resultados. | Ano desc |
| page | int | Página da consulta. | 1 |
| pageSize | int | Registros por página. | 10 |
¶ Retorno da API
A resposta contém informações de paginação e a lista de dotações iniciais.
{
"pagina": 1,
"registrosPorPagina": 10,
"totalElementos": 200,
"totalDePaginas": 20,
"ultimaPagina": false,
"resultados": [
{
"codigoUg": "01001",
"nomeUg": "Secretaria X",
"programaTrabalho": "123456",
"codigoNatureza": "339030",
"descricaoNatureza": "Material de Consumo",
"exercicio": 2024,
"dotacaoInicial": 500000
}
]
}
¶ Onde visualizar o retorno
No Swagger, após clicar em Try it out e depois em Execute, o retorno aparece logo abaixo do endpoint.
- URL executada
- Status da requisição
- JSON retornado
- Dados paginados
Os dados podem ser utilizados em dashboards, auditorias e integrações institucionais.