Todas as respostas são retornadas em JSON com codificação UTF-8. O cabeçalho Content-Type: application/json está sempre presente.
Retorna a lista paginada de obras e serviços de engenharia. Todos os parâmetros são opcionais e podem ser combinados.
| Parâmetro | Tipo | Obrigatoriedade | Descrição | Exemplo |
|---|---|---|---|---|
ano |
integer | Opcional | Filtra obras pelo ano de início. | 2026 |
mes |
string (MM) | Opcional | Filtra obras pelo mês de início (com zero à esquerda). | 03 |
nome |
string | Opcional | Busca por palavra contida no nome/objeto da obra (busca parcial). | praça |
situacao |
string | Opcional | Filtra pela situação: Em andamento ou Concluída. |
Em andamento |
dt_inicio_filtro |
date (YYYY-MM-DD) | Opcional | Data inicial do período de início da obra. Usar em conjunto com dt_fim_filtro. |
2026-01-01 |
dt_fim_filtro |
date (YYYY-MM-DD) | Opcional | Data final do período de início da obra. Usar em conjunto com dt_inicio_filtro. |
2026-06-30 |
page |
integer | Opcional | Número da página (padrão: 1). |
2 |
porPagina |
integer | Opcional | Quantidade de registros por página (padrão: 20, máximo: 100). |
10 |
Retorna os dados completos de uma obra específica, incluindo empenhos, liquidações e pagamentos vinculados.
| Parâmetro | Tipo | Obrigatoriedade | Descrição |
|---|---|---|---|
cd_obra |
integer | Obrigatório | Identificador único da obra (campo cd_obra retornado no endpoint de listagem). |
obra| Campo | Tipo | Descrição |
|---|---|---|
cd_obra | integer | Identificador único da obra. |
codigo | string | Código de referência da obra. |
nome | string | Objeto / nome da obra. |
dt_inicio | date | Data de início (YYYY-MM-DD). |
dt_fim | date | Data de término previsto (YYYY-MM-DD). |
prazo | integer | Prazo contratual em dias. |
valor | string | Valor contratado. |
liquidado | string | Total liquidado acumulado. |
responsavel | string | Empresa responsável pela execução. |
tipo_administracao | string | Tipo de administração (Direta / Indireta). |
empenho| Campo | Tipo | Descrição |
|---|---|---|
empenho | string | Número do documento de empenho. |
data | string | Data do empenho. |
credor | string | Nome do credor. |
cnpj | string | CNPJ do credor. |
modalidade | string | Modalidade de licitação. |
num_licitacao | string | Número da licitação. |
natureza_despesa | string | Natureza da despesa orçamentária. |
fonte_recurso | string | Fonte de recurso. |
valor | string | Valor empenhado. |
registro | string | Situação do registro (ex.: Realizado). |
liquidacao e pagamento| Campo | Tipo | Descrição |
|---|---|---|
documento | string | Número do documento. |
empenho | string | Número do empenho vinculado. |
data | string | Data da liquidação / pagamento. |
valor | string | Valor liquidado / pago. |
registro | string | Situação do registro. |