Integração Analytics

h1. Digitação de Pedidos

*Índice* 

# [[Digitação de Pedidos#Introdução|Introdução]] 

# [[Digitação de Pedidos#Acesso-via-JDBC|Acesso via JDBC]] 

# [[Digitação de Pedidos#Tabelas-de-Integração-Parâmetros-e-Exemplo-de-SQL-de-Integração|Tabelas de Integração, Parâmetros e Exemplo de SQL de Integração]]

## [[Digitação de Pedidos#Tabelas-de-Integração|Tabelas de Integração]]

## [[Digitação de Pedidos#Parâmetros|Parâmetros]]

## [[Digitação de Pedidos#Exemplo-de-SQL-de-Integração|Exemplo de SQL de Integração]]

# [[Digitação de Pedidos#Layouts-de-Integração|Layouts de Integração]]

## [[Digitação de Pedidos#Tabela-de-Preço|Tabela de Preço]]

## [[Digitação de Pedidos#Tabela-de-Preço-Produto|Tabela de Preço - Produto]]

## [[Digitação de Pedidos#Títulos-Em-Aberto|Títulos Em Aberto]]

## [[Digitação de Pedidos#Condição-de-Venda|Condição de Venda]]

## [[Digitação de Pedidos#Tipo-de-Nota|Tipo de Nota]]

## [[Digitação de Pedidos#Comissões|Comissões]]

## [[Digitação de Pedidos#Clientes|Clientes]]

## [[Digitação de Pedidos#Produtos|Produtos]]

## [[Digitação de Pedidos#Produtos-Grades|Produtos - Grades]]

## [[Digitação de Pedidos#Produtos-Sortimentos|Produtos - Sortimentos]]

## [[Digitação de Pedidos#Produto-Código-Reduzido|Produto - Código Reduzido]] (opcional)

## [[Digitação de Pedidos#Pedido-Capa|Pedido - Capa]]

## [[Digitação de Pedidos#Listagem-de-Pedidos-Capa|Listagem de Pedidos - Capa]]

## [[Digitação de Pedidos#Listagem-de-Pedidos-Detalhado|Listagem de Pedidos - Detalhado]]

## [[Digitação de Pedidos#Listagem-de-Pedidos-Itens|Listagem de Pedidos - Itens]]

## [[Digitação de Pedidos#Listagem-de-Pedidos-Notas|Listagem de Pedidos - Notas]]

h1. 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 IBTech.

Dúvidas ou maiores esclarecimentos podem ser obtidos pelo e-mail suporte@ibtech.inf.br ou pelo telefone (47) 3370-0504.

h1. 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 IBTech 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 IBTech fará acesso via JDBC à base de dados do cliente para extrair as informações.

h1. Tabelas de Integração, Parâmetros e Exemplo de SQL de Integração

h2. 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.

h2. 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.

h2. 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*

<pre>SELECT codEmpresa,

codTabela,

descricao

FROM TabelaDePreco

WHERE codEmpresa = :p1

  AND codTabela = :p2</pre>

h1. Layouts de Integração

Segue os layouts que devem servir de base para construção dos SQLs de integração.

h2. Tabela de Preço

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 |

h2. Tabela de Preço - Produto

Retornar a listagem dos produtos da 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 |

| codProduto *  | String/Integer   | 255        | Código do produto no ERP |

| codGrade *  | String/Integer   | 255        | Código da grade de produto no ERP |

| preco    | Double   |            | Preço 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 |

| codTabela | :p2     | String/Integer   | 255         | Código da tabela de preços no ERP |

h2. Títulos Em Aberto

Retornar a listagem de títulos (duplicatas) que estão em aberto para os cliente do representante.

|_. Campo      |_. Tipo   |_. Precisão |_. Descrição |

| titulo * | String/Integer   | 255         | Chave única do título no ERP |

| notaFiscal  | String/Integer   | 255        | Número da nota fiscal ou documento |

| dataEmissao  | Date   |         | Data de Emissão do título |

| dataVecto  | Date   |         | Data de Vencimento do título |

| valor    | Double   |            | Valor do título em aberto |

| nomePortador  | String/Integer   | 255        | Nome/Descrição do portador |

