Documentação da API

Tudo o que a sua IA precisa para construir sobre a Brief App.

8 módulos, 84 endpoints, explicados com conceitos, ciclos de vida, fluxos e exemplos. A referência é gerada a partir do código da API.

Visão Geral & Protocolo MCP

O BriefApp TechConsult Contability é uma plataforma corporativa exposta via Model Context Protocol (MCP) e HTTP Streaming, projetada para capacitar agentes de IA (Claude Code, Cursor, Antigravity, Windsurf, ChatGPT) a operar inteligência financeira e contábil em nível de analistas sêniores.

  • Arquitetura de Dados: MinIO (object storage S3 para arquivos brutos), LanceDB (banco vetorial para RAG contábil), DuckDB (motor OLAP in-process ultrarrápido para Parquet), SQLite (formulários dinâmicos e auditoria) e Datalake Medallion particionado.
  • Transporte MCP: Suporte nativo a HTTP Streaming (SSE) e Stdio. Endpoint local padrão: http://localhost:58180/mcp.
  • Multi-tenant Obrigatório: Toda operação exige clientId. Nenhum dado vaza entre empresas clientes.
  • Guardrail Read-Only em SQL: Consultas no Datalake e formulários aceitam estritamente comandos SELECT e WITH. Mutações ocorrem exclusivamente por tools autenticadas com auditoria.
  • Generative + UI: O agente de IA projeta e compõe telas completas de relatórios executivos com Apache ECharts, cards de KPIs e navegação drilldown.

Generative + UI & Dashboards ECharts

Diferente de sistemas convencionais que apenas retornam tabelas ou resumos em texto, o Generative + UI do TechConsult permite que o agente gere interfaces analíticas completas prontas para consumo executivo.

1. Relatórios Snapshot vs. Ao Vivo

  • generate_report_html: Gera um relatório HTML estático e imutável a partir de dados consolidados, ideal para fechamentos contábeis mensais e envio para diretoria.
  • generate_live_report: Gera uma página conectada em tempo real que consulta dinamicamente a camada Gold a cada acesso do usuário, exibindo números atualizados.
  • publish_report: Publica o relatório no portal corporativo gerando uma URL segura com token de acesso.

2. Gráficos ECharts Integrados

O motor renderiza nativamente os seguintes componentes visuais:

  • Waterfall (Cascata DRE): Receita Bruta → Deduções → Margem de Contribuição → Despesas Fixas → EBITDA → Lucro Líquido.
  • Barras Empilhadas: Comparativo orçado vs. realizado por centro de custo e mês.
  • Séries Temporais com Zoom: Fluxo de caixa diário com saldo acumulado e previsões estatísticas.
  • Heatmap Tributário: Calendário de impostos com severidade e vencimento.

3. Navegação Drilldown em Modal

Usuários podem clicar em qualquer barra ou conta contábil para abrir um modal ou banner com a abertura detalhada de lançamentos individuais.

Arquitetura Medallion (Bronze → Silver → Gold)

Para eliminar alucinações e assegurar dados auditáveis, o TechConsult implementa o padrão industrial Medallion com governança por schema:

CamadaNome AmigávelFinalidade TécnicaTools MCP Principais
BRONZE Planilha Original Ingestão bruta de arquivos (CSV, XLSX, Parquet, PDFs via Tika) no MinIO, mantendo fidelidade de origem e metadados. auto_route_file, upload_document, process_document_for_rag
SILVER Validação & Qualidade Limpeza de inconsistências, padronização de planos de contas e execução de baterias de testes com regras de Data Quality. add_dq_rule, validate_data, get_dq_report, run_pipeline
GOLD Prontos p/ Relatório Tabelas dimensionais refinadas e consolidadas, catalogadas no Gold Catalog para consumo direto por C-Levels e LLMs. get_gold_catalog, query_gold_catalog, generate_live_report

Fluxo Pré-Relatório Obrigatório: O agente de IA deve SEMPRE invocar get_gold_catalog(clientId) antes de conceber relatórios. Se os dados já estiverem modelados na Gold, usa query_gold_catalog — nunca reprocessando dados brutos da Bronze.

RAG Documental & Conector Multimodal

Documentos fiscais e bancários frequentemente chegam em formatos não-estruturados (PDFs escaneados de extratos, notas de prestação de serviços, contratos sociais e recibos).

  1. Parsing via Apache Tika: Extrai texto integral, OCR e metadados estruturados do arquivo armazenado no MinIO.
  2. Estruturação com Gemini Flash: Converte linhas de extrato desordenadas em colunas padronizadas: data, historico, documento, valor, tipo (D/C) e saldo.
  3. Indexação no LanceDB: Gera embeddings vetoriais para busca semântica veloz. Cláusulas de contratos e justificativas fiscais podem ser localizadas com search_financial_data ou search_hybrid.

Chatbot Widget Embeddable & Conversa com Dados

