> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Geração de relatórios

> Gere resumos de conciliação, detalhes de correspondências, visões de exceções e relatórios de variações para acompanhar os resultados e apoiar o compliance.

Os relatórios transformam uma execução de conciliação em algo acionável: quanto foi conciliado, o que continua em aberto e quanto dinheiro está exposto. Os times de operações usam os relatórios para trabalhar a fila do dia. As áreas financeira e de compliance os usam para fechar os livros e documentar os resultados.

## Relatórios disponíveis

***

Cada relatório responde a uma pergunta diferente:

* **Resumo da conciliação**: um panorama geral das taxas de correspondência, do volume de exceções e do total de variações.
* **Relatório de detalhes das correspondências**: a lista completa de correspondências, incluindo detalhes das transações, pontuações de confiança e o detalhamento das variações.
* **Relatório de não conciliados**: a lista de transações que continuam não conciliadas, para acompanhamento.
* **Relatório de exceções**: uma visão focada nas exceções não resolvidas, com aging, severidade e status de resolução.
* **Relatório de variações**: o detalhamento das diferenças de tarifa entre transações conciliadas. Cada linha preserva a variação líquida bruta, mostra os ajustes registrados aplicados àquela linha e informa a variação pendente resultante. O relatório mostra um ajuste como não atribuído quando ele não corresponde a exatamente uma linha de fonte, tabela de tarifas e moeda. O relatório nunca divide um ajuste assim.

Use os endpoints do dashboard de relatórios para acessar as métricas de conciliação e exportar dados.

<Tip>
  Referência da API:

  * [Agregados do dashboard](/pt/reference/products/matcher/get-dashboard-aggregates)
  * [Exportar relatório de conciliados](/pt/reference/products/matcher/export-matched-report)
  * [Exportar relatório de não conciliados](/pt/reference/products/matcher/export-unmatched-report)
</Tip>

## Análises do dashboard

***

O dashboard de relatórios traz métricas de conciliação em tempo real para um contexto e um intervalo de datas. Por padrão, os endpoints de relatório usam a janela de 30 dias que termina amanhã (UTC) e normalmente limitam a janela a 90 dias. Apenas os endpoints de lista e de contagem de não conciliados aceitam `unbounded=true` para consultar sem limites de data.

### Agregados do dashboard

Use o endpoint combinado de agregados do dashboard para uma única chamada que retorna estatísticas de volume, de taxa de correspondência e de SLA de um contexto:

```bash cURL theme={null}
curl -X GET "https://api.matcher.example.com/v1/reports/contexts/{contextId}/dashboard?date_from=2025-01-01&date_to=2025-01-31" \
 -H "Authorization: Bearer $TOKEN"
```

`GET /v1/reports/contexts/{contextId}/dashboard` aceita `date_from`, `date_to` e um filtro opcional `source_id`, e retorna um `DashboardAggregatesResponse`:

| Campo       | Descrição                                                       |
| ----------- | --------------------------------------------------------------- |
| `volume`    | Estatísticas de volume de transações no intervalo               |
| `matchRate` | Estatísticas de taxa de correspondência (conciliados vs. total) |
| `sla`       | Estatísticas de SLA no tratamento de exceções                   |
| `updatedAt` | Quando os agregados foram calculados pela última vez (RFC 3339) |

Recortes mais granulares do dashboard ficam em `/v1/reports/contexts/{contextId}/dashboard/*` (por exemplo `metrics`, `match-rate`, `sla`, `volume`, `source-breakdown` e `cash-impact`).

<Note>
  Não existe um endpoint `GET /v1/reports/contexts/{contextId}` puro. Os subcaminhos tipados sob `/v1/reports/contexts/{contextId}/...` carregam os dados dos relatórios, por exemplo `dashboard`, `summary`, `matched`, `unmatched` e `variance` (cada um com uma variante `/export`).
</Note>

<Tip>
  Referência da API: [Obter agregados do dashboard](/pt/reference/products/matcher/get-dashboard-aggregates)
</Tip>

### Detalhamento por fonte

Veja o desempenho da conciliação por fonte, incluindo taxas de correspondência, contagens de transações e valores não conciliados:

