Integração Analytics

h1. CRM

*Índice* 

# [[CRM#Introdução|Introdução]]

# [[CRM#Dados-Cadastrais-do-Cliente|Dados Cadastrais do Cliente]]

# [[CRM#Pesquisa-por-Nome-de-Cliente|Pesquisa por Nome de Cliente]]

# [[CRM#Pesquisa-Avançada|Pesquisa Avançada]]

# [[CRM#Lista-de-Pedidos-do-Cliente|Lista de Pedidos do Cliente]]

# [[CRM#Pedido-Detalhado|Pedido - Detalhado]]

# [[CRM#Pedido-Itens|Pedido - Itens]]

# [[CRM#Pedido-NFs|Pedido - NFs]]

# [[CRM#Informações-Financeiras|Informações Financeiras]]

# [[CRM#Informações Financeiras por Situação|Informações Financeiras por Situação]]

# [[CRM#Informações Financeiras - Ocorrências|Informações Financeiras - Ocorrências]]

# [[CRM#Clientes do Grupo|Clientes do Grupo]]

# [[CRM#Lista-de-Pedidos-Representante|Lista de Pedidos Representante]]

# [[CRM#Lista-de-Clientes-do-Itinerário|Lista de Clientes do Itinerário]]

h2. 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 o módulo de Dados Cadastrais

*Atenção!! Os campos que estiverem com a descrição "Campo Específico" retornar null, salvo se for combinado algo diferente com a IBTech 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 suporte@ibtech.inf.br ou pelo telefone (47) 3370-0504.

h2. Dados Cadastrais do Cliente

Consulta de Dados Cadastrais.

*Importante!* Este SQL possui parâmetros.

Layout da tabela/visão:

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

|_.1  | nome                  | String  | 255       | Nome do Cliente.                       |

|_.2  | codRepres          | String  | 255        | Código do Representante           |

|_.3  | nomeRepres        | String | 255        | Nome do Representante.            |

|_.4  | endereco             | String | 255        | Endereço do Cliente.                  |

|_.5  | bairro                  | String | 255        | Bairro do Cliente.                       |

|_.6  | numero               | String | 255        | Número do endereço do Cliente.  |

|_.7  | complemento     | String | 255        | Complemento do endereco.          |

|_.8  | cep                     | String  | 255       | Cep do Cliente.                         |

|_.9  | codAtendente       | String | 255       | Código do Atendente.                |

|_.10  | nomeAtendente    | String | 255       | Nome do Atendente.                  |

|_.11  | codCliente          | String  | 255       | Código do Cliente.                       |

|_.12  | inscricaoEstadual | String | 255        | Inscrição Estadual do Cliente.    |

|_.13  | telefone               | String | 255        | Telefone do Cliente.                  |

|_.14  | cepuf                   | String | 255       |  Sigla do estado do Cliente.         |

|_.15  | cidade                 | String  | 255       |  Cidade do Cliente.                     |

|_.16  | dataCadastro        | Date  |       |  Data do cadastro do Cliente.             |

|_.17  | nomeFantasia      | String | 255 | Nome Fantasia do Cliente.                 |

|_.18  | codGrupoEconomico  | String  |  255 | Código do Grupo Econômico do cliente. |

|_.19  | nomeGrupoEconomico | String | 255 | Nome do Grupo Econômico do cliente.   |

|_.20  | cnpjCpf | String | 255 | CNPJ / CPF do Cliente  |

|_.21  | email | String | 255 | Email do Cliente | 

|_.22  | celular | String | 255 | Celular do Cliente | 

|_.23  | facebook | String | 255 | Facebook do Cliente | 

|_.24  | instagram | String | 255 | Instagram do Cliente | 

|_.25  | situacao | Integer |  | Situação do Cliente |

|_.26  | dataUltimaCompra | Date |  | Data de última compra do Cliente |

|_.27  | limiteCredito | Double |  | Limite de crédito do Cliente |

|_.28  | totalVlrPedidosAberto | Double |  | Total pedidos em aberto do Cliente |

|_.29  | totalVlrTitulosAberto | Double |  | Total títulos em aberto do Cliente |

Lista de Parâmetros:

*Importante!* Deve ser pesquisado pelo parametro formato ou não formatado também.

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

