> ## 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.

# Exportar Relatório (Assíncrono)

> Dispara a exportação do relatório em PDF/XLS de forma assíncrona. O arquivo é entregue via webhook REPORT_EXPORTED.

<Endpoint
  method="GET"
  path="/report/export/{id}"
  headers={[
{
  name: "Authorization",
  type: "string",
  required: true,
  description: "Token JWT no formato Bearer. Exemplo: `Bearer abc123`"
}
]}
  pathParameters={[
{
  name: "id",
  type: "string",
  required: true,
  description: "ID do relatório a exportar"
}
]}
/>

### 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`. |

<Note>
  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.
</Note>

<RequestExample>
  ```bash cURL (default) theme={null}
  curl --location 'https://gyra-core.gyramais.com.br/report/export/69a207bcdd0197828df9155a?type=REPORT&format=pdf' \
  --header 'Authorization: Bearer abc123'
  ```

  ```bash cURL (com sectionOrder) theme={null}
  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'
  ```

  ```javascript JavaScript theme={null}
  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)
  ```

  ```python Python theme={null}
  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())
  ```
</RequestExample>

<Tip>
  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.
</Tip>

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "id": "69a207bcdd0197828df9155a",
    "status": "PROCESSING",
    "type": "REPORT",
    "format": "pdf"
  }
  ```

  ```json 400 Bad Request theme={null}
  {
    "code": 400,
    "message": "type must be one of the following values: REPORT, REPORT_MINIFIED"
  }
  ```

  ```json 401 Unauthorized theme={null}
  {
    "code": 401,
    "message": "Token de acesso inválido."
  }
  ```

  ```json 404 Not Found theme={null}
  {
    "code": 404,
    "message": "Report not found"
  }
  ```
</ResponseExample>