| codCliente  | String/Integer   | 255        | Código do cliente |

| nomeCliente  | String/Integer   | 255        | Nome do cliente |

Lista de Parâmetros:

|_. Campo |_. Parâmetro      |_. Tipo   |_. Precisão |_. Descrição |

| codEmpresa | :p1     | String/Integer   | 10         | Código da empresa no ERP |

| codRepresentante | :p2     | String/Integer   | 255         | Código do representante no ERP |

h2. 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 |

Lista de Parâmetros:

|_. Campo |_. Parâmetro      |_. Tipo   |_. Precisão |_. Descrição |

| codEmpresa | :p1     | String/Integer   | 10         | Código da empresa no ERP |

h2. Tipo de Nota

Retorna a listagem de Tipos de Nota do ERP.

|_. Campo      |_. Tipo   |_. Precisão |_. Descrição |

| codEmpresa * | String/Integer   | 10         | Código da Empresa origem dos dados |

| codTipo *  | String/Integer   | 255        | Código do tipo de nota no ERP |

| nome         | String   | 255        | Nome/descrição do tipo de nota |

Lista de Parâmetros:

|_. Campo |_. Parâmetro      |_. Tipo   |_. Precisão |_. Descrição |

| codEmpresa | :p1     | String/Integer   | 10         | Código da empresa no ERP |

h2. Comissões

Retorna informações de comissão para o representante filtrado.

|_. Campo      |_. Tipo   |_. Precisão |_. Descrição |

| tipo * | Integer   |          | Tipo de comissão: 1 - No Faturamento, 2 - Na Liquidação |

| dataReferencia *  | Date   |         | Data de referência da comissão |

| codTitulo *        | String   | 255        | Título de referência da comissão. Sugestão: no caso do tipo 1 trazer o número da nota fiscal, no caso do tipo 2 trazer o número do título |

| codCliente | String | 255 | Código do cliente relacionado a comissão |

| nomeCliente | String | 255 | Código do cliente relacionado a comissão |

| baseComissaoLiq | Double |  | Valor base líquido usado no cálculo da comissão |

| valorComissaoLiq | Double |  | Valor líquido da comissão |

Lista de Parâmetros:

|_. Campo |_. Parâmetro      |_. Tipo   |_. Precisão |_. Descrição |

| codEmpresa | :p1     | String/Integer   | 10         | Código da empresa no ERP |

| codRepresentante | :p2     | String/Integer   | 255         | Código do representante no ERP |

| dataReferencia | :p3     | Date   |          | Data de Referência - utilizar sinal de (>=) maior igual |

h2. Clientes

Retornar a listagem de clientes de um representante.

|_. Campo      |_. Tipo   |_. Precisão |_. Descrição |

| codEmpresa * | String/Integer   | 10         | Código da Empresa origem dos dados |

| codCliente * | String | 255 | Código do cliente no ERP |

| cnpj * | String | 255 | CNPJ ou CPF do cliente (somente números) |

| nomeFantasia | String | 255 | Nome fantasia do cliente |

| razaoSocial | String | 255 | Razão social do cliente |

| situacao | Integer | | Situação conforme codificação: 0 - Inativo, 1 - Ativo |

| telefone | String | 255 | Telefone do cliente |

| email | String | 255 | Endereço de e-mail padrão do cliente |

| emailNFE | String | 255 | Endereço de e-mail para Nota Fiscal Eletrônica do do cliente |

| codIBGE | String | 255 | Código IBGE da cidade do cliente |

| endereco | String | 255 | Endereço do cliente sem o número. Caso o número estiver gravado no mesmo cliente, contate a IBTech para discutir uma solução. |

| enderecoNumero | String | 255 | Número do endereço do cliente do cliente |

| bairro | String | 255 | Bairro do cliente |

| cep | String | 255 | CEP do cliente (somente números) |

| dataCadastro | Date | | Data de cadastro do cliente |

| inscricaoEstadual | String | 255 | Inscrição estadual do cliente |

| inscricaoSUFRAMA | String | 255 | Inscrição SUFRAMA do cliente se houver |

