Documentação de integração

GestãoMax - Documentação de Integração

Esta documentação apresenta as entidades, relacionamentos, filtros e propriedades necessários para estruturar a integração de dados que alimentará o BI da GestãoMax.

Escopo

6 entidades principais

Objetivo

Consolidar dados comerciais no BI

Integração

GestãoMax ↔ Sistema de origem

🧾

Entidade

Notas Fiscais

Representa as notas fiscais emitidas.

Relacionamentos

→Cliente (Cadastro de Clientes)
→Vendedor (Cadastro de Vendedores)
→Unidade de venda (Cadastro de Unidades, que podem ser lojas, filiais etc.)
→Itens (entidade relacionada “Itens da Nota Fiscal”)

Filtros

•Data de emissão
•Unidade
•Número da nota

Propriedades trabalhadas

ID da unidade onde ocorreu a venda

Número da nota

Data da nota

Status no Sefaz (emitida, cancelada etc.)

Natureza da operação (venda, bonificação etc.)

ID do cliente

ID do vendedor

Valor total da venda

📦

Entidade

Itens da Nota Fiscal

Representa cada produto vendido dentro de uma nota fiscal. Essa entidade pode ser unida à entidade de Nota Fiscal, repetindo as informações da nota para cada linha de item. Assim, a consulta pode ser feita em uma estrutura única, sem a necessidade de buscar os itens nota a nota.

Relacionamentos

→Nota Fiscal (referência à entidade “Nota Fiscal”)
→Código do Produto (Cadastro de Produtos)

Filtros

•Unidade
•Número da nota

Propriedades trabalhadas

ID da unidade onde ocorreu a venda

Número da nota

ID do produto

Quantidade

Preço unitário

Desconto em valor

Unidade de medida (ex.: PC, UN)

Frete, seguro e outras despesas

IPI, ICMS, ICMS ST, ISSQN, PIS, COFINS e FCP

Observação: O detalhamento de impostos e encargos é opcional. Caso essas informações não estejam disponíveis por item, poderão ser disponibilizadas como totais na entidade da Nota Fiscal. A GestãoMax fará as adaptações necessárias.

👤

Entidade

Clientes

Cadastro dos clientes envolvidos nas notas fiscais.

Relacionamentos

→Referenciado nas entidades Nota Fiscal

Filtros

•Data de inclusão
•Data de alteração
•ID do cliente

Propriedades trabalhadas

ID do cliente

Razão social

Nome fantasia

Tipo de pessoa (física ou jurídica)

Documento (CPF/CNPJ)

Inscrição estadual

Logradouro

Número

Complemento

Bairro

Cidade

CEP

Telefone

📦

Entidade

Produtos

Cadastro dos produtos vendidos.

Relacionamentos

→Referenciado na entidade Itens da Nota Fiscal

Filtros

•Data de inclusão
•Data de alteração
•ID do produto

Propriedades trabalhadas

ID único do produto (referenciado no item da nota)

Código do produto

Descrição

Grupo

Subgrupo

Marca

Preço de venda

Custo

Unidade de medida

👨‍💼

Entidade

Vendedores

Cadastro de vendedores responsáveis pelas vendas.

Relacionamentos

→Referenciado na entidade Nota Fiscal

Filtros

•Data de inclusão
•Data de alteração
•ID do vendedor

Propriedades trabalhadas

ID do vendedor

Nome do vendedor

Documento pessoal (CPF/CNPJ)

Telefone

E-mail

🏢

Entidade

Unidades de Venda

Cadastro das unidades de venda. Podem ser lojas, filiais ou outras unidades operacionais.

Relacionamentos

→Referenciado na entidade Nota Fiscal

Filtros

•Data de inclusão
•Data de alteração
•ID da unidade

Propriedades trabalhadas

ID da unidade

Nome da unidade de venda

Visão consolidada

Resumo dos principais relacionamentos

Entidade principal	Relacionamento com	Tipo
Notas Fiscais	Clientes, Vendedores e Unidades de Venda	1 para 1
Itens da Nota	Produtos	Muitos para 1