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-por-Representante|Tabela de Preço por Representante]] (opcional - somente se ERP possui esse controle)

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

## [[Digitação de Pedidos#Tabela-de-Preço-Política-Desconto-Comercial|Tabela de Preço - Política - Desconto Comercial]] (opcional)

## [[Digitação de Pedidos#Tabela-de-Preço-Política-Desconto-Financeiro|Tabela de Preço - Política - Desconto Financeiro]] (opcional)

## [[Digitação de Pedidos#Tabela-de-Preço-Política-Desconto-Antecipação|Tabela de Preço - Política - Desconto Antecipação]] (opcional)

## [[Digitação de Pedidos#Tabela-de-Preço-Política-Prazo-Adicional|Tabela de Preço - Política - Prazo Adicional]] (opcional)

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

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

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

## [[Digitação de Pedidos#Tipo-de-Cobrança|Tipo de Cobrança]](opcional)

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

## [[Digitação de Pedidos#Comissões-Extrato-Resumo|Comissões - Extrato Resumo]] (opcional)

## [[Digitação de Pedidos#Comissões-Extrato-Detalhado|Comissões - Extrato Detalhado]] (opcional)

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

## [[Digitação de Pedidos#Clientes-Locais-de-Entrega|Clientes - Locais de Entrega]](opcional)

## [[Digitação de Pedidos#Clientes-Ramos-de-Atividade|Clientes - Ramos de Atividade]](opcional)

## [[Digitação de Pedidos#Clientes-Grupos-de-Cliente|Clientes - Grupos de Cliente]](opcional)

## [[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 - somente se ERP precisa do código reduzido)

## [[Digitação de Pedidos#Produto-EAN13|Produto - EAN13]] (opcional)

## [[Digitação de Pedidos#Bloqueio-de-Referências|Bloqueio de Referências]](opcional)

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

## [[Digitação de Pedidos#Pedidos-por-Referência|Pedidos por Referência]] (opcional)

## [[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]]

## [[Digitação de Pedidos#Listagem-de-Pedidos-Observções|Listagem de Pedidos - Observações]] (opcional)

## [[Digitação de Pedidos#Listagem-de-Pedidos-Histórico|Listagem de Pedidos - Histórico]] (opcional)

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

## [[Digitação de Pedidos#Lote Entrega|Lote Entrega]]

## [[Digitação de Pedidos#Cálculo substituição tributária]]

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 |

| dataMinimaFaturamento | Date | | Data mínima de faturamento |

| dataMaximaFaturamento | Date | | Data máxima de faturamento |

| dataVigenciaInicial | Date | | Data de vigência inicial |

| dataVigenciaFinal | Date | | Data de vigência final |

| percDescontoShowRoom | Double | | Percentual de desconto para show room |

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 por Representante

Carrega as tabelas de preço de acordo com a ligação delas com o representante. Retornar somente as ativas.

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

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

| codRepres | :p2     | String/Integer   | 255         | Código do representante |

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 |

| seqSortimento  | String/Integer   | 255        | Código da sortimento no ERP (opicional, somente para quem utiliza venda agrupada/look) |

| itemAtivo  | Integer   | 1        | Situação do item no ERP (0 - Inativo, 1 - Ativo) |

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 |

| codColecao | #COLECOES | | | Qualificar no WHERE como IN |

h2. Tabela de Preço - Política - Desconto Comercial

Retornar a política de desconto comercial da tabela de preço do ERP.

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

| valorInicio | Double   |            | |

| valorFim | Double   |            | |

| qtdePecasIni | Integer | | |

| qtdePecasFim | Integer | | |

| percDesconto | Double | | |

| perccomissao | Double | | |

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 - Política - Desconto Financeiro

Retornar a política de desconto financeiro da tabela de preço do ERP.

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

| prazoMedioMinimo | Double   |            | |

| prazoMedioMaximo | Double   |            | |

| percDesconto | Double | | |

| perccomissaoAdicional | Double | | |

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 - Política - Desconto Antecipação

Retornar a política de desconto antecipação da tabela de preço do ERP.

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

| dataInicio | Date |            | |

| dataFim | Date |            | |

| percDesconto | Double | | |

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 - Política - Prazo Adicional

Retornar a política de prazo adicional da tabela de preço do ERP.

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

| descricao | String | 255  | |

| qtdeDias | Integer | | |

| ufs | String | 255  | |

| dataFaturamentoInicio | Date |            | |

| dataFaturamentoFim | Date |            | |

| dataEmissaoInicio | Date | | |

| dataEmissaoFim | Date | | |

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 |

| codCliente (opcional) | :p3    | String/Integer   | 255         | Código do cliente no ERP |

