Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | crmapi\apiGestaoContas.p |
Objetivo
Consultar as contas no CRM, validar acesso as contas.
Tabelas Temporárias
Atributos das tabelas temporárias de entrada e saída:
ttcliente |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
nom_razao | Char |
| Nome / Razão Social |
|
cod_erp | Char |
| codigo ERP |
|
nom_abrev | Char |
| Nome Abreviado |
|
nom_fantas | Char |
| Nome Fantasia / Apelido |
|
cnpj_cpf | Char |
| CNPJ / CPF |
|
tip_clien | Char |
| Tipo de Cliente |
|
fone | Char |
| Telefone |
|
regiao | Char |
| Área de Atuação |
|
endereco | Char |
| Endereço |
|
tratamen | Char |
| Tratamento |
|
dpto | Char |
| Departamento |
|
ocup | Char |
| Ocupação |
|
niv_decis | Char |
| Nivel de Decisão |
|
melh_hor | Char |
| Melhor Horário |
|
nom_prim | Char |
| Primeiro Nome |
|
nom_meio | Char |
| Nome Intermediário |
|
nom_fim | Char |
| Sobrenome |
|
Char |
|
| ||
pto_focal | Char |
| Ponto Focal Dpto |
|
classif | Char |
| Classificação |
|
sexo | Char |
| Sexo |
|
grp_client | Char |
| Grupo de Cliente |
|
ie | Char |
| Inscrição Estadual |
|
transp | Char |
| Transportadora |
|
transp_red | Char |
| Transportadora Redesp |
|
ramo_ativ | Char |
| Ramo Atividade |
|
usuar_cad | Char |
| Usuário de Cadastro |
|
usuar_resp | Char |
| Usuário Responsável |
|
dat_cad | Char |
| Data de Cadastro |
|
dat_atual | Char |
| Data de Atualização |
|
tip_vincul | Char |
| Tipo Vínculo |
|
pto_foc_ger | Char |
| Ponto Focal Geral |
|
resp_financ | Char |
| Responsável Financeiro |
|
resp_pedid | Char |
| Responsável Pedidos |
|
fonte | Char |
| Fonte |
|
tip_cta | Char |
| Tipo de Conta |
|
tip_pessoa | Char |
| Tipo de Pessoa |
|
num_id | Char |
| Chave |
|
dat_nasc | Char |
| Data Nascimento |
|
logClien | Log |
| É Cliente |
|
ttcontato |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
nom_razao | Char |
| Nome / Razão Social |
|
cod_erp | Char |
| codigo ERP |
|
nom_abrev | Char |
| Nome Abreviado |
|
nom_fantas | Char |
| Nome Fantasia / Apelido |
|
cnpj_cpf | Char |
| CNPJ / CPF |
|
tip_clien | Char |
| Tipo de Cliente |
|
fone | Char |
| Telefone |
|
regiao | Char |
| Área de Atuação |
|
endereco | Char |
| Endereço |
|
tratamen | Char |
| Tratamento |
|
dpto | Char |
| Departamento |
|
ocup | Char |
| Ocupação |
|
niv_decis | Char |
| Nivel de Decisão |
|
melh_hor | Char |
| Melhor Horário |
|
nom_prim | Char |
| Primeiro Nome |
|
nom_meio | Char |
| Nome Intermediário |
|
nom_fim | Char |
| Sobrenome |
|
Char |
|
| ||
pto_focal | Char |
| Ponto Focal Dpto |
|
classif | Char |
| Classificação |
|
sexo | Char |
| Sexo |
|
grp_client | Char |
| Grupo de Cliente |
|
ie | Char |
| Inscrição Estadual |
|
transp | Char |
| Transportadora |
|
transp_red | Char |
| Transportadora Redesp |
|
ramo_ativ | Char |
| Ramo Atividade |
|
usuar_cad | Char |
| Usuário de Cadastro |
|
usuar_resp | Char |
| Usuário Responsável |
|
dat_cad | Char |
| Data de Cadastro |
|
dat_atual | Char |
| Data de Atualização |
|
tip_vincul | Char |
| Tipo Vínculo |
|
pto_foc_ger | Char |
| Ponto Focal Geral |
|
resp_financ | Char |
| Responsável Financeiro |
|
resp_pedid | Char |
| Responsável Pedidos |
|
fonte | Char |
| Fonte |
|
tip_cta | Char |
| Tipo de Conta |
|
tip_pessoa | Char |
| Tipo de Pessoa |
|
num_id | Char |
| Chave |
|
dat_nasc | Char |
| Data Nascimento |
|
logClien | Log |
| É Cliente |
|
ttlead |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
nom_razao | Char |
| Nome / Razão Social |
|
cod_erp | Char |
| codigo ERP |
|
nom_abrev | Char |
| Nome Abreviado |
|
nom_fantas | Char |
| Nome Fantasia / Apelido |
|
cnpj_cpf | Char |
| CNPJ / CPF |
|
tip_clien | Char |
| Tipo de Cliente |
|
fone | Char |
| Telefone |
|
regiao | Char |
| Área de Atuação |
|
endereco | Char |
| Endereço |
|
tratamen | Char |
| Tratamento |
|
dpto | Char |
| Departamento |
|
ocup | Char |
| Ocupação |
|
niv_decis | Char |
| Nivel de Decisão |
|
melh_hor | Char |
| Melhor Horário |
|
nom_prim | Char |
| Primeiro Nome |
|
nom_meio | Char |
| Nome Intermediário |
|
nom_fim | Char |
| Sobrenome |
|
Char |
|
| ||
pto_focal | Char |
| Ponto Focal Dpto |
|
classif | Char |
| Classificação |
|
sexo | Char |
| Sexo |
|
grp_client | Char |
| Grupo de Cliente |
|
ie | Char |
| Inscrição Estadual |
|
transp | Char |
| Transportadora |
|
transp_red | Char |
| Transportadora Redesp |
|
ramo_ativ | Char |
| Ramo Atividade |
|
usuar_cad | Char |
| Usuário de Cadastro |
|
usuar_resp | Char |
| Usuário Responsável |
|
dat_cad | Char |
| Data de Cadastro |
|
dat_atual | Char |
| Data de Atualização |
|
tip_vincul | Char |
| Tipo Vínculo |
|
pto_foc_ger | Char |
| Ponto Focal Geral |
|
resp_financ | Char |
| Responsável Financeiro |
|
resp_pedid | Char |
| Responsável Pedidos |
|
fonte | Char |
| Fonte |
|
tip_cta | Char |
| Tipo de Conta |
|
tip_pessoa | Char |
| Tipo de Pessoa |
|
num_id | Char |
| Chave |
|
dat_nasc | Char |
| Data Nascimento |
|
logClien | Log |
| É Cliente |
|
ttgrd_cliente |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
num_id | Char |
| Código |
|
nom_razao | Char |
| Nome / Razão Social |
|
cod_erp | Char |
| codigo ERP |
|
nom_abrev | Char |
| Nome Abreviado |
|
nom_fantas | Char |
| Nome Fantasia / Apelido |
|
tip_pessoa | Char |
| Tipo Pessoa |
|
cnpj_cpf | Char |
| CNPJ / CPF |
|
tip_clien | Char |
| Tipo de Cliente |
|
fone | Char |
| Telefone |
|
Char |
|
| ||
regiao | Char |
| Área de Atuação |
|
endereco | Char |
| Endereço |
|
pto_focal | Char |
| Ponto Focal Geral |
|
ttgrd_contato |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
num_id | Char |
| Código |
|
nom_razao | Char |
| Nome / Razão Social |
|
tip_pessoa | Char |
| Tipo Pessoa |
|
tratamen | Char |
| Tratamento |
|
dpto | Char |
| Departamento |
|
ocup | Char |
| Ocupação |
|
niv_decis | Char |
| Nivel de Decisão |
|
melh_hor | Char |
| Melhor Horário |
|
pto_focal | Char |
| Ponto Focal Dpto |
|
fone | Char |
| Telefone |
|
Char |
|
| ||
endereco | Char |
| Endereço |
|
ttgrd_lead |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
num_id | Char |
| Código |
|
nom_razao | Char |
| Nome / Razão Social |
|
nom_fantas | Char |
| Nome Fantasia / Apelido |
|
tip_pessoa | Char |
| Tipo Pessoa |
|
cnpj_cpf | Char |
| CNPJ / CPF |
|
fone | Char |
| Telefone |
|
Char |
|
| ||
endereco | Char |
| Endereço |
|
fonte | Char |
| Fonte |
|
num_id | Char |
| Código |
|
ttFiltroAvanc |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
campo | Char |
| Campo |
|
valor | Char |
| Valor |
|
valor_inic | Char |
| Data Inicial |
|
valor_fim | Char |
| Data Final |
|
tt-cta_usuar |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
cod_pessoa_erp | Char |
| Código da Pessoa no ERP |
|
num_id_pessoa | Int |
| Código da Pessoa no CRM |
|
Métodos
Métodos básicos
Método: filtroBasico
Descrição: realiza a consulta a partir do filtro básico do formulário de pesquisa de contas.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-descr | Char |
| X |
|
| Valor do filtro |
c-indice | Char |
| X |
|
| Opção do filtro |
c-dateInic | Char |
| X |
|
| Data inicial |
c-dateFim | Char |
| X |
|
| Data final |
Ttcliente | Tt |
|
| X |
| Clientes |
Ttcontato | Tt |
|
| X |
| Contatos |
Ttlead | Tt |
|
| X |
| Lead |
ttgrd_cliente | Tt |
|
| X |
| Clientes Disponíveis na grade de consulta |
ttgrd_contato | Tt |
|
| X |
| Contatos disponíveis na grade de consulta |
ttgrd_lead | Tt |
|
| X |
| Leads disponíveis na grade de consulta |
Método: repopulaGrdCliente
Descrição: realiza a consulta a partir do filtro básico interno da aba de cliente do formulário de pesquisa de contas.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-descr | Char |
| X |
|
| Valor do filtro |
c-indice | Char |
| X |
|
| Opção do filtro |
c-dateInic | Char |
| X |
|
| Data inicial |
c-dateFim | Char |
| X |
|
| Data final |
Ttcliente | Tt |
|
| X |
| Clientes |
ttgrd_cliente | Tt |
|
| X |
| Clientes Disponíveis na grade de consulta |
Método: repopulaGrdContato
Descrição: realiza a consulta a partir do filtro básico interno da aba de contatos do formulário de pesquisa de contas.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-descr | Char |
| X |
|
| Valor do filtro |
c-indice | Char |
| X |
|
| Opção do filtro |
c-dateInic | Char |
| X |
|
| Data inicial |
c-dateFim | Char |
| X |
|
| Data final |
Ttcontato | Tt |
|
| X |
| Contatos |
ttgrd_contato | Tt |
|
| X |
| Contatos disponíveis na grade de consulta |
Método: repopulaGrdLead
Descrição: realiza a consulta a partir do filtro básico interno da aba de leads do formulário de pesquisa de contas.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-descr | Char |
| X |
|
| Valor do filtro |
c-indice | Char |
| X |
|
| Opção do filtro |
c-dateInic | Char |
| X |
|
| Data inicial |
c-dateFim | Char |
| X |
|
| Data final |
Ttlead | Tt |
|
| X |
| Lead |
ttgrd_lead | Tt |
|
| X |
| Leads disponíveis na grade de consulta |
Método: carregaGridApartirDoFiltroAvanc
Descrição: realiza a consulta a partir do filtro avançado do formulário de pesquisa de contas.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
ttFiltroAvanc | Tt |
| X |
|
| Parametrização filtro avançado |
Ttcliente | Tt |
|
| X |
| Clientes |
Ttcontato | Tt |
|
| X |
| Contatos |
Ttlead | Tt |
|
| X |
| Lead |
ttgrd_cliente | Tt |
|
| X |
| Clientes Disponíveis na grade de consulta |
ttgrd_contato | Tt |
|
| X |
| Contatos disponíveis na grade de consulta |
ttgrd_lead | Tt |
|
| X |
| Leads disponíveis na grade de consulta |
Método: concat_query
Descrição: executa a query dinâmica gerada a partir de dados do filtro avançado.
Requisitos: nenhum
Parâmetros: nenhum
Método: filtroInternCliente
Descrição: realiza a consulta de clientes de acordo com os parâmetros passados.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-descr | Char |
| X |
|
| Valor do filtro |
c-indice | Char |
| X |
|
| Opção do filtro |
c-dateInic | Char |
| X |
|
| Data inicial |
c-dateFim | Char |
| X |
|
| Data final |
Ttcliente | Tt |
|
| X |
| Clientes |
ttgrd_cliente | Tt |
|
| X |
| Clientes Disponíveis na grade de consulta |
Método: filtroInternContato
Descrição: realiza a consulta de contatos de acordo com os parâmetros passados.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-descr | Char |
| X |
|
| Valor do filtro |
c-indice | Char |
| X |
|
| Opção do filtro |
c-dateInic | Char |
| X |
|
| Data inicial |
c-dateFim | Char |
| X |
|
| Data final |
Ttcontato | Tt |
|
| X |
| Contatos |
ttgrd_contato | Tt |
|
| X |
| Contatos disponíveis na grade de consulta |
Método: filtroInternLead
Descrição: realiza a consulta de leads de acordo com os parâmetros passados.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-descr | Char |
| X |
|
| Valor do filtro |
c-indice | Char |
| X |
|
| Opção do filtro |
c-dateInic | Char |
| X |
|
| Data inicial |
c-dateFim | Char |
| X |
|
| Data final |
Ttlead | Tt |
|
| X |
| Lead |
ttgrd_lead | Tt |
|
| X |
| Leads disponíveis na grade de consulta |
Método: carregaTtGrdCliente
Descrição: carrega somente os clientes filtrados.
Requisitos: nenhum
Parâmetros: nenhum
Método: carregaTtGrdContato
Descrição: carrega somente os contatos filtrados.
Requisitos: nenhum
Parâmetros: nenhum
Método: carregaTtGrdLead
Descrição: carrega somente os leads filtrados.
Requisitos: nenhum
Parâmetros: nenhum
Método: cargaRegistFiltrados
Descrição: carrega temp-table principal com as contas filtradas.
Requisitos: nenhum
Parâmetros: nenhum
Método: filtroGeralPorIndice
Descrição: realiza a consulta de clientes a partir do filtro geral da pesquisa de contas.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-descr | Char |
| X |
|
| Valor do filtro |
c-indice | Char |
| X |
|
| Opção do filtro |
c-dateInic | Char |
| X |
|
| Data inicial |
c-dateFim | Char |
| X |
|
| Data final |
Método: carregaComboBox
Descrição: atualiza a descrição do legend.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
i-idx | Int |
| X |
|
| Índice |
c-descricao | Char |
|
| X |
| Descrição do campo |
Método: validAcesso
Descrição: realiza a consulta de clientes a partir do filtro geral da pesquisa de contas.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-num_id | Char |
| X |
|
| Id da conta |
c-msg | Char |
|
| X |
| Retorno da verificação de acesso |
Método: validHierParam
Descrição: verifica se a regra de times está ativa.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-msg | Char |
| X |
|
| Regara de time ativa |
Método: getFieldLabelZoom
Descrição: realiza a consulta de clientes a partir do filtro geral da pesquisa de contas.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-descr | Char |
| X |
|
| Registro |
c-fieldLabel | Char |
|
| X |
| Label |
Método: CheckAcessGeneral
Descrição: verifica se o usuário terá acesso geral as contas do CRM.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pi-numIdUsuar | Int |
| X |
|
| Id do usuário |
pl-acessGeral | Log |
|
| X |
| Acesso geral |
Método: getListAccoutUser
Descrição: retorna a lista de contas que o usuário tem acesso.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pi-numIdUsuar | Int |
| X |
|
| Id do usuário |
pl-acessGeral | Log |
|
| X |
| Acesso geral |
pl-integrErp | Log |
|
| X |
| Integrado ao ERP |
tt-cta_usuar | Tt |
|
| X |
| Lista de contas do usuário |
Método: getListUserAcess
Descrição: retorna a lista de usuários subordinados ao usuário logado.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pc-codUsuario | Char |
| X |
|
| Usuário |
numIdHier | Int |
| X |
|
| Hierarquia |
numIdTipHier | Int |
| X |
|
| Tipo de hierarquia |
tt-usuar_subor | Tt |
|
| X |
| Lista de usuários subordinados |
Método: carregaGrpClienDefault
Descrição: carrega informações default do grupo de cliente.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
inum_grp_clien | Int |
| X |
|
| Grupo de cliente |
cnum_grp_clien | Char |
|
| X |
| Descrição grupo de cliente |
iTransporte | Int |
|
| X |
| Transportadora |
iRamoAtivi | Int |
|
| X |
| Ramo de atividade |
iUsuarRespons | Int |
|
| X |
| Usuário responsável |
iRepres | Int |
|
| X |
| Representante |
iClassif | Int |
|
| X |
| Classificação |
iTabPrec | Int |
|
| X |
| Tabela de preço |
iCondPag | Int |
|
| X |
| Condição de pagamento |
iPortad | Int |
|
| X |
| Portador |
cnomCategClien | Char |
|
| X |
| Categoria |
cValDesCli | Char |
|
| X |
| Valor desconto cliente |
Método: AccountWithAcess
Descrição: retorna se a empresa esta usando regra de times a clausula where que deverá ser concatenada na query e a temp-table com as contas que o usuário tem acesso.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
plRegraTime | Log |
|
| X |
| Usa regra de time |
cQuery | Char |
|
| X |
| Contém clausula where regra de times |
Ctab | Char |
|
| X |
| Tabela utilizada na criação do buffer |
tt-cta_usuar | Tt |
|
| X |
| Contas que o usuário tem acesso |
Método: checkParamAccountUser
Descrição: verifica se o parâmetro visualiza somente contas da carteira do usuário está ativo .
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
plRegraTime | Log |
|
| X |
| Visualiza somente contas da carteira |
Método: retornaRegistro
Descrição: termina de montar e executa a consulta pelo tipo de conta, utilizando os parâmetros de paginação e regra de times.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pcQuery | Char |
| X |
|
| Query |
cTab1 | Char |
| X |
|
| Tabela 1 |
cTab2 | Char |
| X |
|
| Tabela2 |
cTab | Char |
| X |
|
| Tabela |
plRegraTime | Log |
| X |
|
| Usa regra de times? |
iCurrentPage | Int |
| X |
|
| Pagina corrente no grid |
iPageSize | Int |
| X |
|
| Qtd de registros por pagina |
tt-cta_usuar | Tt |
| X |
|
| Contas que o usuário tem acesso |
totalRecordCli | Tt |
|
| X |
| Cliente resultantes da consulta |
totalRecordCont | Tt |
|
| X |
| Contatos resultantes da consulta |
totalRecordLead | Tt |
|
| X |
| Leads resultantes da consulta |