Exportar Relatório (Assíncrono)

curl --location 'https://gyra-core.gyramais.com.br/report/export/69a207bcdd0197828df9155a?type=REPORT&format=pdf' \
--header 'Authorization: Bearer abc123'

curl --request GET \
  --url 'https://gyra-core.gyramais.com.br/report/export/69a207bcdd0197828df9155a?type=REPORT&sectionOrder=LOCATION&sectionOrder=SUMMARY&sectionOrder=PEFIN' \
  --header 'Authorization: Bearer abc123'

fetch("https://gyra-core.gyramais.com.br/report/export/69a207bcdd0197828df9155a?type=REPORT&format=pdf", {
  method: "GET",
  headers: {
    "Authorization": "Bearer abc123",
  },
})
  .then(res => res.json())
  .then(console.log)

import requests

url = "https://gyra-core.gyramais.com.br/report/export/69a207bcdd0197828df9155a"
headers = {"Authorization": "Bearer abc123"}
params = {"type": "REPORT", "format": "pdf"}

response = requests.get(url, headers=headers, params=params)
print(response.json())

{
  "id": "69a207bcdd0197828df9155a",
  "status": "PROCESSING",
  "type": "REPORT",
  "format": "pdf"
}

{
  "code": 400,
  "message": "type must be one of the following values: REPORT, REPORT_MINIFIED"
}

{
  "code": 401,
  "message": "Token de acesso inválido."
}

{
  "code": 404,
  "message": "Report not found"
}

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

Nome	Local	Tipo	Obrigatório	Descrição
`id`	`path`	`string`	`sim`	ID do relatório a exportar.
`type`	`query`	`string`	`não`	Tipo de export. Valores aceitos: `REPORT` (completo) ou `REPORT_MINIFIED` (resumido). Padrão: `REPORT`.
`format`	`query`	`string`	`não`	Formato do arquivo: `pdf`, `excel` ou `both`. Padrão: `pdf`.
`sectionOrder`	`query`	`string[]`	`não`	Lista 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'

curl --request GET \
  --url 'https://gyra-core.gyramais.com.br/report/export/69a207bcdd0197828df9155a?type=REPORT&sectionOrder=LOCATION&sectionOrder=SUMMARY&sectionOrder=PEFIN' \
  --header 'Authorization: Bearer abc123'

fetch("https://gyra-core.gyramais.com.br/report/export/69a207bcdd0197828df9155a?type=REPORT&format=pdf", {
  method: "GET",
  headers: {
    "Authorization": "Bearer abc123",
  },
})
  .then(res => res.json())
  .then(console.log)

import requests

url = "https://gyra-core.gyramais.com.br/report/export/69a207bcdd0197828df9155a"
headers = {"Authorization": "Bearer abc123"}
params = {"type": "REPORT", "format": "pdf"}

response = requests.get(url, headers=headers, params=params)
print(response.json())

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"
}

{
  "code": 400,
  "message": "type must be one of the following values: REPORT, REPORT_MINIFIED"
}

{
  "code": 401,
  "message": "Token de acesso inválido."
}

{
  "code": 404,
  "message": "Report not found"
}

Refazer Análise Manual Exportar Relatório (Síncrono)

Primeiros Passos

Conceitos Fundamentais

Guia do Toolbox

Fontes de Dados

Guias

Casos de Uso

MCP Server

Referência da API

Dicionário de Dados

Integrações

Referência

Exportar Relatório (Assíncrono)

Quando usar

Autenticação

Parâmetros

​Quando usar

​Autenticação

​Parâmetros

Quando usar

Autenticação

Parâmetros