# Relatórios — Como Usar

Guia prático de todas as ações disponíveis na página de Relatórios.

---

## Fluxo típico

1. Acessar **Relatórios** pelo menu lateral (`/reports`).
2. _(Opcional)_ Consultar o **Dicionário** para entender o significado das colunas.
3. Clicar em **Novo relatório** → preencher tipo, formato, período, filiais e filtros → **Gerar relatório**.
4. Aguardar (a lista atualiza sozinha enquanto o status for "Na fila" ou "Processando").
5. Quando o status mudar para **Completo**, abrir o menu ⋮ → **Baixar relatório**.
6. Se precisar do mesmo relatório: ⋮ → **Gerar relatório novamente** (ajustar se necessário).
7. Para remover: ⋮ → **Excluir relatório** → confirmar no modal.

---

## Criar um novo relatório

Clique em **Novo relatório** no cabeçalho da página. O modal que abre tem os seguintes campos:

### Campos do formulário

| Campo                 | Descrição                                                                                                   |
| --------------------- | ----------------------------------------------------------------------------------------------------------- |
| **Tipo do relatório** | Pedidos, Eventos, Envios, Integrações de Pedidos, Integrações de Transportadoras, Filiais ou CSAT           |
| **Formato**           | CSV ou JSON                                                                                                 |
| **Período**           | Data absoluta ou período dinâmico — máximo de **31 dias** (disponível para Pedidos, Eventos, Envios e CSAT) |
| **Filiais**           | Seletor de filiais — mínimo 1 obrigatória                                                                   |
**Aviso de fuso horário:** Ao abrir o modal, a plataforma exibe o fuso horário detectado da sua máquina.
  Todas as datas do relatório serão exportadas nesse fuso. Veja mais em
  [Troubleshooting](https://abbiamo-guide.netlify.app/go/products/relatorios/troubleshooting/).

Após preencher, clique em **Gerar relatório**. Um toast confirma o envio e a lista é atualizada automaticamente.

---

## Consultar o dicionário de colunas

No cabeçalho, clique no ícone de **Dicionário** (ℹ). Escolha o idioma (**Português** ou **Inglês**) e o modal exibirá a descrição de todas as colunas de cada tipo de relatório.

Isso é útil para entender exatamente o que cada campo significa no arquivo exportado.

---

## Filtrar e buscar relatórios

### Busca rápida

Use o campo de busca (placeholder "Nome do relatório") para filtrar a lista pelo nome.

### Filtros avançados

Clique no botão de filtros para abrir o painel e selecione:

- **Nome** — texto livre
- **Tipo do relatório** — Pedidos, Eventos, Envios, etc.
- **Formato** — CSV, JSON
- **Status** — Na fila, Processando, Completo, Falha, Expirado
**Filtros persistentes:** Os filtros são salvos automaticamente no navegador. Ao sair e voltar na
  página, eles continuam ativos.

### Controle de colunas

Ao lado dos filtros, há o botão de **visibilidade de colunas**: permite mostrar ou ocultar colunas da tabela conforme sua necessidade.

---

## Ações na linha do relatório (menu ⋮)

Cada relatório na tabela possui um menu de ações à direita:

### Baixar relatório

| Situação                              | Comportamento                                           |
| ------------------------------------- | ------------------------------------------------------- |
| Status **Na fila** ou **Processando** | Ícone de loading — aguarde a conclusão                  |
| Status **Completo**                   | Solicita a URL de download e abre o arquivo em nova aba |
| Status **Falha** ou **Expirado**      | O download não estará disponível — gere novamente       |

Um toast de carregamento/sucesso/erro aparece durante o processo.

### Gerar relatório novamente

Abre o mesmo modal de criação, já preenchido com o tipo, formato, filiais e período daquele relatório. Você pode ajustar os campos e clicar em **Gerar relatório** para criar um novo.
**Relatório expirado:** Essa é a forma mais rápida de recriar um relatório expirado: o modal já vem
  preenchido, basta confirmar.

### Excluir relatório

Abre o modal de confirmação:

> _"Tem certeza que deseja excluir o relatório "Nome do relatório"?"_

- **Excluir**: remove o relatório da lista (soft delete) e atualiza a tabela.
- **Cancelar**: fecha o modal sem ação.