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 disparar a exportação de um relatório em PDF ou XLS. A geração é assíncrona: a requisição retorna rapidamente e o arquivo fica disponível quando concluído — normalmente entregue por webhook do tipo REPORT_EXPORTED. Use essa variante quando não quiser bloquear a requisição esperando o PDF. Para resposta síncrona, use GET /report/export-sync/{id}.

​
Autenticação

Bearer JWT no header Authorization.

​
Parâmetros

NomeLocalTipoObrigatórioDescrição
idpathstringsimID do relatório a exportar.
typequerystringnãoTipo de export. Valores aceitos: REPORT (completo) ou REPORT_MINIFIED (resumido). Padrão: REPORT.
formatquerystringnãoFormato do arquivo: pdf, excel ou both. Padrão: pdf.
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, com todas as seções padrão na ordem padrão. 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/69a207bcdd0197828df9155a?type=REPORT&format=pdf' \
--header 'Authorization: Bearer abc123'
Configure um webhook do tipo REPORT_EXPORTED para receber o link do arquivo assim que a exportação for concluída. Os links têm validade de 7 dias.
{
  "id": "69a207bcdd0197828df9155a",
  "status": "PROCESSING",
  "type": "REPORT",
  "format": "pdf"
}