| flagConsumidorFinal | Integer | | Consumidor final: 0 - Não, 1 - Sim |

| cobrancaEmail | String | 255 | Endereço de e-mail de cobrança do cliente |

| cobrancaContato | String | 255 | Nome da pessoal de contato de cobrança do cliente |

| cobrancaTelefone | String | 255 | Telefone da pessoal de contato de cobrança do cliente | 

| comprasEmail | String | 255 | Endereço de e-mail de compras do cliente | 

| comprasContato | String | 255 | Nome da pessoal de contato de compras do cliente |

| comprasTelefone | String | 255 | Telefone da pessoal de contato de compras do cliente | 

| avaliacaoRepres | Text |  | (opcional) Observação de avaliação do representante sobre o cliente (somente informação digitada pelo representante) | 

| celular | String | 255 | Celular de contato do cliente |

| fax | String | 255 | Celular de contato do cliente |

| flagClienteFinal | Integer | | Cliente Fiel/Especial: 0 - Não, 1 - Sim |

Lista de Parâmetros:

|_. Campo |_. Parâmetro      |_. Tipo   |_. Precisão |_. Descrição |

| codEmpresa | :p1     | String/Integer   | 10         | Código da empresa no ERP |

| codRepresentante | :p2     | String/Integer   | 255         | Código do representante no ERP |

h2. Produtos

Retornar a listagem de produtos ATIVOS filtrando coleção.

|_. Campo      |_. Tipo   |_. Precisão |_. Descrição |

| codReferencia * | String/Integer   | 255 | Código da Referência no ERP |

| descricao | String | 255 | Descrição da referência |

| codEtiqueta | String | 255 | Código da Etiqueta (ou Marca) da referência. Consultar a IBTech sobre o que trazer neste campo. |

| nomeEtiqueta | String | 255 | Nome da Etiqueta (ou Marca) da referência. Consultar a IBTech sobre o que trazer neste campo. |

| codLinha | String | 255 | Código da Linha de Produto da referência. |

| nomeLinha | String | 255 | Nome da Linha de Produto da referência. |

| codTipoPeca | String | 255 | Código do Tipo de Peça da referência. Consultar a IBTech sobre o que trazer neste campo. |

| nomeTpoPeca | String | 255 | Nome do Tipo de Peça da referência. Consultar a IBTech sobre o que trazer neste campo. |

| codTipoModelo | String | 255 | Código do Tipo Modelo da referência. Consultar a IBTech sobre o que trazer neste campo. |

| nomeTipoModelo | String | 255 | Nome do Tipo Modelo da referência. Consultar a IBTech sobre o que trazer neste campo. |

| preco | Double | | DEPRECIADO. retornar zero (não há necessidade de incluir na view) | 

Lista de Parâmetros:

|_. Campo |_. Parâmetro      |_. Tipo   |_. Precisão |_. Descrição |

| codEmpresa | :p1     | String/Integer   | 10         | Código da empresa no ERP |

| codColecao | :p2     | String/Integer   | 255         | Código da coleção da referência no ERP |

h2. Produtos - Grades

Retornar a listagem das grades ATIVAS dos produtos filtrando coleção.

|_. Campo      |_. Tipo   |_. Precisão |_. Descrição |

| codReferencia * | String/Integer   | 255 | Código da Referência no ERP |

| codGrade * | String/Integer   | 255 | Código da Grade no ERP |

| seqTamanho * | Integer |  | Código do tamanho na grade no ERP |

| seqOrdenacao * | Integer |  | Sequencia de ordenação do tamanho na grade |

| codTamanho * | String | 255 | Descrição do tamanho no ERP (Ex: "P") |

| qtdPalito | Integer | | Quantidade de peças para grade palito |

Lista de Parâmetros:

|_. Campo |_. Parâmetro      |_. Tipo   |_. Precisão |_. Descrição |

| codEmpresa | :p1     | String/Integer   | 10         | Código da empresa no ERP |

| codColecao | :p2     | String/Integer   | 255         | Código da coleção da referência no ERP |

h2. Produtos - Sortimentos

Retornar a listagem dos sortimentos ATIVOS dos produtos filtrando coleção.