|  cnpjCpf / codigo | :p1    | String          | 255           | CPF, CNPJ ou código do Cliente. (Sem formatação) |

___

h2. Pesquisa por Nome de Cliente

Pesquisar de clientes por nome.

*Importante!* Este SQL possui parâmetros.

Layout da tabela/visão:

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

| cnpjCpf *    | String | 255        | CPF ou CNPJ do Cliente. |

| nome | String | 255 | Nome do Cliente. |

| cidade | String | 255 | Cidade do Cliente. |

| estado | String | 255 | Estado do Cliente. |

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

| nomeFantasia | String | 255 | NomeFantasia. |

| cep | String | 255 | CEP. |

| limiteCredito | Double |  | Limite de crédito do Cliente |

| totalVlrPedidosAberto | Double |  | Total pedidos em aberto do Cliente |

| totalVlrTitulosAberto | Double |  | Total títulos em aberto do Cliente |

| codRepres | String | 255 | Código do representante. |

Lista de Parâmetros:

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

|  nome      | :p1                   | String            | 255           | (opcional) Nome do Cliente. |

___

h2. Pesquisa Avançada

Pesquisar de clientes por vários parâmetros.

*Importante!* Este SQL possui parâmetros.

Layout da tabela/visão:

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

| cnpjCpf *    | String | 255        | CPF ou CNPJ do Cliente. |

| nome | String | 255 | Nome do Cliente. |

| cidade | String | 255 | Cidade do Cliente. |

| estado | String | 255 | Estado do Cliente. |

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

| nomeFantasia | String | 255 | NomeFantasia. |

| cep | String | 255 | CEP. |

Lista de Parâmetros:

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

|  nomeCliente      | :p1                   | String            | 255           | (opcional) Nome do Cliente. |

|  fantasiaCliente      | :p2                   | String            | 255           | (opcional) Nome Fantasia do Cliente. |

|  cidade      | :p3                   | String            | 255           | (opcional) Cidade. |

|  estado      | :p4                   | String            | 255           | (opcional) Estado. |

|  cnpj      | :p5                   | String            | 255           | (opcional) CNPJ do Cliente. |

|  codCliente      | :p6                   | String            | 255           | (opcional) Código do Cliente. |

___

h2. Lista de Pedidos do Cliente

Listar pedidos feitos pelo Cliente.

*O SQL deve listar somente títulos em aberto.*

Layout da tabela/visão:

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

| codEmpresa       | String  | 255           | Código da Empresa.                    |

| codPedido          | String  | 255           | Código do Pedido.                       |

| dataEmissao      | Date    |                 | Data da Emissão do Pedido.         |

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

| situacaoEdt        | String  | 255           | Display da Situação.                    |

| valorTotalBruto | Double |                | Valor Total Bruto do Pedido.       |

| valorTotalLiquido   | Double |                 | Valor Total Liquido do Pedido.         |

| valorSaldo          | Double |                 | Valor do Saldo do Pedido.            |

| codCliente | String | 255 | Código do cliente. |

| nomeCliente | String | 255 | Nome do cliente. |

| tabPreco | String | 255 | Tabela de Preço do Pedido | 

| notaFiscal | Strings | 255 | Notas Fiscais do Pedido (Não obrigatório, apenas em bases com muitos dados e se possível passar em lista) | 

Lista de Parâmetros:

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

| CNPJ | :p1                   | String            | 255           | CPF ou CNPJ do Cliente.    |

| cnpjCpfFormatado    | :p2                   | String            | 255           | CPF ou CNPJ do Cliente com formatação.    |

| codGrupo    | :p3                   | String            | 255           | Código do grupo econômico do cliente.    |

| tipoConsulta    | :p4                   | String            | 255           | Tipo da consulta (1 - pelo cnpj/cpf do cliente 2 - pelo código do grupo econômico)    |

| dataEmissao | :p5 | Date | | Data de emissão do pedido. |

___

h2. Pedido - Detalhado

Listar um detalhamento do pedido.

*Importante!* Este SQL possui parâmetros.

Layout da tabela/visão:

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

|_.1 | dataEmissao              | Date    |                  | Data de Emissão do Pedido.                                    |