O TechConsult inclui um widget de chat flutuante de IA (disponível via chatbotWidget.service.js) que pode ser embutido em qualquer relatório executivo, dashboard ou portal.

  • Conversa Contextual: O usuário clica no botão flutuante e faz perguntas em linguagem natural diretamente sobre o relatório ("Qual filial teve maior crescimento de margem?", "Por que as despesas gerais subiram em março?").
  • Theming Automático: O widget herda a paleta de cores primárias, gradientes e logotipo do cliente configurados em set_client_theme.
  • Streaming & Tool Calls: Suporte a respostas em tempo real com indicador visual de status e execução de consultas analíticas nos bastidores.

E-Commerce & VTEX Command Center

Para empresas com operações de comércio eletrônico, o TechConsult possui um módulo especializado de reconciliação fiscal e contábil integrado à VTEX:

  • Worker em Background: O serviço vtex-worker (porta 58480) sincroniza periodicamente pedidos, notas fiscais emitidas, taxas de marketplace e split de pagamentos.
  • Command Center Interativo: Dashboard executivo completo (gerado via vtexCommandCenter.service.js) com conciliação entre pedidos faturados no ERP e recebimentos das adquirentes.
  • Pipelines Automatizados: Ingestão na camada Bronze, validação fiscal na Silver e relatórios de margem bruta por canal de venda na Gold.

Integração Desktop (Menu de Contexto do Windows)

O TechConsult disponibiliza integração nativa com o Windows Explorer para agilizar o envio de arquivos e pastas contábeis:

  • Clique direito em qualquer arquivo: Exibe a opção "Enviar para o TechConsult" → abre modal de escolha de cliente, faz upload para o MinIO e dispara a indexação no LanceDB automaticamente.
  • Clique direito em qualquer pasta: Exibe a opção "Enviar pasta para o TechConsult" → varre recursivamente todos os arquivos contábeis da pasta preservando a estrutura de subdiretórios no MinIO.
  • Instalação Fácil: Execute powershell -ExecutionPolicy Bypass -File "install/register-context-menu.ps1" no terminal.

Formulários Dinâmicos SQLite & Auditoria

Nem todos os dados nascem em planilhas ou ERPs. Provisões contábeis, aprovações de diretoria, notas explicativas e cadastros de centros de custo necessitam de coleta manual controlada.

  • generate_form: A IA define schema JSON com tipos (texto, moeda, data, select, lookup), regras de obrigatoriedade e gera tabela SQLite dedicada.
  • query_form_data: Consulta registros com filtros, paginação e ordenação via SQL seguro.
  • update_form_record & set_form_record_status: Atualiza registros com registro obrigatório de autor, timestamp e justificativa.
  • get_record_history: Trilha completa de auditoria demonstrando quem alterou o quê em cada campo contábil.
  • get_form_import_template & import_form_data: Baixa template Excel com validação prévia de tipos antes da ingestão em massa.

White-Label & Personalização de Marca

Cada empresa cliente possui sua identidade visual única. O TechConsult permite configurar o tema de marca por cliente:

call_tool("set_client_theme", {
  "clientId": "acme_corp",
  "theme": {
    "companyName": "Acme Indústria e Comércio",
    "primaryColor": "#1e3a8a",
    "secondaryColor": "#0284c7",
    "fontFamily": "Inter, sans-serif",
    "logoUrl": "https://minio.briefapp.br/acme/logo.png"
  }
})

Injeção Automática: O tema é injetado no cabeçalho e componentes de todo relatório HTML gerado, formulário público e portal de visualização.

Guardrails e Políticas de Segurança

Para proteger dados financeiros críticos em ambientes de produção corporativos, o servidor TechConsult impõe políticas rígidas:

  • SQL Read-Only: Nenhuma query enviada via MCP pode conter INSERT, UPDATE, DELETE, DROP, ALTER ou TRUNCATE. Tentativas são rejeitadas na camada do parser com erro 403.
  • Isolamento Físico de Buckets & Schemas: Todos os caminhos no MinIO são prefixados por clientId/, tabelas no banco de formulários utilizam separação estrita e bancos vetoriais LanceDB são particionados.
  • Sem Acesso Direto à Infraestrutura: O agente de IA opera exclusivamente através das tools MCP disponibilizadas.
Módulo

Engenharia de Dados Medallion & Data Lake

Pipelines Bronze-Silver-Gold, Data Quality, Catálogo Gold e Auto-Routing por Schema.


Warning: Undefined array key "intro" in /var/www/html/docs.php on line 253

Conceitos


Warning: Undefined array key "concepts" in /var/www/html/docs.php on line 257

Warning: foreach() argument must be of type array|object, null given in /var/www/html/docs.php on line 257

Warning: Undefined array key "states" in /var/www/html/docs.php on line 262

Fluxo típico


    Warning: Undefined array key "flow" in /var/www/html/docs.php on line 278

    Warning: foreach() argument must be of type array|object, null given in /var/www/html/docs.php on line 278

Exemplo:
Warning: Undefined array key "example" in /var/www/html/docs.php on line 283

Warning: Trying to access array offset on null in /var/www/html/docs.php on line 283

Fatal error: Uncaught TypeError: {closure}(): Argument #1 ($v) must be of type string, null given, called in /var/www/html/docs.php on line 283 and defined in /var/www/html/docs.php:6 Stack trace: #0 /var/www/html/docs.php(283): {closure}(NULL) #1 {main} thrown in /var/www/html/docs.php on line 6