| dataReferencia (opcional) | :p4     | Date   |         | Data de referência para títulos |

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 |

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

| Parcelamento| Integer   |         | Condicao 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 |

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 |

| classificacao | Integer | | Classificação: 1 - Venda, 2 - Bonificação, 3 - Consumo Próprio, 4 - Devolução |

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 Cobrança

Retorna a listagem de Tipos de Cobrança do ERP.

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

| codTipo *  | String/Integer   | 255        | Código do tipo de cobrança no ERP |

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

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 |

| codNota | String | 255 | Código da Nota relacionado a comissão |

| pedidos | String | 255 | Lista de pedidos separado por virgula relarcionados a comissão |

| percBaseComissao | Double |  | Percentual base |

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. Comissões - Extrato Resumo

Retornar de forma resumida os resultados dos meses de comissões

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

| anoMes | Integer | 6| Ano/mês de referencia ex:  201708 |

| flagMesFechado | Integer | 1 | Identificador para a situação do mês (0 - Em Aberto(Box Amarelo) / 1 - Fechado (Box Verde) |

| valorIRF | Double |  | Valor de IR Total |

| valorComissao | Double | | Valor da Comissão |

| valorNotaFiscal | Double | | Valor da Nota Fiscal |

| valorLiquido | Double | | Valor Liquido Total de 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 |

| anoMesReferencia | :p3     | Integer   | 255         | Ano Mes Referencia para retornar apenas os ultimos 6 meses (ex: 201801) |

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

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

| anoMes | Integer | 6| Ano/mês de referencia ex:  201708 |

| flagMesFechado | Integer | 1 | Identificador para a situação do mês (0 - Em Aberto(Box Amarelo) / 1 - Fechado (Box Verde) |

| valorIRF | Double |  | Valor de IR Total |

| valorComissao | Double | | Valor da Comissão |

| valorNotaFiscal | Double | | Valor da Nota Fiscal |

| dataLcto | Date | | Data do registro |

| lancamento | Integer  | | Indentificador do registro (usado para ordenação) |

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

| cliente | String | 255 | Nome do Cliente |

| baseComissao | Double | | Valor base para calculo da comissão |

| percBaseComissao| Double | | Percentual Base Cálculo comissão |

| percComiss | Double | | Percentual de comissão |

| valorCredito | Double | | Valor para credito |

| valorDebito | Double | | Valor para debito |

| titulo | String | 255 | Titulo  que originou o lançamento |

| pedido | String | 255 | Pedido que originou o lançamento |

| observacao | String | 255 | Historico ou Descrição do lançamento |

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 |

| anoMes | :p3     | Integer   | 255         | Ano Mes Referencia (ex: 201801) |

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: 2- 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 |

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

| endComplemento | String | 255 | Complemento do Endereço | 

| dataUltimaCompra | Date | | Data da ultima compra do cliente | 

| codTransportadora | String | 255 | Código da transportadora do cliente | 

| codCondPagto | String | 255 | Código da condição de pagamento do cliente |

| flagSimplesNacional | Integer| | Cliente faz parte do Simples Nacional: 0 - Não, 1 - Sim | 

| codTabPreco | String | 255 | Código da tabela de preço do cliente |  

| percDesconto | Double | | % Desconto curva ABC (Obrigatoriamente colocar o filtro de codCliente no WHERE)   |

| codGerente | String | 255 | Código do Gerente/Supervisor do representante do cliente. |

| inscricaoMunicipal | String | 255 | Inscrição municipal do cliente |

| codRamoAtividade | String | 255 | Código do ramo de atividade do cliente. |

| codGrupoCliente | String | 255 | Código do grupo de cliente. |

| dataFundacao | String | 255 | Data de fundação do cliente. |

| limiteCredito | Double | | Limite de crédito do cliente. |

| limiteCreditoDisponivel | Double | | Limite de crédito disponível. |

| percDescontoGrupo | Double | | Percentual de desconto do grupo comercial. |

| classificacaoCurva | String | | Classificação da Curva. |

| obs | String | | Observação do Cliente (Para recuperar facebook,instagram TI Empresarial). |

| listCodRepres | String | | Lista de representantes do cliente. |

| midiasSociais | String | | Midias sociais (facebook, instagram) da Sisplan separadas por ||. |

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 |

| codCliente | :p3     | String/Integer   | 255         | Código do cliente no ERP |

h2. Clientes - Locais de Entrega

Retornar a listagem de locais de entrega de um cliente.

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

| cnpj * | String | 255 | CNPJ ou CPF do cliente (formatado) |

| seqEntrega | String | 255 | Identificador único para o local de entrega |

| descricao | String | 255 | Descrição sobre o local de entrega |

| cep | String | 255 | CEP do local de entrega (somente números) |

| endereco | String | 255 | Endereço do local de entrega |

| numero | String | 255 | Número do endereço do local de entrega |

| complemento | String | 255 | Complemento do local de entrega |

| bairro | String | 255 | Bairro do local de entrega |

| codIBGE | String | 255 | Código IBGE do local de entrega |

| telefone | String | 255 | Telefone do local de entrega |

| celular | String | 255 | Celular do local de entrega |

| inscEstadual | String | 255 | Inscrição estadual do local de entrega |

Lista de Parâmetros:

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

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

| cnpj * | :p2     | String   | 255         | CNPJ do cliente no ERP |

h2. Clientes - Ramos de Atividade

Retornar a listagem de ramos de atividade.

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

| codigo * | String | 255 | Código do ramo de atividade |

| descricao | String | 255 | Descrição do ramo de atividade |

| flagSituacao | Integer | | Situação do ramo de atividade no ERP (0 - Inativo, 1 - Ativo) | 

Lista de Parâmetros:

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

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

h2. Clientes - Grupos de Cliente

Retornar a listagem de grupos de cliente.

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

| codigo * | String | 255 | Código do grupo |

| descricao | String | 255 | Descrição do grupo |

Lista de Parâmetros:

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

| codEmpresa * | :p1     | String/Integer   | 10         | Código da empresa 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. |

| opcoesVenda | String | 255 | (opcional) Opções de venda separadas por virgula, depende de como a empresa trabalha. ex: '6,12' |

| codReferProvisoria | String | 255 | Codigo da referencia provisoria, caso não exista, retornar a própria codReferencia |

| flagSortimentoCor | Integer |  | Referencia permite sortimento por cor. 0 - Não, 1 - Sim |

| flagEstoqueLimitado | Integer |  | Referencia é vendida apenas sob disponibilidade, é sobreescrito pela integração de estoque. 0 - Não, 1 - Sim |

| flagSortimentoCorTamanho | Integer | | Referencia permite sortimento por cor/tamanho (grade aberta). 0 - Não, 1 - Sim |

| flagSortimentoAutomatico | Integer | | Referencia permite sortimento automatico. 0 - Não, 1 - Sim |

| aliquotaIpi | Double | | Percentual de IPI que deve ser aplicado a referencia. ex: 10 |

| flagNaoAplicaDesconto | Integer | | Indicar se o desconto NÃO deve ser aplicado a referencia. 0 - Não, 1 - Sim |

| codColecao | String | 255 | Codigo da coleção do produto |

| qtdeQuilosPadrao | Double | | Utilizado quando Malharia, qtde. de kilos por quantidade, determina quandos quilos tem uma unidade da peça |

| cubagem | Double | | |

| nomeColecao | String | | Nome da coleção do produto, utilizado inicialmente no filtro por coleção para clientes com seleção agrupada (La Playa) |

| ncm | String | | Nomenclatura Comum do Mercosul, Classificação Fiscal |

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   | 255         | Código da referência no ERP |

| codColecao | #COLECOES | | | Qualificar no WHERE como IN |

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 * | String | 255  | 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 |

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

| codColecao | #COLECOES | | | Qualificar no WHERE como IN |

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) |

| rgb | String | 255 | Valor hexadecial ou RGB da cor para amostra ao representante |

| loteEntrega | String | 255 | Lote de Entrega padrão do sortimento |

| itemAtivo | Integer | 1 | Situação do Item (0 - Inativo, 1 - Ativo) |

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   | 255         | Código da referência no ERP |

| codColecao | #COLECOES | | | Qualificar no WHERE como IN |

h2. Produto - EAN13

Um novo código EAN por referencia para cada sortimento/tamanho!

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

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

| EAN * | String/Integer   | 255 | Código de Barras (EAN) |

Lista de Parâmetros:

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

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

| codColecao | #COLECOES | | | Qualificar no WHERE como IN |

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. Bloqueio de Referências

Retornar as referências bloqueadas no ERP.

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

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

| codReferencia * | String/Integer   | 255         | Código da referência |

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

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

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

| flagBloqueado | Integer | | Indicador do bloqueio da referência (1 - Sim, 0 - Não) |

| codTabPreco (opcional) | String | 255 | Código da tabela de preço | 

Lista de Parâmetros:

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

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

|codColecao	| #COLECOES|  |		|	Qualificar no WHERE como IN |

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. Pedidos por Referência

Retorna a quantidade vendida de uma ou de várias referência, tamanho e cor.

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

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

| codReferencia * | String | 255 | Código da Referência |

| codTamanho * | String | 255 | Código do Tamanho |

| codSortimento * | String | 255 | Código do Sortimento |

| quantidade | Integer |  | Quantidade vendida |

Lista de Parâmetros:

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

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

| codReferencia | #REFERENCIAS | | | 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 |

| qtdePedLiquida | Integer | | Quantidade Pedida Liquida |

| motivo | String | 255 | Motivo do pedido |

| pedidoCliente | String | 255 | Codigo do Pedido de controle do cliente |

| pedidoRepresentante | String | 255 | Codigo do Pedido de controle do representante |

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         | Código do Representante   |

| :pCodCliente          | String   | 10         | (opcional) Código do Cliente |

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 |

| percDesconto1 | Double | | Percentual de Desconto 1 |

| percDesconto2 | Double | | Percentual de Desconto 2 |

| percDesconto3 | Double | | Percentual de Desconto 3 |

| percDesconto4 | Double | | Percentual de Desconto 4 |

| percDesconto5 | Double | | Percentual de Desconto 5 |

| fantasia | String | 255 | Nome Fantasia |

| emailCliente | String | 255 | E-mail do Cliente |

| pedidoCliente | String | 255 | Codigo do Pedido de controle do cliente |

| pedidoRepresentante | String | 255 | Codigo do Pedido de controle do representante |

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 |

h2. Listagem de Pedidos - Observações

Retornar dados das observações do pedido por setor.

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

| codSetor | String | 255 | Código do setor da observação |

| nomeSetor | String | 255 | Nome do setor da observação |

| dataObservacao | Date |  | Data da observação |

| descricao | String | 255 | Texto da observação |

Lista de Parâmetros:

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

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

h2. Listagem de Pedidos - Histórico

Retornar dados do histórico de movimentação do pedido no ERP.

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

| codHistorico | String | 255 | Código do histórico |

| situacao | String | 255 | Número da situação do pedido no ERP |

| descSituacao | String | 255 | Descrição da situação do pedido no ERP |

| data | Date |  | Data da movimentação |

Lista de Parâmetros:

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

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

h2. Estoque

Retornar a listagem do estoque

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

|codEmpresa | String | 255 | Código da Empresa origem dos dados |

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

|seqTamanho | String | 255 | Código do tamanho na grade no ERP |

|seqSortimento | String | 255 | Código do Sortimento no ERP |

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

|estoqueLimitado | Integer | | Referencia com estoque limitado/vendida por disponibilidade, geralmente produtos importados: 0 - Não, 1 - Sim |

|quantidade | Double | | Quantidade disponivel para venda (estoque - pedidos em aberto + OPs em aberto) |

|qtdProducao | Double | | Quantidade em OPs em aberto, utilizar apenas se o ERP não tratar o % de quebra e o valor não estiver compondo o campo de quantidade acima |

|nomeReferencia | String | 255 | (opcional) Nome da referencia |

|nomeSortimento | String | 255 | (opcional) Descricao do Sortimento |

|codTamanho | String | 255 | (opcional) Codigo do Tamanho. ex: P ou M ou G |

|codGrade | String | 255 | (opcional) Codigo da grade dos tamanhos |

|-codDeposito- | -String- | -255- | (deprecated, informar null) -Codigo do Deposito, utilizar apenas em casos espcificos, falar com a IBTech antes- |

|-nomeDeposito- | -String- | -255- | (deprecated, informar null) -Nome do Deposito, utilizar apenas em casos espcificos, falar com a IBTech antes- |

|qtdProntaEntrega | Double | | Quantidade em pronta entrega, não considera as OPs em aberto, somente os produtos no estoque fisico |

| nomeColecao | String | 255 | (opcional) Nome da coleção do produto |

| seqOrdenacaoTamanho | String | 255 | (opcional) Sequencia de ordenação do tamanho na grade |

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   | 10         | (opcional) Código da empresa no ERP |

| seqTamanho | :p3     | String/Integer   | 10         | (opcional) Código do tamanho na grade no ERP |

| seqSortimento | :p4     | String/Integer   | 10         | (opcional) Código do Sortimento no ERP |

| codColecao | #COLECOES | | | Qualificar no WHERE como IN |

h2. Lotes de Entrega

Retornar o cadastro de lotes de entrega

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

|prazo | String | 255 | Código do lote de entrega (consequente prazo) |

|descricao | String | 255 | Descrição do lote de entrega |

|dataInicio | Date | 255 | Data de Início da vigência de entrega |

|dataFim | Date | 255 | Data Final da vigência de entrega |