Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.gyramais.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
Quando usar

Use este endpoint para gerar e receber o arquivo de export (PDF, XLS ou ambos) de um relatório na mesma requisição. A chamada bloqueia até o arquivo estar pronto e retorna direto a URL para download. Para volumes grandes ou quando preferir não bloquear, use GET /report/export/{id} com webhook REPORT_EXPORTED.

​
Autenticação

Bearer JWT no header Authorization.

​
Parâmetros

NomeLocalTipoObrigatórioDescrição
idpathstringsimID do relatório a exportar.
formatquerystringnãoFormato do arquivo: pdf, excel ou both. Padrão: pdf.
typequerystringnãoTipo de export: REPORT (completo) ou REPORT_MINIFIED (resumido). Padrão: REPORT.
sectionOrderquerystring[]nãoLista ordenada de seções a serem incluídas no PDF. Cada seção é informada repetindo o parâmetro (ex.: sectionOrder=LOCATION&sectionOrder=SUMMARY&sectionOrder=PEFIN). Define quais seções aparecem e em que ordem. Se omitido, o relatório é exportado no layout default do sistema. Para a lista completa de seções suportadas, consulte o serviço gyra-core.
O parâmetro sectionOrder é opcional. Quando não enviado, o relatório é exportado no formato padrão do sistema. Quando enviado, o PDF contém apenas as seções listadas, exatamente na ordem informada.
curl --location 'https://gyra-core.gyramais.com.br/report/export-sync/69a207bcdd0197828df9155a?format=pdf' \
--header 'Authorization: Bearer abc123'
O link retornado tem validade de 7 dias. Para geração em lote ou relatórios muito grandes, prefira a versão assíncrona (GET /report/export/{id}) para não segurar a conexão HTTP.
{
  "id": "69a207bcdd0197828df9155a",
  "url": "https://toolbox.gyramais.com.br/export/report/69a207bcdd0197828df9155a.pdf",
  "format": "pdf",
  "expiresAt": "2026-03-06T21:08:11.938Z"
}