​Obter Progresso de Relatório

Este endpoint é utilizado para obter o progresso de geração de um relatório de despesas em PDF. Usa-se como parâmetro o jobId retornado pela endpoint de gerar relatórios de despesas. O jobId estará disponível para ser consultado por 30 minutos até expirar.

Quando o relatório estiver concluído, o link com o pdf estará disponível no campo downloadUrl. Este link estará disponível por 7 dias até expirar.

URL: /expenses/v1/expenses/pdf-report/generate-async/{jobId}/progress
Método: GET
Descrição: Obtém o progresso de geração de um relatório em PDF

Headers:

• x-flash-auth: <chave_de_api>

Parâmetros da URL:

• jobId (string): Identificador único do relatório retornado ao gerar o relatório *

[*] Campo obrigatório

Resposta (200):

Este endpoint retorna um event stream (SSE), e não um JSON único.

Content-Type: text/event-stream

Exemplo do texto de resposta:

data: {"status":"FETCHING_DATA","progress":20,"message":"Fetching expenses..."}

data: {"status":"GENERATING_PDF","progress":85,"message":"Generating PDF document..."}

data: {"status":"GENERATING_PDF","progress":90,"message":"Appending additional documents..."}

data: {"status":"UPLOADING","progress":95,"message":"Uploading report to storage..."}

data: {"status":"COMPLETED","progress":100,"message":"Report generation completed","downloadUrl":"https://url-do-arquivo.pdf"}
text

Descrição de cada evento (data):

• status: enum (Estado do processamento)

  Valor	Significado
  FETCHING_DATA	Buscando as despesas do relatório
  GENERATING_PDF	Gerando o arquivo PDF
  UPLOADING	Enviando o arquivo gerado
  COMPLETED	Relatório concluído e disponível em downloadUrl
  ERROR	Falha na geração do relatório, detalhada em error

• progress: number (Porcentagem do processamento, de 0 a 100)

• message: string (Mensagem amigável descrevendo o estado atual)

• downloadUrl: string (URL pública do PDF gerado, disponível quando status é COMPLETED)

• error: string (Detalhes sobre o erro, presente quando status é ERROR)