> ## 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**: contagens e valores conciliados e não conciliados no intervalo de datas. * **Relatório de detalhes das correspondências**: a lista de transações conciliadas com o grupo de correspondência, a fonte, o valor, a moeda e a data de cada uma. * **Relatório de não conciliados**: a lista de transações que continuam não conciliadas, para acompanhamento. * **Relatório de exceções**: a lista de exceções criadas no intervalo de datas, com severidade, status, motivo e data de vencimento. * **Relatório de variações**: totais de tarifa esperados e reais por fonte, tabela de tarifas e moeda, com a variação líquida e o percentual dela. Cada linha de variação também traz `adjustmentsApplied`, a soma com sinal dos ajustes registrados contra ela, e `outstandingVariance`, a variação que resta depois deles. Cada página de variações traz `unattributedAdjustments`: os totais por moeda dos ajustes que nenhuma linha inclui sozinha. 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](https://docs.lerian.studio/pt/reference/products/matcher/get-dashboard-aggregates.md) > * [Exportar relatório de conciliados](https://docs.lerian.studio/pt/reference/products/matcher/export-matched-report.md) > * [Exportar relatório de não conciliados](https://docs.lerian.studio/pt/reference/products/matcher/export-unmatched-report.md) ## Análises do dashboard *** O dashboard de relatórios traz métricas de conciliação 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. Os valores dele são uma soma entre moedas, então só são um valor monetário quando o intervalo tem uma única moeda | | `matchRate` | Estatísticas de taxa de correspondência (conciliados vs. total) | | `sla` | Estatísticas de SLA no tratamento de exceções | | `unmatchedByCurrency` | Valores não conciliados separados por moeda. Use esse campo para o dinheiro por moeda | | `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` (todos, exceto `dashboard`, têm uma variante `/export`, assim como `exceptions`). > [!TIP] > > Referência da API: [Obter agregados do dashboard](https://docs.lerian.studio/pt/reference/products/matcher/get-dashboard-aggregates.md) ### 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. Quando uma fonte tem mais de uma moeda no intervalo, a linha dela mostra a moeda vazia, e os valores dela são uma soma entre moedas: ```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](https://docs.lerian.studio/pt/reference/products/matcher/get-source-breakdown.md) ### 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](https://docs.lerian.studio/pt/reference/products/matcher/get-cash-impact.md) ## 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. ## Exportações *** Os relatórios `summary`, `matched`, `unmatched`, `variance` e `exceptions` têm cada um uma operação síncrona `/export` que retorna o arquivo na resposta. Escolha o formato com `format=csv` (o padrão) ou `format=pdf`. Uma exportação CSV traz no máximo 100.000 registros, e uma exportação PDF traz no máximo 25.000. ```bash cURL theme={null} curl -X GET "https://api.matcher.example.com/v1/reports/contexts/{contextId}/matched/export?date_from=2025-01-01&date_to=2025-01-31&format=csv" \ -H "Authorization: Bearer $TOKEN" \ -o matched_report.csv ``` Os relatórios de conciliados, não conciliados, variações e exceções também rodam como jobs de exportação assíncronos, com uma janela de até 365 dias e arquivos CSV, JSON ou XML. Veja [Exportações e disputas](https://docs.lerian.studio/pt/products/matcher/reference/matcher-export-disputes.md). ## 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](https://docs.lerian.studio/pt/reference/products/matcher/count-matches.md) | Total de itens conciliados em um intervalo de datas | | [Contar transações](https://docs.lerian.studio/pt/reference/products/matcher/count-transactions.md) | Total de transações em um intervalo de datas | | [Contar exceções](https://docs.lerian.studio/pt/reference/products/matcher/count-exceptions.md) | Total de exceções em um intervalo de datas | | [Contar não conciliados](https://docs.lerian.studio/pt/reference/products/matcher/count-unmatched.md) | 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 *** > [accordion] Agende resumos diários > > Automatize um relatório de resumo diário entregue toda manhã para manter os stakeholders alinhados. > [accordion] 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] Use filtros para manter o resultado acionável > > Gere relatórios direcionados por data e por fonte. Evite exportar tudo por padrão. > [accordion] 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. ## Próximos passos *** > [card] [Contextos e fontes](https://docs.lerian.studio/pt/products/matcher/configuration/matcher-contexts-and-sources.md) > > Configure os contextos de conciliação e as fontes de dados. > [card] [Segurança](https://docs.lerian.studio/pt/products/matcher/reference/matcher-security.md) > > Veja como o controle de acesso e a proteção de dados funcionam no Matcher. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.