fontezadocs
Ver todas as páginas

Listar despesas federais de uma empresa

GET/v1/empresas/{cnpj}/despesas-federaisX-Api-Key

Documentos de empenho, liquidação e pagamento nos arquivos diários publicados do Portal da Transparência. O escopo raiz inclui estabelecimentos com a mesma raiz e o escopo estabelecimento exige CNPJ exato; cada aparição conserva o CNPJ e o papel do favorecido. Fases e medidas monetárias permanecem separadas. Nenhum resultado quer dizer só que nada apareceu na janela de arquivos declarada em meta, não que a empresa nunca recebeu recursos federais. Não há chave PNCP oficial verificada neste contrato batch e nenhum vínculo é inferido. Exemplos ilustrativos; não representam conciliação oficial nem cobertura histórica completa.

Parâmetros

  • cnpjstring · caminhoobrigatório

    CNPJ normalizado do favorecido; 12 caracteres alfanuméricos e dois dígitos verificadores.

    Formato: ^[0-9A-Z]{12}[0-9]{2}$.

  • escopostring · query

    Raiz consulta CNPJs com os mesmos oito primeiros caracteres; estabelecimento exige CNPJ exato.

    Valores: raiz, estabelecimento. Padrão: "raiz".

  • fasestring · query

    Fase documental oficial; fases não são somadas entre si.

    Valores: empenho, liquidacao, pagamento.

  • data_destring (date) · query

    Primeira data de emissão, inclusive; não amplia a janela de arquivos publicada.

  • data_atestring (date) · query

    Última data de emissão, inclusive; não amplia a janela de arquivos publicada.

  • limitinteger · query

    Entre 1 e 100. Padrão: 20.

  • cursorstring · query

    Cursor opaco vinculado à geração, ao CNPJ, ao escopo e aos filtros.

Resposta

Página vinculada a uma única geração publicada e aos filtros da consulta.

  • itemsarray de objeto
    • fasestring

      Valores: empenho, liquidacao, pagamento.

    • codigo_documentostring

      Código SIAFI completo de 23 caracteres (UG, gestão e número do documento).

    • id_empenhostring | null
    • exerciciointeger
    • data_emissaostring (date)
    • tipo_documentoobjeto
      • codigostring | null
      • nomestring | null
    • favorecidoobjeto
      • cnpjstring
      • nomestring | null
      • papelstring

        Valores: direto, final.

    • orgaoobjeto
      • codigostring | null
      • nomestring | null
    • unidade_gestoraobjeto
      • codigostring | null
      • nomestring | null
      • codigo_gestaostring | null
      • gestaostring | null
    • processostring | null
    • observacaostring | null
    • valoresobjeto

      Medidas distintas preservadas por fase; não devem ser somadas entre si.

      • documento_brlstring | null
      • empenhos_impactados_brlstring | null
      • favorecido_final_brlstring | null
    • url_fontestring (uri)
    • vinculo_pncpobjeto

      O contrato batch verificado não contém chave PNCP; nenhuma ligação é inferida.

      • situacao"sem_chave_oficial"
      • numero_controle_pncpnull
    • arquivo_datastring (date)
  • has_moreboolean
  • next_cursorstring | null
  • metaobjeto
    • fonte"Portal da Transparência/Despesas Federais"
    • conjunto"transparencia-despesas"
    • snapshot_idstring
    • geracaointeger
    • cobertura"janela_arquivos_completa"
    • criterio"data_arquivo"
    • data_inicialstring (date)
    • data_finalstring (date)
    • datas_listadasarray de string (date)
    • datas_coletadasarray de string (date)
    • manifesto_sha256string
    • coletado_emstring (date-time)
    • evidenciastring

      Valores: fixture_sintetica, arquivo_oficial_nao_conciliado.

    • contrato_fonte"dicionario_lote_documentado"
    • vinculos_pncpobjeto
      • com_chave_oficial0
      • sem_chave_oficialinteger

Erros

StatusQuandoCódigo
401Chave ausente, inválida ou revogada.
409A geração do cursor deixou de ser a publicação atual.geracao_despesas_expirada
422CNPJ, filtro ou cursor inválido.
429Cota diária da chave atingida (1.000 chamadas por padrão). Toda requisição autenticada conta, inclusive as que terminam em erro e as recusadas por cota. A contagem renova na virada do dia da base. A resposta não traz Retry-After.
503Despesas sem janela completa publicada, contrato inconsistente, base indisponível, consulta interrompida pelo tempo limite ou consultas demais em andamento.despesas_indisponiveis base_indisponivel api_sobrecarregada consulta_demorada

Formatos de erro em Erros; o que conta na cota em Autenticação e cota.