Skip to main content
GET

Quando usar

Use esta rota para gerar o arquivo do relatório sem segurar a conexão. A resposta volta na hora com 202, e o link do arquivo chega pelo webhook REPORT_EXPORTED (um disparo por arquivo gerado). Para receber o link na própria resposta, use Exportar Relatório (Síncrono).

Autenticação

Bearer JWT no header Authorization.

Parâmetros

Sem sectionOrder, valem as seções e a ordem do modelo: o escolhido em templateId ou systemTemplate, senão o modelo padrão da organização, senão o padrão do sistema. O nível de detalhe do PDF (completo ou compacto) vem sempre do modelo, mesmo quando você manda sectionOrder.
Um relatório inexistente ou de outra organização não é recusado na resposta: o 202 volta normalmente e a falha chega pelo webhook REPORT_EXPORTED, com exportUrl nulo e o campo error.

O que chega no webhook

O link também fica gravado no relatório, em exportUrl (PDF) e exportExcelUrl (Excel). O link do Excel expira em 7 dias.

Authorizations

Authorization
string
header
required

Enter JWT token

Path Parameters

id
string
required

ID do relatorio a exportar.

Query Parameters

type
enum<string>
required

Obrigatorio. Use REPORT. Sem ele, a resposta e 400.

Available options:
REPORT,
REPORT_MINIFIED
exportFormat
enum<string>

pdf (padrao), excel ou both. Com both saem dois arquivos e dois webhooks.

Available options:
pdf,
excel,
both
sectionOrder
string[]

Secoes do arquivo, na ordem desejada. Repita o parametro para cada secao. Sem ele, valem as secoes e a ordem do modelo.

templateId
string

ID de um modelo de exportacao da organizacao.

systemTemplate
enum<string>

Modelo nativo de exportacao.

Available options:
COMPLETE,
COMPACT

Response

Objeto { status: "processing", reportId }. O arquivo chega pelo webhook REPORT_EXPORTED.

status
string

processing: o arquivo chega pelo webhook REPORT_EXPORTED.

reportId
string