​Gerar Relatório de Despesas

Este endpoint é utilizado para gerar um relatório em PDF das despesas de uma empresa com base nos filtros especificados. A geração é assíncrona, retornando um jobId que pode ser utilizado para monitorar o progresso através do endpoint de obter progresso do relatório. O jobId estará disponível para ser consultado por 30 minutos até expirar.

Há um limite de 100 despesas por relatório.

Campos do payload:

• companyId: string (ID da empresa) *
• filter: object (Filtros para o relatório de despesas)
  • categoryIds: array de string (IDs das categorias)
  • costCenterIds: array de string (IDs dos centros de custo)
  • customFields: array de object (Filtros por campos customizados)
  • employeeIds: array de string (IDs dos colaboradores)
  • endDate: date (Data de fim do período) *
  • expenseIds: array de string (IDs das despesas específicas)
  • integrationStatus: enum (Status de integração: PENDING, COMPLETED ou ERROR)
  • projectIds: array de string (IDs dos projetos)
  • startDate: date (Data de início do período) *
  • status: array de enum (Status das despesas: DRAFT, PENDING_APPROVAL, PENDING_ACCOUNTING, FINISHED, REQUIRE_CHANGES ou REJECTED)
  • subtype: array de enum (Subtipo das despesas: ODOMETER_MILEAGE ou PLACES_MILEAGE)
  • tagIds: array de string (IDs das tags)
  • type: enum (Tipo das despesas: REIMBURSEMENT ou CORPORATE_CARD)

[*] Campos obrigatórios

URL: /expenses/v1/expenses/pdf-report/generate-async
Método: POST
Descrição: Gera um relatório em PDF das despesas

Headers:

• Content-Type: 'application/json'
• x-flash-auth: <chave_de_api>

Corpo da Requisição:

{
  "companyId": "company-id-1",
  "filter": {
    "employeeIds": ["employee-id-1"],
    "endDate": "2026-02-26T02:59:59.999Z",
    "startDate": "2026-01-26T03:00:00.000Z",
    "status": ["PENDING_ACCOUNTING"],
    "tagIds": ["tag-id-1"],
    "type": "REIMBURSEMENT"
  }
}
json

Resposta de Sucesso (201):

{
  "jobId": "job-id-1"
}
json

Descrição da Resposta:

• jobId: string (Identificador único do relatório gerado, usado para monitorar o progresso)