¶ ¶ Endpoint: Pagamento de Fornecedores (GET /api/v1/pagamento-fornecedor)
Este endpoint da API Públicas - CGE permite consultar pagamentos realizados a fornecedores registrados no Portal da Transparência. A operação é do tipo GET e retorna dados em formato JSON, podendo ser utilizada em sistemas, dashboards e integrações institucionais.
¶ Como funciona
- Método: GET
- Rota:
/api/v1/pagamento-fornecedor - Parâmetros: enviados via query
- Paginação: obrigatória
- Retorno: JSON com lista de pagamentos
¶ Exemplo de requisição
https://transparencia.api.ro.gov.br/api/v1/pagamento-fornecedor?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 do pagamento. | 2024-01-01 |
| DataFinal | date | Data final do pagamento. | 2024-12-31 |
| Credor | string | Nome do fornecedor/credor. | EMPRESA X |
| DocCredor | string | CPF ou CNPJ do fornecedor. | 12345678000199 |
| UnidadeGestora | string | Código da unidade gestora. | 0101 |
| OrderBy | string | Ordenação dos resultados. | Credor desc |
| Buscar | string | Busca textual geral. | energia |
| page | int | Página. | 1 |
| pageSize | int | Quantidade por página. | 10 |
¶ Onde visualizar o retorno
Após executar a requisição no Swagger, o retorno será exibido logo abaixo do endpoint, contendo o JSON com os pagamentos encontrados.
- URL da requisição
- Status HTTP
- Dados de paginação
- Lista de pagamentos
Os dados retornados podem ser utilizados em integrações, relatórios, auditorias e painéis institucionais.