API / Consulta Avançada de Despesas

Consulta Avançada

Esta consulta é totalmente aberta para a customização de campos e filtros a serem utilizados. A partir dela, podem ser montadas diversas consultas cruzando informações de Despesas e especificando as colunas que devem ser exibidas. O retorno depende dos parâmetros que serão utilizados.

 

URL

/despesa/json-despesa-avancada-filtro/

 

MÉTODO

GET

 

PARÂMETROS

Obrigatórios

Nome Tipo Descrição Valores
limit integer Seta um limite de resultados apresentados na consulta. 1 a 1000
offset integer Seta a quantidade de valores que será ignorada no início dos resultados. Apresentada o próximo valor após o offset. -
data_registro_dti_ Date Seta a data inicial que será realizada a consulta. (dd/mm/yyyy) -
data_registro_dtf_ Date Seta a data final que será realizada a consulta. (dd/mm/yyyy) -
visualizar * text Define quais colunas serão exibidas. Pode ser vários. ex: visualizar=descricao_ug&visualizar=ano orgao_descricao, descricao_ug, ug, pt_funcao_id__descricao_funcao, sub_funcao_id__descricao_sub_funcao, programa_id__programa_descricao, projeto_atividade_id__projeto_descricao, fonte_mae_id__descricao_fonte_mae, fonte_id__descricao_fonte, descricao_subtitulo, descricao_natureza2, descricao_natureza3, descricao_natureza5, descricao_natureza6, descricao_natureza, ano, mes
valor text Define quais valores serão exibidos. Pode ser vários. ex: valor=empenhado&valor=pago empenhado, liquidado, pago

 

Opcionais

Nome Tipo Descrição
orgao__in text Filtra pelo código do órgão entre as retornadas na consulta.
ug__in text Filtra pelo código da unidade gestora entre as retornadas na consulta.
pt_funcao_id__funcao__in text Filtra pelo código da função entre as retornadas na consulta.
sub_funcao_id__sub_funcao__in text Filtra pelo código da subfunção entre as retornadas na consulta.
programa_id__programa__in text Filtra pelo código do programa entre as retornadas na consulta.
projeto_atividade_id__projeto__in text Filtra pelo código da ação entre as retornadas na consulta.
fonte_mae_id__fonte_mae__in text Filtra pelo código da fonte mãe entre as retornadas na consulta.
fonte_id__fonte__in text Filtra pelo código da fonte entre as retornadas na consulta.
subtitulo__in text Filtra pelo código do subtítulo entre as retornadas na consulta.
descricao_natureza2__in  text Filtra pelo nome da categoria econômica entre as retornadas na consulta.
descricao_natureza3__in  text Filtra pelo nome da origem entre as retornadas na consulta.
descricao_natureza5__in  text Filtra pelo nome da rubrica entre as retornadas na consulta.
descricao_natureza6__in  text Filtra pelo nome do alínea entre as retornadas na consulta.
descricao_natureza__in text Filtra pelo nome do subalínea entre as retornadas na consulta.
sort text Define o campo o qual será ordenada a consulta.
order text Define a ordem que será ordenada a consulta. Valores: asc / desc

* Os parâmetros com __in no final podem ter mais de um valor associado. Exemplo: /?ug__in=64647&ug__in=92782

 

EXEMPLO

URL utilizada: http://transparencia.al.gov.br/despesa/json-despesa-avancada-filtro/?data_registro_dti_=01/01/2013&data_registro_dtf_=31/12/2015&visualizar=ano&visualizar=descricao_ug&limit=3&offset=0&valor=empenhado&valor=pago

 

{
  "total": 229,
  "titulo": "Despesas - Consulta Avançada",
  "detalhe": {
    "valor_empenhado__sum": "13.805.193,89",
    "valor_pago__sum": "13.510.213,16",
    "valor_pago_total": "21.444.327.005,47",
    "valor_liquidado__sum": "13.661.243,96",
    "descricao_ug": "GABINETE CIVIL",
    "ano": 2013,
    "valor_empenhado_total": "23.276.183.209,04",
    "valor_liquidado_total": "22.600.148.963,61"
  },
  "rows": [
    {
      "valor_pago": "20.090.436,10",
      "descricao_ug": "AG DE MODERNIZACAO DA GESTAO DE PROCESSOS",
      "ano": 2013,
      "valor_empenhado": "21.797.406,96"
    },
    {
      "valor_pago": "10.336.919,20",
      "descricao_ug": "AGENC.DE DEFESA E INSPECAO AGROPECUARIA DE AL",
      "ano": 2013,
      "valor_empenhado": "10.350.241,03"
    },
    {
      "valor_pago": "3.315.065,11",
      "descricao_ug": "AGENCIA DE FOMENTO DE ALAGOAS",
      "ano": 2013,
      "valor_empenhado": "3.365.959,74"
    }
  ]
}
TENHA ACESSO ÀS INFORMAÇÕES ATRAVÉS DE DADOS ABERTOS
2007-2016. Conteúdo e dados do Portal da Transparência licenciados sob Licença Creative Commons Licença Creative Commons BY-SA Open Data