¶ ¶ Endpoint: Receitas (GET /api/v1/receitas)
Este endpoint da API Públicas - CGE permite consultar receitas 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/receitas - Parâmetros: enviados via query
- Paginação: obrigatória
- Retorno: JSON com lista de receitas
¶ Exemplo de requisição
https://transparencia.api.ro.gov.br/api/v1/receitas?page=1&pageSize=10
Exemplo com filtros:
https://transparencia.api.ro.gov.br/api/v1/receitas?DataInicial=2024-01-01&DataFinal=2024-12-31&CodigoUg=0101&page=1&pageSize=10
¶ Parâmetros de consulta
| Parâmetro | Tipo | Descrição | Exemplo |
|---|---|---|---|
| DataInicial | date | Data inicial da receita. | 2024-01-01 |
| DataFinal | date | Data final da receita. | 2024-12-31 |
| CodigoUg | int | Código da unidade gestora. | 101 |
| CodigoFonte | int | Código da fonte de recurso. | 100 |
| CodigoCategoriaEconomica | int | Categoria econômica. | 1 |
| CodigoOrigem | int | Origem da receita. | 1 |
| CodigoEspecie | int | Espécie da receita. | 1 |
| CodigoNatureza | int | Natureza da receita. | 111101 |
| OrderBy | string | Ordenação dos resultados. | CodigoUg desc |
| Buscar | string | Busca textual. | ICMS |
| 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 receitas
O retorno pode ser utilizado para integração com sistemas, dashboards e análises institucionais.