```bash cURL theme={null}
curl -X GET "https://api.matcher.example.com/v1/reports/contexts/{contextId}/dashboard/source-breakdown?date_from=2025-01-01&date_to=2025-01-31" \
 -H "Authorization: Bearer $TOKEN"
```

<Tip>
  Referência da API: [Obter detalhamento por fonte](/pt/reference/products/matcher/get-source-breakdown)
</Tip>

### Impacto de caixa

Avalie a exposição financeira total das transações não conciliadas, detalhada por moeda e por idade:

```bash cURL theme={null}
curl -X GET "https://api.matcher.example.com/v1/reports/contexts/{contextId}/dashboard/cash-impact?date_from=2025-01-01&date_to=2025-01-31" \
 -H "Authorization: Bearer $TOKEN"
```

A resposta inclui os detalhamentos `byCurrency` e `byAge` para ajudar a priorizar os esforços de resolução.

<Tip>
  Referência da API: [Obter impacto de caixa](/pt/reference/products/matcher/get-cash-impact)
</Tip>

## Paginação

***

Os endpoints dos relatórios de conciliados, de não conciliados e de variações usam paginação por cursor. Passe o valor de `cursor` de uma resposta anterior para obter a próxima página de resultados.

Se você informar um valor de cursor inválido, a API retorna um erro `400 Bad Request` com uma mensagem indicando que os parâmetros de paginação são inválidos. Versões anteriores retornavam um erro `500` nesse caso.

## Contagens rápidas

***

Use os endpoints de contagem para verificações de status leves, sem buscar os conjuntos completos de resultados:

| Endpoint                                                                 | Descrição                                               |
| ------------------------------------------------------------------------ | ------------------------------------------------------- |
| [Contar correspondências](/pt/reference/products/matcher/count-matches)  | Total de itens conciliados em um intervalo de datas     |
| [Contar transações](/pt/reference/products/matcher/count-transactions)   | Total de transações em um intervalo de datas            |
| [Contar exceções](/pt/reference/products/matcher/count-exceptions)       | Total de exceções em um intervalo de datas              |
| [Contar não conciliados](/pt/reference/products/matcher/count-unmatched) | Total de itens não conciliados em um intervalo de datas |

```bash cURL theme={null}
curl -X GET "https://api.matcher.example.com/v1/reports/contexts/{contextId}/matches/count?date_from=2025-01-01&date_to=2025-01-31" \
 -H "Authorization: Bearer $TOKEN"
```

Cada endpoint de contagem retorna um único valor `count`, ideal para dashboards leves ou health checks que não precisam do conjunto completo de resultados.

## Boas práticas

***

<AccordionGroup>
  <Accordion title="Agende resumos diários">
    Automatize um relatório de resumo diário entregue toda manhã para manter os stakeholders alinhados.
  </Accordion>

  <Accordion title="Arquive as exportações para compliance">
    Guarde os relatórios em um armazenamento seguro e durável. Artefatos financeiros costumam exigir retenção de vários anos.
  </Accordion>

  <Accordion title="Use filtros para manter o resultado acionável">
    Gere relatórios direcionados por data e por fonte. Evite exportar tudo por padrão.
  </Accordion>

  <Accordion title="Deixe as exportações autoexplicativas">
    Inclua os nomes das fontes, os nomes das regras e os identificadores principais para que a saída se sustente sozinha fora do Matcher.
  </Accordion>

  <Accordion title="Monitore os jobs de relatório">
    Relatórios grandes podem falhar ou travar. Os jobs de exportação usam `QUEUED`, `RUNNING`, `SUCCEEDED`, `FAILED`, `EXPIRED` e `CANCELED`. Crie alertas para `FAILED` ou para `RUNNING` prolongado.
  </Accordion>
</AccordionGroup>

## Próximos passos

***

<Card title="Contextos e fontes" icon="database" href="/pt/products/matcher/configuration/matcher-contexts-and-sources" horizontal>
  Configure os contextos de conciliação e as fontes de dados.
</Card>

<Card title="Segurança" icon="shield-halved" href="/pt/products/matcher/reference/matcher-security" horizontal>
  Veja como o controle de acesso e a proteção de dados funcionam no Matcher.
</Card>