|_.2 | dataPrevFaturamento  | Date    |                  | Data de Previsão de Faturamento.                            |

|_.3 | situacaoEdt                | String  | 255            | Display da Situação.                                               |

|_.4 | cnpjCpf                      | String  | 255            | CPF ou CNPJ do Cliente.                                        |

|_.5 | inscEstadual              | String  | 255            | Inscrição Estadual do Cliente.                                  |

|_.6 | codCliente                  | String  | 255            | Código do Cliente.                                                  |

|_.7 | nomeCliente               | String  | 255            | Nome do Cliente.                                                    |

|_.8 | cidadeCliente              | String  | 255            | Cidade do Cliente.                                                   |

|_.9 | codRepres                  | String  | 255            | Código do Representante.                                         |

|_.10 | nomeRepres               | String  | 255             | Nome do Representante.                                          |

|_.11 | percComissao             | Double |                   | Percentual de Comissão da Venda do Representante. |

|_.12 | tabPreco                    | String  | 255             | Código + nome da Tabela de Preço.                          |

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

|_.14 | tipoNF                       | String  | 255             | Código + nome do Tipo de Nota Fiscal.                       |

|_.15 | transpDespacho         | String  | 255             | Código da Transportadora.                                        |

|_.16 | transpDespNome        | String  | 255             | Nome da Transportadora.                                         |

|_.17 | tipoFreteDespacho     | String  | 255             | Tipo de Frete.                                                         |

|_.18 | transpRedespacho     | String  | 255             | Código da Transportadora de Redespacho.                |

|_.19 | transpRedespachoNome  | String  | 255       | Nome da Transportadora de Redespacho.                  |

|_.20 | tipoFreteRedespacho | String  | 255             | Tipo do Frete de Redespacho.                                  |

|_.21 | valorTotalBruto          | Double |                   | Valor Total Bruto do Pedido.                                    |

|_.22 | valorTotalLiquido       | Double |                   | Valor Total Liquido do Pedido.                                  |

|_.23 | valorSaldo                 | Double |                   | Valor do Saldo do Pedido.                                       |

|_.24 | observacao               | String   | 255           | Observação do Pedido.                                            |

|_.25 | valorDesconto           | String   | 255            | Descontos concatenados.                                        |

|_.26 | uf                             | String  | 255             | Sigla do estado do pedido.                                       |

|_.27 | percDesconto          | Double |                  | Percentual de desconto do pedido.                             |

|_.28 | tipoPedido              | String |   255             | Descrição do tipo de pedido.                             |

Lista de Parâmetros:

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

| codEmpresa | :p1                | String    | 255           | (opcional) Código da Empresa. |

| codPedido    | :p2                | String    | 255           | (opcional) Código do Pedido.    |

___

h2. Pedido - Itens

Listar um detalhamento do pedido.

*Importante!* Este SQL possui parâmetros.

Layout da tabela/visão:

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

| seqItem           | String   | 255           | Sequência dos Itens. |

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

| nomeItem        | String  | 255            | Nome do Item.           |

| qtdePedida      | Integer | 10              | Quantidade Pedida.    |

| qtdeSaldo        | Integer | 10              | Quantidade Saldo.     | 

| qtdeFaturada   | Integer | 10              | Quantidade Faturada. |

| qtdeCancelada | Integer | 10              | Quantidade Cancelada. |

| precoUnitBruto | Double  |                | Preço Unitário Bruto do Item do Pedido. |

| precoUnitLiquido | Double  |                | Preço Unitário LÍquido do Item do Pedido. |

| total                 | Double  |                 |Preço Total do Item do Pedido. |

| valorRentabilidade        | Double  |             | Valor da rentabilidade.           |

| percRentabilidade        | String  | 255            | Percentual da rentabilidade.           |

| seqTamanho        | String  | 255            | Tamanho do Item.           |

| seqSortimento        | String  | 255            | Cor do Item.           |

| codColecao        | String  | 255            | Cód da coleção.  (atualmente exclusivo da Morena Rosa).           |

| armazem        | String  | 255            | Armazém.  (atualmente exclusivo da Morena Rosa).           |

| operacao        | String  | 255            | Tipo de operação.  (atualmente exclusivo da Morena Rosa).           |