|_. Campo      |_. Tipo   |_. Precisão |_. Descrição |

| codReferencia * | String/Integer   | 255 | Código da Referência no ERP |

| codSortimento * | String/Integer   | 255 | Código do Sortimento no ERP |

| descricao | String | 255 | Descrição do sortimento no ERP |

| codCorBase | String | 255 | Código da cor comercial (usada no catalogo) |

Lista de Parâmetros:

|_. Campo |_. Parâmetro      |_. Tipo   |_. Precisão |_. Descrição |

| codEmpresa | :p1     | String/Integer   | 10         | Código da empresa no ERP |

| codColecao | :p2     | String/Integer   | 255         | Código da coleção da referência no ERP |

h2. Produto - Código Reduzido

Retornar o código reduzido para o produto (referecia, cor e tamanho)

|_. Campo      |_. Tipo   |_. Precisão |_. Descrição |

| codReduzido * | String/Integer   | 255 | Código reduzido do produto no ERP |

| seqTamanho * | String/Integer   | 255         | Código do tamanho no ERP |

| seqTamOrdenacao | Integer   |          | Sequencia de ordenação do tamanho no ERP |

| seqSortimento * | String/Integer   | 255         | Código da sortimento no ERP |

| seqSortOrdenacao | Integer   |          | Sequencia de ordenação do sortimento no ERP |

| codColecao | String/Integer   | 255         | Código da coleção da referencia no ERP |

Lista de Parâmetros:

|_. Campo |_. Parâmetro      |_. Tipo   |_. Precisão |_. Descrição |

| codEmpresa | :p1     | String/Integer   | 10         | Código da empresa no ERP |

| codReferencia | :p2     | String/Integer   | 255         | Código da referência no ERP |

h2. Pedido - Capa

Retornar a situação do pedido no ERP.

|_. Campo      |_. Tipo   |_. Precisão |_. Descrição |

| codPedido * | String/Integer   | 255 | Código do pedido no ERP |

| situacao | Integer   | | Situação do pedido no ERP. 

Pedido FATURADO: 99

Pedido CANCELADO: 98

Demais situações: retornar código do ERP |

| descSituacao | String | 255 | Descrição da situação |

Lista de Parâmetros:

|_. Campo |_. Parâmetro      |_. Tipo   |_. Precisão |_. Descrição |

| codEmpresa | :p1     | String/Integer   | 10         | Código da empresa no ERP |

| codPedido | #PEDIDOS | | | Qualificar no WHERE como IN |

h2. Listagem de Pedidos - Capa

Retornar dados referentes a capa do pedido.

|_. Campo      |_. Tipo   |_. Precisão |_. Descrição |

| codEmpresa | String/Integer | 10 | Código da empresa no ERP |

| codCliente | String | 255 | Código do Cliente |

| nomeCliente | String | 255 | Nome do Cliente |

| codRepres | String | 255 | Código do Representante |

| pedAutomacao | String | 255 | Número do Lote de Gravação |

| codPedido | String | 255 | Código do Pedido no ERP |

| dataEmissao | Date | | Data de Emissão do Pedido |

| dataPrevFat | Date | | Data de Previsão de Faturamento do Pedido |

| situacao | Integer | 10 | Código da Situação no ERP |

| situacaoEdt | String | 255 | Descrição da Situação do Pedido |

| valorBruto | Double | | Valor Bruto do Pedido |

| valorLiquido | Double | | Valor Liquido do Pedido |

| valorSaldo | Double | | Valor Saldo do Pedido |

Lista de Parâmetros:

_Formato sugerido de data: dd/mm/yyyy (31/12/2013)_

|_. Parâmetro               |_. Tipo  |_. Precisão |_. Descrição                    |

| :pDataEmissao          | Date     |             | Data de Emissão do Pedido |

| :pCodRepresentante   | String   | 10         | (opcional) Código do Representante   |

| :pCodTabPreco          | String   | 10         | (opcional) Código da Tabela de Preço |

h2. Listagem de Pedidos - Detalhado

Retornar dados detalhados do pedido.

|_. Campo      |_. Tipo   |_. Precisão |_. Descrição |

