Pular para o conteúdo principal
O produto Reporter suporta múltiplos formatos de saída, permitindo que você gere exatamente o tipo de arquivo que precisa, seja HTML, XML, CSV, PDF ou texto puro. Nesta seção, você encontrará exemplos práticos de como estruturar seus arquivos .tpl para cada formato. Esses exemplos são um ótimo ponto de partida para ajudá-lo a projetar templates que se adequem ao seu caso de uso, sigam as regras de formatação e sejam processados corretamente durante a geração.
O conteúdo do arquivo deve seguir o formato de saída desejado (HTML, XML, CSV, PDF ou TXT), mas certifique-se de salvá-lo com a extensão .tpl. Isso é obrigatório para que o template funcione corretamente.

​
Exemplos disponíveis

Template HTML

Relatório financeiro analítico com análise de transações por conta.

Template XML

Relatório financeiro analítico em XML com lógica customizada e resumos.

Template TXT

Template de comprovante de transação em formato texto puro.
Cada página inclui o código completo do template, explicações campo a campo e exemplos de saída que você pode gerar pelo Reporter.

​
Dica para gerar um comprovante de transação

Para gerar um comprovante de transação usando o Reporter, você pode enviar uma requisição como esta para o endpoint Create a Report: 
{
  "templateId": "0196f99c-4d3e-73bc-b5d3-2a5bb1efbee4",
  "ledgerId": [
    "0196d97e-587e-76d8-a458-9d2517ed9aba"
  ],
  "filters": {
    "midaz_transaction": {
      "transaction": {
        "id": ["0196d983-a2c2-7d5a-a5b7-029fe0dcb710"]
      }
    }
  }
}

​
O que esse filtro faz?

O campo filters permite limitar os dados utilizados ao renderizar o template. Neste caso, você está instruindo o sistema a usar apenas a transação com o ID 0196d983-a2c2-7d5a-a5b7-029fe0dcb710. Isso significa que seu comprovante incluirá apenas essa transação — e as operações vinculadas a ela — mantendo a saída limpa e objetiva.

​
O que acontece em seguida?

Após o envio da requisição:
  • A API retorna um reportId.
  • Você pode usar esse ID para verificar o status do relatório.
  • Quando estiver pronto, o relatório estará disponível para download.

​
Por que isso é importante

Essa abordagem oferece clareza e controle. Cada comprovante é gerado de forma isolada, utilizando os filtros e templates que você define.