Lista de Parâmetros:

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

| codEmpresa | :p1               | String   | 255            | (opcional) Código da Empresa. |

| codPedido    | :p2               | String   | 255            | (opcional) Código do Pedido.|

___

h2. Pedido - NFs

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

| dataNF            | Date     |                 | Data de Emissão da Nota Fiscal. |

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

| situacaoEdt     | String    | 255           | Display da Situação. |

| valorTotal        | Double  |                  | Valor total do Item. |

| codTransportadora| String  | 255        | Código da Transportadora. |

| nomeTransportadora| String  | 255     | Nome da Transportadora.   |

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

| nomeRedespacho   | String  | 255      | Nome do Redespacho.       |

| nfeChave               | String  | 255      | Chave da Nota Fiscal Eletrônica. |

| dataEntrega               | Date     |                  | Data de Entrega |

Lista de Parâmetros:

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

| codEmpresa | :p1              | String  | 255           | (opcional) Código da Empresa. |

| codPedido    | :p2              | String  | 255           | (opcional) Código do Pedido.|

___

h2. Informações Financeiras

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

| titulo                | String  | 255        | Título da Duplicata. |

| valorLiquido      | Double |             | Valor Líquido da Duplicata. |

| dataEmissao    | Date    |              | Data de Emissão da Fatura. |

| dataVencimento| Date    |             | Data de Vencimento da Duplicata. |

| dataBaixa         | Date    |             | Data Baixa da Duplicata. |

| situacao           | String  | 255       | Situação da Duplicata. |

| nomePortador   | String  | 255       | Nome do Portador. |

| codCliente | String | 255 | Código do cliente. |

| nomeCliente | String | 255 | Nome do cliente. |

| dataVencimentoOriginal | Date |             | Data de vencimento original da duplicata. |

| dataEnvioSERASA | Date |             | Data de envio para o Serasa. |

| dataPrazoPagamento | Date |             | Data do acordo de pagamento da duplicata. |

| codTipoCobranca | Integer |             | Código do tipo de cobrança da duplicata. |

| nomeTipoCobranca | String | 255       | Nome do tipo de cobrança da duplicata. |

| dataCartorio | Date |             | Data do Cartório da duplicata. |

| tipoBaixa | String | 255       | Tipo de baixa da duplicata. |

| valorJuros      | Double |             | Valor dos juros da Duplicata. |

| valorDesconto      | Double |             | Valor do desconto da Duplicata. |

Lista de Parâmetros:

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

| cnpjCpf    | :p1               | String    | 255           | (opcional) CPF ou CNPJ do Cliente. |

| cnpjCpfFormatado    | :p2                   | String            | 255           | CPF ou CNPJ do Cliente com formatação.    |

| codGrupo    | :p3                   | String            | 255           | Código do grupo econômico do cliente.    |

| tipoConsulta    | :p4                   | String            | 255           | Tipo da consulta (1 - pelo cnpj/cpf do cliente 2 - pelo código do grupo econômico)    |

| dataEmissao | :p5 | Date | | Data de emissão do pedido. |

___

h2. Informações Financeiras por Situação

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

| titulo                | String  | 255        | Título da Duplicata. |

| valorLiquido      | Double |             | Valor Líquido da Duplicata. |

| dataEmissao    | Date    |              | Data de Emissão da Fatura. |

| dataVencimento| Date    |             | Data de Vencimento da Duplicata. |

| dataBaixa         | Date    |             | Data Baixa da Duplicata. |

| situacao           | String  | 255       | Situação da Duplicata. |

| nomePortador   | String  | 255       | Nome do Portador. |

| codCliente | String | 255 | Código do cliente. |

| nomeCliente | String | 255 | Nome do cliente. |

Lista de Parâmetros:

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

| cnpjCpf    | :p1               | String    | 255           | (opcional) CPF ou CNPJ do Cliente. |

| cnpjCpfFormatado    | :p2                   | String            | 255           | CPF ou CNPJ do Cliente com formatação.    |

| codGrupo    | :p3                   | String            | 255           | Código do grupo econômico do cliente.    |

| tipoConsulta    | :p4                   | String            | 255           | Tipo da consulta (1 - pelo cnpj/cpf do cliente 2 - pelo código do grupo econômico)    |

