Força de Vendas - Malharia » Histórico » Versão 208
« Anterior -
Versão 208/297
(diff) -
Próximo » -
Versão atual
jean, 08/07/2024 08:33 h
Força de Vendas - Malharia¶
Índice- Introdução
- Acesso via JDBC
- Tabelas de Integração, Parâmetros e Exemplo de SQL de Integração
- Layouts de Integração
- Produtos
- Produtos - Variantes
- Produtos - Exclusivos
- Tabela de Preço - Capa
- Tabela de Preço - Itens
- Tabela de Preço - Clientes
- Tabela de Preço - Representantes
- Catalogos
- Acessórios-de-Produtos
- Lotes de Faturamento
- Condição de Venda
- Listagem de Pedidos - Consulta
- Listagem de Pedidos - Detalhamento da Capa
- Listagem de Pedidos - Itens
- Listagem de Pedidos - Notas
- Listagem de Pedidos - Notas Itens
- Listagem de Pedidos - Situação ERP
- Listagem de Pedidos - Tipo Nota
- Listagem de pedidos para conjugar
- Triangulação
- Transportadoras
- Comissões - Extrato Resumo
- Comissões - Extrato Detalhado
- Títulos
- Tipo de Cobrança
- Condição de Pagamento
- Campos Customizados
- Partidas de Pedidos
- Lista pública de clientes
- Carga Máquina
Introdução¶
O presente documento tem por objetivo orientar as empresas de ERP na geração dos arquivos e/ou tabelas necessárias para integração com a Digitação de Pedidos da GEOvendas.
Atenção!! Os campos que estiverem com a descrição "Campo Específico" retornar null, salvo se for combinado algo diferente com a GEOvendas durante o processo.
Atenção!! Cabe ao desenvolvedor das Views retornar nas views os campos obrigatórios e os campos não obrigatórios que forem pertinentes ao processo do Cliente, ou a informação que o cliente deseja enxergar.
Dúvidas ou maiores esclarecimentos podem ser obtidos pelo e-mail atendimento@geovendas.com ou pelo telefone (47) 3370-0504.
Acesso via JDBC¶
Pré-Requisito: Suporte por parte do Banco de Dados da Empresa fornecedora do ERP a acesso JDBC.
Na integração via JDBC a fornecedora de ERP deve disponibilizar para a GEOvendas tabelas (ou visões) conforme os layouts especificados neste documento, também deverá fornecer um usuário e senha que tenha permissão de consulta nas referidas tabelas ou visões. A GEOvendas fará acesso via JDBC à base de dados do cliente para extrair as informações.
Tabelas de Integração, Parâmetros e Exemplo de SQL de Integração¶
Tabelas de Integração¶
As tabelas/visões tem um campo chamado “codEmpresa” que separa a geração dos dados entre as possíveis várias empresas que o cliente tenha na mesma base de ERP.
Observação: Os campos com asterisco (*) compõem a “primaryKey” e podem ser enviados como String ou Integer dependendo da necessidade do cliente.
Parâmetros¶
Algumas tabelas de integração necessitam de parâmetros. Os parâmetros trabalham em pares: Campo e Parâmetro.
O Campo refere-se ao campo correspondente na tabela/visão, e o parâmetro é o código que será substituído na hora da execução do SQL.
Exemplo de SQL de Integração¶
Vamos usar abaixo um exemplo a Tabela de Preços:
Documentação do IGS:
Consulta informações de tabela de preço do ERP.
Campo Tipo Precisão Descrição codEmpresa * String/Integer 10 Código da Empresa origem dos dados codTabela * String/Integer 255 Código da tabela de preços no ERP descricao String 255 Descrição da tabela de preços Lista de Parâmetros:
Campo Parâmetro Tipo Precisão Descrição codEmpresa :p1 String/Integer 10 Código da empresa no ERP codTabela :p2 String/Integer 255 Código da tabela de preços no ERP
SQL de exemplo com base na documentação
SELECT codEmpresa, codTabela, descricao FROM TabelaDePreco WHERE codEmpresa = :p1 AND codTabela = :p2
Layouts de Integração¶
Segue os layouts que devem servir de base para construção dos SQLs de integração.
Produtos¶
Retornar a listagem de produtos.
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | codProduto * | String | 255 | Código do Produto no ERP. É o código usado para gravar o produto no ERP. |
2 | nomeProduto * | String | 255 | Descrição do Produto. |
3 | larguraTxt * | String | 255 | Descrição da largura para exibição. |
4 | largura * | Double | Largura. | |
5 | gramaturaTxt * | String | 255 | Informação de gramatura para exibição. |
6 | gramatura * | Double | gramatura do produto. | |
7 | rendimentoMKG * | Double | rendimento do produto em M/KG. | |
8 | keyword * | String | 255 | keywords do produto. |
9 | composicao * | String | 255 | Descrição da composição do produto. |
10 | acessorio * | Integer | 0,1 | Deve ser informado 1, quando a linha representar um acessório. Default: 0 |
11 | vendaAcessorio * | Integer | 0,1 | Deve ser informado 1, quando é possível vender o acessório como um produto principal. Default: 0 |
12 | unidadeMedida * | String | KG,M | Deve ser informado M para metros e KG para quilos. Default: KG |
13 | urlFichaTecnica | String | URL da Ficha tecnica do produto. O arquivo PDF deve estar acessível publicamente caso seja uma URL direta ao arquivo, caso seja URL de página mesma não deve ter o cabeçalho X-Frame-Options configurada |
Lista de Parâmetros:
Campo | Parâmetro | Tipo | Precisão | Descrição |
---|---|---|---|---|
codEmpresa | :p1 | String/Integer | 10 | Código da empresa no ERP |
codCatalogo | :p2 | String | 255 | Código do catalogo no ERP |
codProduto | #PRODUTOS | String | text | Lista de Referências Ex: and (codProduto in (#PRODUTOS) or #PRODUTOS_TODOS = '') Para ORACLE and (codProduto in (#PRODUTOS) or nvl(#PRODUTOS_TODOS,'0') = nvl('','0') ) |
Produtos - Variantes¶
Retornar a listagem de variantes dos produtos.
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | codProduto * | String | 255 | Código do Produto no ERP. É o código usado para gravar o produto no ERP. |
2 | codVariante * | String | 255 | Código da da variante no ERP. |
3 | nomeVariante * | String | 255 | Nome da Variante. |
4 | skuReduzido * | String | 255 | SKU reduzido do produto. |
5 | codCatalogo * | String | 255 | Código do catalogo. |
6 | pesoPadrao * | Double | Peso padrão. | |
7 | codLinha * | String | 255 | Código da Linha. |
8 | nomeLinha * | String | 255 | Nome da Linha. |
9 | codGrupoCor * | String | 255 | Código do grupo cor. |
10 | nomeGrupoCor * | String | 255 | Nome do grupo da cor. |
11 | rgb * | String | RGB referente a variante do produto. | |
12 | codTipoPeca * | String | Código do tipo da peça. | |
13 | nomeTipoPeca * | String | Nome do tipo de peça. | |
14 | especial* | Integer | 1 se o produto for exclusivo. 0 para os demais casos. Se o código for 1, desviaremos para quem não tem autorização | |
15 | codClassificacaoFiscal * | String | 255 | Código da classificação fiscal do produto. |
16 | descClassificacaoFiscal * | String | 255 | Descrição da classificação fiscal do produto. |
17 | codCategoria * | String | 255 | Código da Categoria do produto. |
18 | descCategoria * | String | 255 | Descrição da Categoria do produto. |
19 | codOrigem * | String | 255 | Código da Origem do produto. |
20 | descOrigem * | String | 255 | Descrição da Origem do produto. |
Lista de Parâmetros:
Campo | Parâmetro | Tipo | Precisão | Descrição |
---|---|---|---|---|
codEmpresa | :p1 | String/Integer | 10 | Código da empresa no ERP |
codCatalogo | :p2 | String | 255 | Código do catalogo no ERP |
codProduto | #PRODUTOS | String | text | Lista de Referências Ex: and (codProduto in (#PRODUTOS) or #PRODUTOS_TODOS = '') Para ORACLE and (codProduto in (#PRODUTOS) or nvl(#PRODUTOS_TODOS,'0') = nvl('','0') ) |
Produtos - Exclusivos¶
Retornar a listagem de produtos exclusivos. Esta é a autorização do cliente para itens especiais.
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | skuReduzido | String | 255 | SKU reduzido do produto. |
2 | codCliente | String | 255 | Código do Cliente |
Lista de Parâmetros:
Parâmetro | Tipo | Precisão | Descrição |
---|---|---|---|
codEmpresa | String/Integer | 10 | Código da empresa no ERP |
Tabela de preço - Capa¶
Retornar a capa da tabela de preço.
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | codTabela * | String | 255 | Código da Tabela de preço no ERP. |
2 | nomeTabela * | String | 255 | Descrição da Tabela de preço. |
3 | nomeApresentacao* | String | 255 | Nome para apresentação no FVM |
4 | ordem | Integer | 255 | Ordem |
5 | status | String | 255 | Status(ativo/inativo) |
6 | dataValidadeInicial | Date | Data Validade Inicial | |
7 | dataValidadeFinal | Date | Data Validade Final | |
8 | liberacaoAcesso | String | 255 | Liberação de Acesso (Todos/Específica) |
Lista de Parâmetros:
Campo | Parâmetro | Tipo | Precisão | Descrição |
---|---|---|---|---|
codEmpresa | :p1 | String/Integer | 10 | Código da empresa no ERP |
codTabela | :p2 | String/Integer | 255 | Código da tabela de preço no ERP |
Tabela de preço - Itens¶
Retornar a listagem de tabela de preços.
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | codTabela * | String | 255 | Código da Tabela de preço no ERP. |
2 | codProduto * | String | 255 | Código do produto no ERP. |
3 | codGrupoCor * | String | 255 | Código Grupo Cor. |
4 | nomeGrupoCor * | String | 255 | Descrição do Grupo Cor. |
5 | prazoMedio * | Integer | Identificar do prazo medio. | |
6 | padrao * | Integer | 1 se for preço padrão. 0 caso não seja. | |
7 | rendimento * | Double | Rendimento do produto. | |
8 | precoQuilo * | Double | Preço do produto por quilo. | |
9 | precoMetro * | Double | Preço do produto por metro. |
Lista de Parâmetros:
Campo | Parâmetro | Tipo | Precisão | Descrição |
---|---|---|---|---|
codEmpresa | :p1 | String/Integer | 10 | Código da empresa no ERP |
codTabela | :p2 | String/Integer | 255 | Código da tabela de preço no ERP |
Tabela de Preço - Clientes¶
Retornar a listagem de clientes de tabelas de preços.
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | codigoTabela | String | 255 | Código da Tabela de Preço |
2 | codigoCliente | String | 255 | Código do Cliente |
Tabela de Preço - Representante¶
Retornar a listagem de representantes de tabelas de preços.
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | codigoTabela | String | 255 | Código da Tabela de Preço |
2 | codigoRepresentante | String | 255 | Código do Representante |
Catalogos¶
Retornar a listagem de Catálogos.
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | codCatalogo * | String | 255 | Código do Catalogo no ERP. |
2 | nomeCatalogo * | String | 255 | Descrição do Catalogo no ERP. |
3 | status * | Integer | 1 quando estiver liberado. 0 quando estiver bloqueado. |
Lista de Parâmetros:
Campo | Parâmetro | Tipo | Precisão | Descrição |
---|---|---|---|---|
codEmpresa | :p1 | String/Integer | 10 | Código da empresa no ERP |
Acessórios de Produtos¶
Retornar a listagem de vinculo de produtos com acessórios.
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | codProduto * | String | 255 | Código do Produto no ERP. |
2 | codAcessorio (codProduto) * | String | 255 | Código do acessório no ERP. |
3 | multiplicador * | Double | Multiplicador proporcional entre a venda de um item principal e um acessório. EX: Se for inserido 18kg na quantidade principal e na integração estiver inserido que se aplica 0,250kg para cada kilo do principal, a quantidade a ser inserida automaticamente será 4,5kg. |
Lista de Parâmetros:
Campo | Parâmetro | Tipo | Precisão | Descrição |
---|---|---|---|---|
codEmpresa | :p1 | String/Integer | 10 | Código da empresa no ERP |
Lotes de Faturamento¶
Retornar o cadastro de lotes de faturamento
Campo | Tipo | Precisão | Descrição |
---|---|---|---|
dataLimite* | Date | Data Limite -- Data de referência | |
dataFaturamento* | Date | Data de faturamento | |
descricao* | String | Descrição do lote de faturamento | |
codErp | String | Código do lote no ERP (Necessário APENAS se for essencial para a gravação do Pedido) |
Campo | Parâmetro | Tipo | Precisão | Descrição |
---|---|---|---|---|
codEmpresa | :p1 | String/Integer | codEmpresa | |
dataReferencia | :p2 | Date | Data de referência |
Condição de Venda¶
Retorna a listagem de Condições de Venda do ERP.
Campo | Tipo | Precisão | Descrição |
---|---|---|---|
codEmpresa * | String/Integer | 10 | Código da Empresa origem dos dados |
codPagamento * | String/Integer | 255 | Código da condição de Venda no ERP |
nome | String | 255 | Nome da condição de venda |
qtdeParcelas | Integer | Número de parcelas da condição de venda | |
prazoMedio | Double | Prazo médio das parcelas da condição de venda | |
situacao | Integer | Situação conforme codificação: 0 - Inativo, 1 - Ativo | |
Parcelamento | String | Condição de Parcelamento EX:30/60/90 |
Lista de Parâmetros:
Campo | Parâmetro | Tipo | Precisão | Descrição |
---|---|---|---|---|
codEmpresa | :p1 | String/Integer | 10 | Código da empresa no ERP |
Listagem de Pedidos - Consulta¶
Retornar dados referentes a capa do pedido.
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | codEmpresa | String/Integer | 10 | Código da empresa no ERP |
2 | codCliente | String | 255 | Código do Cliente |
3 | nomeCliente | String | 255 | Nome do Cliente |
4 | codRepres | String | 255 | Código do Representante |
5 | pedAutomacao | String | 255 | Número do Lote de Gravação |
6 | codPedido | String | 255 | Código do Pedido no ERP |
7 | dataEmissao | Date | Data de Emissão do Pedido | |
8 | dataPrevFat | Date | Data de Previsão de Faturamento do Pedido | |
9 | situacao | Integer | 10 | Código da Situação no ERP |
10 | situacaoEdt | String | 255 | Descrição da Situação do Pedido |
11 | valorBruto | Double | Valor Bruto do Pedido | |
12 | valorLiquido | Double | Valor Liquido do Pedido | |
13 | valorSaldo | Double | Valor Saldo do Pedido | |
14 | qtdePedLiquida | Integer | Quantidade Pedida Liquida | |
15 | motivo | String | 255 | Motivo do pedido |
16 | pedidoCliente | String | 255 | Codigo do Pedido de controle do cliente |
17 | pedidoRepresentante | String | 255 | Codigo do Pedido de controle do representante |
18 | percComissao | Double | Percentual de comissão do pedido | |
19 | usuarioDigitacao | String | 255 | Usuário digitação do pedido |
20 | valorComissao | Double | Valor da comissão do pedido | |
21 | percDescGeral | Double | Percentual de desconto geral do pedido | |
22 | valorDesconto | Double | Valor total de desconto do pedido | |
23 | nomeColecao | String | 255 | Coleção do Pedido p/ Histórico de Pedidos |
24 | codTipoNota | String | 255 | Código do Tipo de nota p/ Histórico de Pedidos |
25 | currency | String | 255 | Config de moeda para o ISF, fixo 'R$' |
26 | nomeTipoNota | String | 255 | Nome do Tipo da Nota |
27 | motivoQuarentenaPedidos | String | 255 | Motivo Da Quarentena dos pedidos |
28 | atendente | String | 255 | Atendente do pedido |
29 | tabPrecoPedido | String | 255 | Tabela de Preço do Pedido |
30 | situacaoWorkFlow | String | 255 | Situação do Ppedido no WorkFlow |
31 | nomeRepres | String | 255 | Nome Representante |
32 | valorFaturado | Double | Valor Faturado | |
33 | qtdeEntregue | Double | Quantidade Entregue | |
34 | percEntrega | Double | Percentual de Entrega | |
35 | nomeFantasia | String | 255 | Nome Fantasia |
36 | nomeMarca | String | 255 | Marca do Pedido p/ Histórico de Pedidos |
37 | codCondVenda | String | 255 | Cod da Condição de Venda |
38 | nomeCondVenda | String | 255 | Nome da Condição de Venda |
39 | negociacao | String | 255 | Código da negociação, salvo pela GEO |
Lista de Parâmetros:
Formato sugerido de data: yyyy-mm-dd (2023-12-13)
Parâmetro | Tipo | Precisão | Descrição |
---|---|---|---|
:p1 | Date | (opcional) Data de Emissão do Pedido inicial | |
:p2 | Date | (opcional) Data de Emissão do Pedido final | |
:p3 | String | 10 | (opcional) Código do Cliente |
:p4 | String | (opcional) Nome do Cliente | |
:p5 | List<String> | (opcional) Tipo da nota do pedido | |
:p6 | List<String> | (opcional) Status do ERP | |
:p7 | String | 10 | (opcional) Código da negociacao |
:p8 | String | 10 | (opcional) Código do pedido |
:p9 | Date | (opcional) Data de previsão de faturamento inicial | |
:p10 | Date | (opcional) Data de previsão de faturamento final | |
:p11 | String | 10 | (opcional) Código do representante |
Listagem de Pedidos - Detalhamento da Capa¶
Retornar dados detalhados do pedido.
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | dataEmissao | Date | Data de Emissão do Pedido | |
2 | dataPrevFat | Date | Data de Previsão do Faturamento | |
3 | situacaoEdt | String | 255 | Descrição da Situação do Pedido |
4 | codCliente | String | 255 | Código do Cliente |
5 | nomeCliente | String | 255 | Nome do Cliente |
6 | cidadeCliente | String | 255 | Nome da Cidade do Cliente (cidade da venda) |
7 | ufCliente | String | 255 | Sigla do Estado do Cliente (estado da venda). |
8 | inscEstadual | String | 255 | Inscrição Estadual do Cliente |
9 | cnpjCliente | String | 255 | Cnpj do Cliente |
10 | codRepres | String | 255 | Código do Representante |
11 | percComissao | Double | Percentual de Comissão do Pedido | |
12 | codTabPreco | String | 255 | Código da Tabela de Preço |
13 | nomeTabPreco | String | 255 | Nome da Tabela de Preço |
14 | codCondVenda | String | 255 | Código da Condição de Venda |
15 | nomeCondVenda | String | 255 | Nome da Condição de Venda |
16 | codTranspDespacho | String | 255 | Código da Transportadora de Despacho |
17 | nomeTranspDespacho | String | 255 | Nome da Transportadora de Despacho |
18 | tipoFreteTranspDespacho | String | 255 | Tipo de Frete do Transporte de Despacho |
19 | codTranspRedespacho | String | 255 | Código da Transportadora de Redespacho |
20 | nomeTranspRedespacho | String | 255 | Nome da Transportadora de Redespacho |
21 | tipoFreteTranspRedespacho | String | 255 | Tipo de Frete do Transporte de Redespacho |
22 | codTipoNota | String | 255 | Código do Tipo de Nota |
23 | nomeTipoNota | String | 255 | Nome do Tipo de Nota |
24 | valorBruto | Double | Valor Bruto do Pedido | |
25 | valorLiquido | Double | Valor Liquido do Pedido | |
26 | valorSaldo | Double | Valor Saldo do Pedido | |
27 | percDesconto1 | Double | Percentual de Desconto 1 | |
28 | percDesconto2 | Double | Percentual de Desconto 2 | |
29 | percDesconto3 | Double | Percentual de Desconto 3 | |
30 | percDesconto4 | Double | Percentual de Desconto 4 | |
31 | percDesconto5 | Double | Percentual de Desconto 5 | |
32 | nomeFantasia | String | 255 | Nome Fantasia |
33 | emailCliente | String | 255 | E-mail do Cliente |
34 | pedidoCliente | String | 255 | Codigo do Pedido de controle do cliente |
35 | pedidoRepresentante | String | 255 | Codigo do Pedido de controle do representante |
36 | flagAntecipacaoPedido | Integer | Flag de antecipação | |
37 | flagPedidoParcial | Integer | Flag pedido parcial | |
38 | flagFaturamentoTriangular | Integer | Flag faturamento triangular | |
39 | endereco | String | 255 | Endereço |
40 | endNumero | String | 255 | Número do endereço |
41 | bairro | String | 255 | Bairro |
42 | complemento | String | 255 | Complemento |
43 | currency | String | 255 | Tipo de moeda |
44 | negociacao | Integer | Tipo de negociação | |
45 | observacaoPedido | String | 255 | Observação do Pedido |
46 | observacaoNota | String | 255 | Observação da Nota |
47 | nomeRepres | String | 255 | Nome do representante |
48 | codTriangulador | String | 255 | Código do Triangulador |
49 | nomeTriangulador | String | 255 | Nome do Triangulador |
Lista de Parâmetros:
Parâmetro | Tipo | Precisão | Descrição |
---|---|---|---|
:p1 | String/Integer | Código do pedido | |
:p2 | String/Integer | (opcional) Código da empresa |
Listagem de Pedidos - Itens¶
Retornar dados dos Itens do pedido.
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | codItem | String | 255 | Código do Item para Ordenação |
2 | codProduto | String | 255 | Código do Produto |
3 | nomeProduto | String | 255 | Nome do Produto |
4 | qtdePedida | Double | Quantidade Pedida do Produto | |
5 | valorPedidoBruto | Double | Quantidade Saldo Bruto do Produto | |
6 | valorPedidoLiquido | Double | Quantidade Saldo Liquido do Produto | |
7 | qtdeSaldo | Double | Quantidade Saldo | |
8 | valorSaldoBruto | Double | Quantidade Saldo Bruto do Produto | |
9 | valorSaldoLiquido | Double | Quantidade Saldo Liquido do Produto | |
10 | qtdeFaturado | Double | Quantidade Faturada do Produto | |
11 | valorFaturadoBruto | Double | Quantidade Saldo Bruto do Produto | |
12 | valorFaturadoLiquido | Double | Quantidade Saldo Liquido do Produto | |
13 | qtdeCancelada | Double | Quantidade Cancelada do Produto | |
14 | valorCanceladoBruto | Double | Quantidade Saldo Bruto do Produto | |
15 | valorCanceladoLiquido | Double | Quantidade Saldo Liquido do Produto | |
16 | valorUnitarioBruto | Double | Valor Unitário Bruto do Produto | |
17 | valorUnitarioLiquido | Double | Valor Unitário Liquido do Produto | |
18 | codVariante | String | 255 | Código da Variante do Item. |
19 | nomeVariante | String | 255 | Cor do Item. |
20 | codSKU | String | 255 | Código do SKU. |
21 | codColecao | String | 255 | Código da coleção |
22 | nomeColecao | String | 255 | Nome da coleção |
23 | codCategoria | String | 255 | Código da Categoria |
24 | nomeCategoria | String | 255 | Nome da Categoria |
25 | codLinha | String | 255 | Código da linha |
26 | nomeLinha | String | 255 | Nome da linha |
27 | codTipoPeca | String | 255 | Código do tipo de peça |
28 | nomeTipoPeca | String | 255 | Nome do tipo de peça |
29 | dataEntrega | String | 255 | Data de Entrega do Item. |
30 | acessorio | Boolean | Se o item é acessório. | |
31 | seqItemPai | Integer | Referência do item pai (Se for acessório) | |
32 | percComissao | Double | Percentual de comissão do item | |
33 | qualidadeSintetica | String | 255 | Qualidade Sintética do item |
34 | qualidadeAnalitica | String | 255 | Qualidade Analítica do item |
Lista de Parâmetros:
Parâmetro | Tipo | Precisão | Descrição |
---|---|---|---|
:p1 | String | 255 | Código do Pedido (É comparado com o "código do pedido no Erp" do "Listagem de Pedidos - Capa" e com o valor do "Pedido ERP" no botão azul de pedidos finalizados do FV) |
Listagem de Pedidos - Notas¶
Retornar dados das Notas Fiscais do pedido.
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | dataEmissao | Date | Data de Emissão da Nota Fiscal (timestamp) | |
2 | numeroNF | String | 255 | Número da Nota Fiscal (separar a série com /) |
3 | situacao | String | 255 | Situação da Nota Fiscal |
4 | valorLiquido | Double | Valor Total da Nota Fiscal | |
5 | codTransp | String | 255 | Código da Transportadora |
6 | nomeTransp | String | 255 | Nome da Transportadora |
7 | codRedespacho | String | 255 | Código do Redespacho |
8 | nomeRedespacho | String | 255 | Nome do Redespacho |
9 | chaveNFE | String | 255 | Chave da Nota Fiscal |
10 | qtdeFaturado | Double | Quantidade de quilos faturados | |
11 | dataEntrega | Date | Data de entrega da Nota Fiscal | |
12 | descSituacaoEntrega | String | Descrição da situação atual da entrega | |
13 | dataSaida | Date | Data de saida da Nota Fiscal | |
14 | tipo | String | Tipo da Nota Fiscal | |
15 | codPedido | String | Código do Pedido (se mais de um, separar por ponto e vírgula) | |
16 | pesoBruto | Double | Peso bruto | |
17 | pesoLiquido | Double | Peso líquido | |
18 | volumes | Integer | Quantidade de volumes da Nota Fiscal | |
19 | condPagamento | String | Condição de Pagamento da Nota Fiscal | |
20 | codCliente | String | Código do cliente |
Lista de Parâmetros:
Parâmetro | Tipo | Precisão | Descrição |
---|---|---|---|
:p1 | String | (opcional) codPedido (Utilizar comparador LIKE) | |
:p2 | String | (opcional) codCliente | |
:p3 | String | (opcional) numeroNf (separar a série com /) |
Listagem de Pedidos - Notas Itens¶
Retornar dados dos Itens das Notas Fiscais do pedido.
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | empresa | String | 255 | Nome da Empresa |
2 | numeroNF | String | 255 | Número da Nota Fiscal (separar a série com /) |
3 | sequenciaNF | String | 255 | Sequência do item na Nota Fiscal |
4 | codProduto | String | 255 | SKU do produto |
5 | descricao | String | 255 | Descrição do item |
6 | unidadeMedida | String | 255 | Unidade de medida do item |
7 | quantidade | Double | 255 | Quantidade do item |
8 | precoBruto | Double | 255 | Preço Bruto do item |
9 | precoLiquido | Double | 255 | Preço Líquido do item |
Listagem de Pedidos - Situação ERP¶
Retorna todas as situações de pedidos do ERP.
Campo | Tipo | Precisão | Descrição |
---|---|---|---|
situacaoEdt | String | 255 | Situação de pedido |
Listagem de Pedidos - Tipo Nota¶
Retorna todos os tipos de notas de pedidos do ERP.
Campo | Tipo | Precisão | Descrição |
---|---|---|---|
tipoNota | String | 255 | Tipo de nota de pedido |
Listagem de pedidos para conjugar¶
Retornar os pedido que podem ser utilizados pelo representante.
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | codPedido * | String | 255 | Código do Pedido no ERP |
2 | codCliente * | String | 255 | Código do Cliente ERP |
3 | codRepres * | String | 255 | Código do Representante |
4 | descricao * | String | 255 | Descrição utilizada para exibir para o representante |
Lista de Parâmetros:
Campo | Parâmetro | Tipo | Precisão | Descrição |
---|---|---|---|---|
codEmpresa | :p1 | String/Integer | 10 | Código da empresa no ERP |
codCliente | :p2 | String | 255 | Código do Cliente no ERP |
Triangulação¶
Retornar relação dos trianguladores (Geral, por representante ou por cliente).
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | codEmpresa * | String | 255 | Código da Empresa |
2 | codClienteTriangulacao * | String | 255 | Código do cliente triagulador |
3 | nomeClienteTriangulacao * | String | 255 | Nome do cliente de triangulação. O nome está aqui pois podem existir clientes onde a base de clientes de triangulação não é a mesma da de clientes de venda. |
4 | codClienteVenda | String | 255 | Código do cliente da venda a ser relacionado o cliente de triangulação (é opcional, se enviar nulo entende-se que o cliente de triangulação está disponível para todos os clientes de venda) |
5 | codRepresentante | String | 255 | Código do representante a ser relacionado o cliente de triangulação (é opcional, se enviar nulo entende-se que o cliente de triangulação está disponível para todos os representantes) |
Transportadoras¶
Retornar relação das transportadoras
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | codEmpresa * | String | 255 | Código da Empresa |
2 | codTransportadora * | String | 255 | Código da transportadora |
3 | nomeTransportadora * | String | 255 | Nome da transportadora. |
4 | situacao | Inteiro | 1 - Ativo / 0 - Inativo |
Comissões - Extrato Resumo¶
Retornar de forma resumida os resultados dos meses de comissões
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | anoMes | Integer | 6 | Ano/mês de referencia ex: 201708 |
2 | flagMesFechado | Integer | 1 | Identificador para a situação do mês (0 - Em Aberto(Box Amarelo) / 1 - Fechado (Box Verde) |
3 | valorIRF | Double | Valor de IR Total | |
4 | valorLiquido | Double | Valor líquido | |
5 | valorBruto | Double | Valor bruto |
Lista de Parâmetros:
Parâmetro | Tipo | Precisão | Descrição |
---|---|---|---|
:p1 | List<String/Integer> | anoMes | |
:p2 | String | Código do representante |
Comissões - Extrato Detalhado¶
Retornar de extrato detalhado das comissões
Os 5 primeiros campos, são os mesmos retornados na Integração Anterior, os valores deles são referentes ao total do periodo
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | anoMes | Integer | 6 | Ano/mês de referencia ex: 201708 |
2 | flagMesFechado | Integer | 1 | Identificador para a situação do mês (0 - Em Aberto(Box Amarelo) / 1 - Fechado (Box Verde) |
3 | valorIRF | Double | Valor de IR Total | |
4 | valorLiquido | Double | Valor líquido | |
5 | valorBruto | Double | Valor bruto | |
6 | dataLcto | Date | Data do registro | |
7 | lancamento | Integer | Identificador do registro (usado para ordenação) | |
8 | cliente | String | 255 | Código do do Cliente |
9 | baseComissao | Double | Valor base para calculo da comissão | |
10 | percBaseComissao | Double | Percentual Base Cálculo comissão | |
11 | percComiss | Double | Percentual de comissão | |
12 | valorCredito | Double | Valor para credito | |
13 | valorDebito | Double | Valor para debito | |
14 | observacao | String | 255 | Historico ou Descrição do lançamento |
15 | codPedido | String | 255 | Código do pedido |
16 | numeroNF | String | 255 | Número da Nota Fiscal (separar a série com /) |
17 | titulo | String | 255 | Título da comissão |
18 | representante | String | 255 | Código do representante |
Lista de Parâmetros:
Parâmetro | Tipo | Precisão | Descrição |
---|---|---|---|
:p1 | String/Integer | anoMes | |
:p2 | String | Código do representante |
Títulos¶
Retornar a listagem de títulos (duplicatas) dos clientes do representante.
Atenção! Para que o cliente seja impedido de fazer pedidos por possuir títulos vencidos, independente do representante, deve-se retornar o título para todos os representantes da carteira do cliente e não o representante do título.
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | titulo * | String/Integer | 255 | Chave única do título no ERP |
2 | numeroNf | String/Integer | 255 | Número da nota fiscal ou documento (separar a série com /) |
3 | dataEmissao | Date | Data de Emissão do título | |
4 | dataVecto | Date | Data de Vencimento do título | |
5 | valor | Double | Valor do título em aberto | |
6 | nomePortador | String/Integer | 255 | Nome/Descrição do portador |
7 | codCliente | String/Integer | 255 | Código do cliente |
8 | nomeCliente | String/Integer | 255 | Nome do cliente |
9 | codgrupocliente | String/Integer | 255 | Código do grupo do cliente |
10 | moeda | String/Integer | 255 | Moeda (O padrão é R$, deixar null) |
11 | nomeFantasiaCliente | String | 255 | Nome fantasia do cliente |
12 | dataPagamento | Date | Data de pagamento do título | |
13 | condVenda | String | 255 | Condição de Venda |
14 | diasAtraso | Integer | Número de dias de atraso | |
15 | desconto | Double | Desconto | |
16 | baseComLiq | Double | Valor do título após aplicação do desconto | |
17 | valorJuros | Double | Valor do Juros | |
18 | valorPago | Double | Valor pago | |
19 | codRepresentante | String | 255 | Código do representante |
20 | situacao | Integer | 1 - VENCIDO / 2 - À VENCER / 3 - PAGO APÓS VENCIMENTO / 4 - PAGO ANTES DO VENCIMENTO |
Lista de Parâmetros:
Parâmetro | Tipo | Precisão | Descrição |
---|---|---|---|
:p1 | Date | (opcional) Data de emissão inicial | |
:p2 | Date | (opcional) Data emissão final | |
:p3 | Date | (opcional) Data vencimento inicial | |
:p4 | Date | (opcional) Data vencimento final | |
:p5 | String | (opcional) Código do cliente | |
:p6 | String | (opcional) Código do representante | |
:p7 | String | (opcional) Número da nota fiscal ou documento | |
:p8 | String | (opcional) Chave única do título no ERP | |
:p9 | List<String> | (opcional) Situação |
Tipo de Cobrança¶
Retornar a listagem de tipos de cobranças da condição de pagamento.
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | codigo | String | 255 | Código do Tipo de Cobrança |
2 | descricao | String | 255 | Descrição do Tipo de Cobrança |
3 | codEmpresa | String | 255 | Código da empresa |
Lista de Parâmetros:
Parâmetro | Tipo | Precisão | Descrição |
---|---|---|---|
:p1 | String/Integer | (opcional) Código da empresa |
Condição de Pagamento¶
Retornar a listagem de condição de pagamento.
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | nome* | String | 255 | Nome da condição de pagamento |
2 | condicaoVenda* | Long | 255 | Condição de Venda ERP |
3 | portador | String | 255 | Portador |
4 | tipoCobranca | String | 255 | Código doTipo de cobrança |
5 | prazoMedio* | Double | 255 | Prazo médio |
6 | qtdeParcelas | Integer | 255 | Quantidade de Parcelas |
7 | disponivelForcaVendas | Boolean | 255 | Disponível no força de vendas |
8 | disponivelEcommerce | Boolean | 255 | Disponível no E-commerce |
9 | valorMinimo | Double | 255 | Valor mínimo para apresentação |
Campos Customizados¶
Retornar as informações dos Campos Customizados
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | codCliente * | String | 255 | Cod do Cliente |
2 | codIdentificador * | String | 255 | Código do identificador |
3 | idCampoCustomizado * | String | 255 | Id do campo Customizado Criado no FV Malharia |
4 | valorCampoCustomizado * | String | 255 | Valor que vai retornar no Campo. |
Lista de Parâmetros:
Parâmetro | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
:p1 | codEmpresa | String/Integer | 10 | Código da Empresa |
:p2 | codRepres | String/Integer | 10 | Código do Representante |
Partidas de Pedidos¶
Nessa consulta será possível consultar as partidas dos pedidos efetuados.
Pos | Campo | Tipo | Precisão | Descrição |
---|---|---|---|---|
1 | anoPartida | String | Retorna a informação de mês e ano da partida no formato AAAAMM | |
2 | codPartida | String | Código da partida no ERP | |
3 | situacao | Integer | código da situação atual da partida | |
4 | codPedido | String | Código do pedido no ERP ao qual a partida pertence | |
5 | sequenciaItem | Integer | Sequência da partida na produção de acordo com o pedido | |
6 | dataEmissao | Date | Data de início da produção da partida no formato AAAA-MM-DD | |
7 | dataPrevisaoFaturamento | Date | Data de previsão de faturamento da partida no formato AAAA-MM-DD | |
8 | codReferencia | String | Código da referência no ERP | |
9 | codVariante | String | ||
10 | qtdeQuilos | Double | (10, 2) | Quantidade em kg da partida |
11 | qtdePecas | Integer | Quantidade de rolos da partida | |
12 | nomeProcessoAtual | String | Nome do processo atual que a partida se encontra | |
13 | nomeProcessoSeguinte | String | Nome da próxima etapa do fluxo de partidas | |
14 | dataBaixa | Date | Data da baixa final da partida no formato AAAA-MM-DD | |
15 | loteCliente | String | Lote do cliente | |
16 | descProduto | String | Descrição do produto | |
17 | codCliente | String | Código do cliente | |
18 | nomeCliente | String | Razão social do cliente | |
19 | codEmpresa | String | Código do empresa | |
20 | codProduto | String | Código do produto | |
21 | codRepres | String | Código do representante |
Parâmetros da Consulta
Parâmetro | Campo | Tipo | Precisão / Tamanho / Formato | Descrição | Obrigatório |
---|---|---|---|---|---|
:p1 | codEmpresa | String | Código da empresa dentro do ERP | Não | |
:p2 | codCliente | String | Código do cadastro do cliente no ERP | Não | |
:p3 | dataEmissaoInicial | Date | AAAA-MM-DD | Data inicial para consulta com base na data de emissão | Sim |
:p4 | dataEmissaoFinal | Date | AAAA-MM-DD | Data final para consulta com base na data de emissão | Sim |
:p5 | dataPrevisaoInicial | Date | AAAA-MM-DD | Data inicial para consulta com base na data de previsão | Não |
:p6 | dataPrevisaoFinal | Date | AAAA-MM-DD | Data final para consulta com base na data de previsão | Não |
:p7 | codPedido | String | Código do pedido no ERP | Não | |
:p8 | codProduto | String | Código do produto no ERP | Não | |
:p9 | codRepres | String | Código do representante no ERP | Não |
Lista pública de clientes¶
Nessa consulta será possível consultar a lista pública de clientes.
Pos | Campo | Tipo | Precisão / Tamanho / Formato | Descrição |
---|---|---|---|---|
1 | codCliente | String | Código do cliente no ERP | |
2 | cnpj | String | CNPJ do cliente | |
3 | razaoSocial | String | Razão social do cliente | |
4 | telefone | String | Telefone do cliente | |
5 | pessoaContato | String | Pessoa de contato | |
6 | endereco | String | Endereço completo (Rua, Nº, Bairro) | |
7 | cep | String | CEP do endereço | |
8 | cidade | String | Cidade do cliente | |
9 | uf | String | Estado do cliente | |
10 | dataUltimaCompra | Date | Data da ultima compra do cliente no formato AAAA-MM-DD | |
11 | valorUltimaCompra | Double | Valor da ultima compra do cliente | |
12 | codRepres | String | Código do representante no ERP |
Parâmetros da Consulta
Parâmetro | Campo | Tipo | Precisão / Tamanho / Formato | Descrição | Obrigatório |
---|---|---|---|---|---|
:p1 | codCliente | String | Código do cliente no ERP | Não | |
:p2 | cidade | String | Cidade do cliente | Não | |
:p3 | codRepres | String | Código do representante | Não | |
:p4 | dataUltimaCompraInicial | Date | AAAA-MM-DD | Data inicial para consulta com base na data de ultima compra | Não |
:p5 | dataUltimaCompraFinal | Date | AAAA-MM-DD | Data final para consulta com base na data de última compra | Não |
Carga Maquina¶
Nessa consulta será possível consultar os dados de Carga Maquina.
Pos | Campo | Tipo | Precisão / Tamanho / Formato | Descrição |
---|---|---|---|---|
1 | codigo | String | Código da máquina | |
2 | produto | String | ||
3 | maquina | String | ||
4 | qtdeProduto | String | ||
5 | qtdeAcessorio | String | ||
6 | qtdeMinima | String | ||
7 | qtdeMaxima | String | ||
8 | Bocas | String |