# Modelo de dados
# ASSINANTE
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| id | string | ✔️ | |
| nome | string | ✔️ | |
| fantasia | string | ✔️ | |
| ramo | string | ✔️ | |
| uf | string | ✔️ | |
| cidade | string | ✔️ | |
| revendaId | string | ||
| bairro | string | ✔️ | |
| series | list[string] | ||
| ativo | boolean | ✔️ | |
| cnpj | string |
# REVENDA
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| id | string | ✔️ | |
| nome | string | ✔️ | |
| fantasia | string | ✔️ | |
| ramo | string | ✔️ | |
| uf | string | ✔️ | |
| cidade | string | ✔️ | |
| bairro | string | ✔️ |
# SECAO
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| id | string | ✔️ | |
| codigo | string | ✔️ | |
| descricao | string | ✔️ |
# GRUPO
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| id | string | ✔️ | |
| codigo | string | ✔️ | |
| descricao | string | ✔️ | |
| secaoId | string | ✔️ |
# SUBGRUPO
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| id | string | ✔️ | |
| codigo | string | ✔️ | |
| descricao | string | ✔️ | |
| secaoId | string | ✔️ | |
| grupoId | string | ✔️ |
# HOLDING
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| id | string | ✔️ | |
| descricao | string | ✔️ |
# LOJA
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| ativa | boolean | ✔️ | |
| id | string | ✔️ | |
| descricao | string | ✔️ | |
| numeroDocumento | string | ✔️ | CNPJ da Loja |
| matriz | boolean | ✔️ | |
| holdingId | string | ✔️ | |
| ramo | string | ✔️ | |
| logradouro | string | ||
| numero | string | ||
| uf | string | ✔️ | |
| cidade | string | ✔️ | |
| bairro | string | ✔️ | |
| cep | string | ||
| distrito | string | ||
| complemento | string | ||
| telefone | string | ||
| qtdCheckouts | number | ||
| areaM2 | number | ||
| qtdFuncionarios | number |
# META
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| id | string | ✔️ | |
| mes | number | ✔️ | |
| ano | number | ✔️ | |
| lojaId | string | ✔️ | |
| secaoId | string | ✔️ | |
| valor | number | ✔️ |
# FORMA_PAGAMENTO
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| id | string | ✔️ | |
| descricao | string | ✔️ |
# FUNCIONARIO
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| dataNascimento | date | ||
| id | string | ✔️ | |
| login | string | ||
| nome | string | ✔️ | |
| numeroDocumento | string | ||
| ativo | boolean | ✔️ | |
| senha | string | ||
| lojaIds | list[string] |
# ACESSO
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| id | string | ✔️ | |
| funcionarioIds | list[string] | ✔️ |
# CLIENTE
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| id | string | ✔️ | |
| nome | string | ✔️ | |
| numeroDocumento | string | ✔️ | |
| ramo | string | ✔️ | |
| uf | string | ✔️ | |
| cidade | string | ✔️ | |
| bairro | string | ✔️ |
# FORNECEDOR
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| id | string | ✔️ | |
| nome | string | ✔️ | |
| numeroDocumento | string | ✔️ | |
| ramo | string | ✔️ | |
| uf | string | ✔️ | |
| cidade | string | ✔️ | |
| bairro | string | ✔️ |
# PRODUTO
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| composicao | object | ||
| tipoComposicao | string | ||
| descricao | string | ✔️ | |
| dataInclusao | date | ||
| finalidade | string | ||
| ativo | boolean | ||
| grupoId | string | ||
| id | string | ✔️ | |
| pesoVariavel | boolean | ||
| quantidadeItensEmbalagem | number | ||
| secaoId | string | ✔️ | |
| subgrupoId | string | ||
| fornecedores | list[Fornecedores] | ||
| eans | list[Eans] | Enviar apenas 1 único EAN |
# Fornecedores
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| id | string | ✔️ | |
| principal | booleano | ✔️ |
# Eans
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| id | string | ✔️ | |
| tributado | booleano |
# EAN
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| id | string | ✔️ | |
| produtoId | string | ✔️ | |
| tributado | boolean |
# TROCA_FORMA_PAGAMENTO
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| autorizadorId | string | ||
| data | date | ✔️ | |
| formaPagamentoDestinoId | string | ✔️ | |
| formaPagamentoOrigemId | string | ✔️ | |
| id | string | ✔️ | |
| lojaId | string | ✔️ | |
| vendaId | string | ||
| operadorId | string | ||
| sequencialPagamento | string | ✔️ | |
| valor | number | ✔️ | |
| valorContraValeOuTroco | number |
# TROCA_DEVOLUCAO
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| autorizadorId | string | ||
| data | date | ✔️ | |
| vendaId | string | ||
| id | string | ✔️ | |
| itens | list[Itens] | ✔️ | |
| lojaId | string | ✔️ | |
| numeroCaixa | string | ||
| operadorId | string | ||
| sequencial | string | ||
| valor | number | ✔️ | |
| vendedorId | string |
# Itens
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| desconto | número | ||
| produtoId | string | ✔️ | |
| quantidade | número | ✔️ | Valor máximo: 999999999.9999, Valor mínimo: -999999999.9999 |
| valorTotal | número | ✔️ | Valor máximo: 999999999.99, Valor mínimo: -999999999.99 |
| valorUnitario | número | ✔️ | Valor máximo: 999999999.99, Valor mínimo: -999999999.99 |
| vendedorId | string |
# EVENTO_CAIXA
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| id | string | ✔️ | |
| lojaId | string | ✔️ | |
| numeroCaixa | string | ✔️ | |
| funcionarioId | string | ||
| dataHora | date | ✔️ | |
| tipo | string | ✔️ | |
| valoresDeclarados | list[Valores Declarados] |
# Valores Declarados
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| formaPagamentoId | string | ✔️ | |
| valor | número | ✔️ | Valor máximo: 999999999.99, Valor mínimo: -999999999.99 |
# VENDA
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| id | string | ✔️ | |
| lojaId | string | ✔️ | |
| cnpj | string | ⚠️ | Obrigatório no Java SDK |
| clienteId | string | ||
| funcionarioId | string | ||
| data | date | ✔️ | |
| dataHoraInicio | date | ||
| dataHoraFim | date | ||
| dataHoraVenda | date | ✔️ | |
| desconto | number | ||
| efetiva | boolean | ✔️ | |
| quantidadeItens | number | ✔️ | |
| quantidadeItensCancelados | number | ||
| sequencial | string | ✔️ | |
| servico | number | ||
| tipoDesconto | string | ||
| tipoPreco | string | ✔️ | |
| valor | number | ✔️ | |
| valorItensCancelados | number | ||
| acrescimo | number | ||
| numeroCaixa | string | ||
| chave | string | ||
| xml | base64 | ||
| itens | list[Itens] | ✔️ | |
| pagamentos | list[Pagamentos] | ✔️ |
# Itens
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| acrescimo | número | ||
| desconto | número | ||
| efetivo | booleano | ✔️ | |
| gtin | string | ⚠️ | Obrigatório no Java SDK |
| descricao | string | ⚠️ | Obrigatório no Java SDK |
| funcionarioId | string | ||
| preco | número | ✔️ | |
| produtoId | string | ✔️ | |
| codigoRegistrado | string | ||
| promocao | booleano | ||
| quantidade | número | ✔️ | Valor máximo: 999999999.9999, Valor mínimo: -999999999.9999 |
| servico | número | ||
| valorTotal | número | ✔️ | Valor máximo: 999999999.99, Valor mínimo: -999999999.99 |
| valorUnitario | número | ✔️ | Valor máximo: 999999999.99, Valor mínimo: -999999999.99 |
| tipoPreco | string | ✔️ | |
| custo | número | ||
| markup | número | ||
| lucro | número |
# Pagamentos
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| formaPagamentoId | string | ✔️ | |
| formaPagamentoSefaz | string | ||
| sequencial | string | ✔️ | |
| valor | número | ✔️ | Valor máximo: 999999999.99, Valor mínimo: -999999999.99 |
# COMPRA
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| id | string | ✔️ | |
| lojaId | string | ✔️ | |
| fornecedorId | string | ||
| funcionarioId | string | ||
| dataEntrada | date | ✔️ | |
| dataEmissao | date | ✔️ | |
| dataHoraCompra | date | ✔️ | |
| desconto | number | ||
| efetiva | boolean | ✔️ | |
| quantidadeItens | number | ✔️ | |
| tipoDesconto | string | ||
| valor | number | ✔️ | |
| acrescimo | number | ||
| itens | list[Itens] | ✔️ |
# Itens
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| acrescimo | número | ||
| desconto | número | ||
| produtoId | string | ✔️ | |
| quantidade | número | ✔️ | Valor máximo: 999999999.9999, Valor mínimo: -999999999.9999 |
| valorTotal | número | ✔️ | Valor máximo: 999999999.99, Valor mínimo: -999999999.99 |
| valorUnitario | número | ✔️ | Valor máximo: 999999999.99, Valor mínimo: -999999999.99 |
# LOCAL_ESTOQUE
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| id | string | ✔️ | |
| lojaId | string | ✔️ | |
| descricao | string | ✔️ | |
| disponivelParaVenda | boolean | ✔️ |
# ESTOQUE_MOVIMENTACAO
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| id | string | ✔️ | |
| localEstoqueId | string | ✔️ | |
| dataHora | date | ✔️ | |
| produtoId | string | ✔️ | |
| quantidade | number | ✔️ | |
| custo | number | ✔️ | |
| preco | number | ✔️ | |
| markup | number |
# TITULO_PAGAR
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| id | string | ✔️ | |
| lojaId | string | ✔️ | |
| fornecedorId | string | ✔️ | |
| documento | string | ✔️ | |
| valorNominal | number | ✔️ | |
| valorJuros | number | ✔️ | |
| valorMulta | number | ✔️ | |
| valorDevido | number | ✔️ | |
| valorPago | number | ✔️ | |
| dataEmissao | date | ✔️ | |
| dataVencimento | date | ✔️ | |
| pagamentos | list[Pagamentos] | ✔️ |
# Pagamentos
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| dataHora | data | ✔️ | |
| valor | número | ✔️ | Valor máximo: 999999999.99, Valor mínimo: -999999999.99 |
# TITULO_RECEBER
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| id | string | ✔️ | |
| lojaId | string | ✔️ | |
| clienteId | string | ✔️ | |
| documento | string | ✔️ | |
| valorNominal | number | ✔️ | |
| valorJuros | number | ✔️ | |
| valorMulta | number | ✔️ | |
| valorDevido | number | ✔️ | |
| valorPago | number | ✔️ | |
| dataEmissao | date | ✔️ | |
| dataVencimento | date | ✔️ | |
| pagamentos | list[Pagamentos] | ✔️ |
# Pagamentos
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
| dataHora | data | ✔️ | |
| valor | número | ✔️ | Valor máximo: 999999999.99, Valor mínimo: -999999999.99 |