| dataEmissao | Date | | Data de Emissão do Pedido |

| dataPrevFatur | Date | | Data de Previsão do Faturamento |

| situacaoEdt | String | 255 | Descrição da Situação do Pedido |

| codCliente | String | 255 | Código do Cliente |

| nomeCliente | String | 255 | Nome do Cliente |

| cidadeCliente | String | 255 | Nome da Cidade do Cliente (cidade da venda) |

| ufCliente | String | 255 | Sigla do Estado do Cliente (estado da venda). |

| inscEstadual | String | 255 | Inscrição Estadual do Cliente | 

| cnpjCliente | String | 255 | Cnpj do Cliente |

| codRepres | String | 255 | Código do Representante |

| percComissao | Double | | Percentual de Comissão do Pedido |

| codTabPreco | String | 255 | Código da Tabela de Preço |

| nomeTabPreco | String | 255 | Nome da Tabela de Preço |

| codCondVenda | String | 255 | Código da Condição de Venda |

| nomeCondVenda | String | 255 | Nome da Condição de Venda |

| codTranspDespacho | String | 255 | Código da Transportadora de Despacho | 

| nomeTranspDespacho | String | 255 | Nome da Transportadora de Despacho | 

| tipoFreteTranspDespacho | String | 255 | Tipo de Frete do Transporte de Despacho |

| codTranspRedespacho | String | 255 | Código da Transportadora de Redespacho |

| nomeTranspRedespacho | String | 255 | Nome da Transportadora de Redespacho | 

| tipoFreteTranspRedespacho | String | 255 | Tipo de Frete do Transporte de Redespacho |

| codTipoNota | String | 255 | Código do Tipo de Nota |

| nomeTipoNota | String | 255 | Nome do Tipo de Nota |

| observacao | String | 255 | Observação do Pedido |

| valorBruto | Double | | Valor Bruto do Pedido |

| valorLiquido | Double | | Valor Liquido do Pedido |

| valorSaldo | Double | | Valor Saldo do Pedido |

Lista de Parâmetros:

|_. Parâmetro  |_. Tipo  |_. Precisão |_. Descrição         |

| :pCodPedido | String   |  255          | Código do Pedido |

h2. Listagem de Pedidos - Itens

Retornar dados dos Itens do pedido.

|_. Campo  |_. Tipo   |_. Precisão |_. Descrição |

| codItem | String | 255 | Código do Item para Ordenação |

| codProduto | String | 255 | Código do Produto |

| nomeProduto | String | 255 | Nome do Produto |

| qtdePedida | Double | | Quantidade Pedida do Produto |

| qtdeSaldo | Double | | Quantidade Saldo do Produto |

| qtdeFaturado | Double | | Quantidade Faturada do Produto |

| qtdeCancelada | Double | | Quantidade Cancelada do Produto |

| valorUnitarioBruto | Double | | Valor Unitário Bruto do Produto |

| valorUnitarioLiquido | Double | | Valor Unitário Liquido do Produto |

| valorTotal | Double | | Valor Total do Produto |

Lista de Parâmetros:

|_. Parâmetro  |_. Tipo  |_. Precisão |_. Descrição         |

| :pCodPedido | String   |  255          | Código do Pedido |

h2. Listagem de Pedidos - Notas

Retornar dados das Notas Fiscais do pedido.

|_. Campo  |_. Tipo   |_. Precisão |_. Descrição |

| dataEmissao | Date | | Data de Emissão da Nota Fiscal |

| numeroNF | String | 255 | Número da Nota Fiscal |

| situacao | String | 255 | Situação da Nota Fiscal |

| valorLiquido | Double | | Valor Total da Nota Fiscal |

| codTransp | String | 255 | Código da Transportadora |

| nomeTransp | String | 255 | Nome da Transportadora |

| codRedespacho | String | 255 | Código do Redespacho |

| nomeRedespacho | String | 255 | Nome do Redespacho |

| chaveNFE | String | 255 | Chave da Nota Fiscal |

Lista de Parâmetros:

|_. Parâmetro  |_. Tipo  |_. Precisão |_. Descrição         |

| :pCodPedido | String   |  255          | Código do Pedido |