| dataEmissao | :p5 | Date | | Data de emissão do pedido. |

___

h2. Informações Financeiras - Ocorrências

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

| dataOcorrencia    | Date    |              | Data da ocorrência. |

| observacao  | String  | 255        | Observação da ocorrência. |

Lista de Parâmetros:

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

| codEmpresa    | :p1               | String    | 255           | Código da empresa. |

| codTitulo | :p2                   | String            | 255           |  Código do título.    |

___

h2. Clientes do Grupo

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

| cnpj | String | 255 | Cnpj do cliente. |

| codCliente | String | 255 | Código do cliente. |

| nomeCliente | String | 255 | Nome do cliente. |

Lista de Parâmetros:

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

| codEmpresa | :p1 | String | 255 | Código da empresa |

| cnpjCpf    | :p1               | String    | 255           | CPF ou CNPJ do Cliente. |

| codGrupo    | :p3                   | String            | 255           | (opcional) Código do grupo econômico do cliente.  |

___

h2. Lista de Pedidos Representante

*Importante!* Este SQL possui parâmetros.

Layout da tabela/visão:

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

| codEmpresa        | String | 255            | Código da Empresa.              |

| cnpjCpf               | String | 255            | CPF ou CNPJ do cliente.       |

| nomeCliente        | String | 255            | Nome do Cliente.                   |

| codPedido           | String | 255            | Código do Pedido.                 |

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

| dataPrevFat        | Date   |                  | Data de Previsão de Faturamento. |

| situacaoEdt         | String | 255            | Display da situação.               |

| valorTotalBruto    | Double |                  | Valor Total Bruto do Pedido.     |

| valorTotalLiquido  | Double |                 | Valor Total Líquido do Pedido.   | 

| valorSaldo           | Double |                 | Valor do Saldo do Pedido.         |

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

| nomeRepres       | String    | 255          | Nome do Representante.           |

| codColecao        | String    | 255          | Código da coleção do primeiro item ou da capa quando houver. (opcional) |

Lista de Parâmetros:

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

| CodRepres    | :p1     | String          | 255           | Codigo do Representante |

| dataEmissao | :p2 / :p3 | Date       |                  | Data de Emissão do Pedido. |

| CodColecao | :p4 | string       |                  | Codigo da Colecao filtrar (Filtrar tambem para permitir informar null)  |

___

h2. Lista de Clientes do Itinerário

Layout da tabela/visão:

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

| codEmpresa | String | 255 | Código da Empresa. |

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

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

| situacao |  Integer |        | Situação (se for ativo, é cliente, senão é prospect). |

| razaoSocial | String | 255 | Razão Social do cliente. |

| nomeFantasia | String | 255 | Nome Fantasia do cliente. |

| codRepres1 | String | 255 | Código do Representante. |

| codRepres2 | String | 255 | Código do Representante (Só é válido se o primeiro for nulo). |

| cnpjCpf | String | 255 | CNPJ ou CPF do cliente. |

| telefone | String | 255 | Telefone do Cliente. |

| email | String | 255 | E-mail do Cliente. |

| endereco | String | 255 | Endereço do Cliente (Rua + número). |

| bairro | String | 255 | Bairro do Cliente. |

| cep | String | 255 | CEP do Cliente. |

| dataCadastro | Date |  | Data de cadastro do Cliente. |

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

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

| codRamoAtividade | String | 255 | Código do Ramo de Atividade. |

| nomeRamoAtividade | String | 255 | Nome do Ramo de Atividade. |

___

h2. Lista de Títulos do Cliente

*Importante!* Este SQL possui parâmetros.

Layout da tabela/visão:

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

| titulo               | String | 255            | Número do Título.       |

| dataVecto       | Date   |                  | Data de Vencimento do Título.   |

| valor    | Double |                  | Valor do Título.     |

| portador    | String | 255                 | Portador do Título.     |

| diasAtraso    | Integer |                  | Dias de Atraso do Título.     |

Lista de Parâmetros:

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

| codEmpresa    | :p1     | String          | 255           | Código da Empresa. |

| cnpjCpf    | :p2     | String          | 255           | CPF ou CNPJ do Cliente. |