apiFacilitAccount

Propaganda
CRM
1
apiFacilitAccount
Banco
MDTCRM.
Aplicativo
INOVAÇÃO.
Descrição
Api utilizada para facilitar o cadastro de contas.
Nome Físico
crmapi\apiFacilitAccount.p
Revisão
13/10/2011
Objetivo
Facilitar o cadastro de contas no CRM.
CRM
2
Tabelas Temporárias
Atributos das tabelas temporárias de entrada e saída:
ttAccount
Atributo
numId
Tipo
Int
Formato
Descrição
Código
Obr.
Tipo
Int
Char
Char
Char
Formato
Descrição
Código
Tipo de Conta
Tipo de Pessoa
Nome/Razão Social
Obr.
Formato
Descrição
Nome Informal
Nome Informa Requerido
Sexo
Sexo Requerido
Data de Nascimento
Data de Nascimento Requerida
Responsável
Responsável Requerido
Representante
Representante Requerido
Estado Civil
Estado Civil Requerido
CPF
CPF Requerido
Melhor Horário
Melhor Horário Requerido
RG
RG Requerido
Faturamento
Faturamento Requerido
Tratamento
Tratamento Requerido
Fonte
Fonte Requerida
Vínculo
Nome do Contato
Nome do Contato Requerido
Telefone
Telefone Requerido
Ramal
Celular
Celular Requerido
Email 1
Email 1 Requerido
Email 2
Email 2 Requerido
Endereço
Endereço Requerido
Descrição
Descrição Requerida
Emp. Func. Requerido
Emp. Func.
Website Requerido
Website
Grupo de Cliente
Obr.
ttGeradas
Atributo
num_id
idi_tip_cta
idi_tip_pessoa
nom_razao_social
ttCrmConfigurPessoalFacil
Atributo
nomeInfor
nomeInforRequired
Sexo
SexoRequired
dataNasc
dataNascRequired
Respons
responsRequired
Repres
represRequired
estadCiv
estadCivRequired
CPF
cpfRequired
melhorHor
melhorHorRequired
RG
rgRequired
Fatur
faturRequired
Tratam
tratamRequired
Fonte
fonteRequired
Vinculo
nomContat
nomContatRequired
Telef
telefRequired
Ramal
Celular
celularRequired
email1
email1Required
email2
email2Required
Ender
enderRequired
Descr
descrRequired
EmpFuncRequired
EmpFunc
WebSiteRequired
WebSite
grpClien
Tipo
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Log
Int
CRM
3
ttender
Atributo
Lograd
bairro
cidade
uf
Pais
Tipo
Char
Char
Char
Char
Char
Formato
Descrição
Logradouro
Bairro
Cidade
Unidade de Federação
País
Obr.
Tipo
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Formato
Descrição
Nome / Razão Social
Tipo de Conta
Tipo de Pessoa
Nome Informal
Sexo
Data de Nascimento
Responsável
Representante
Estado Civil
CPF
Melhor Horário
RG
Faturamento
Tratamento
Fonte
Vínculo
Nome do Contato
Telefone
Ramal
Celular
Email 1
Email 2
Logradouro
Referência
Número
CEP
Bairro
Cidade
Unidade de Federação
País
Descrição
Website
Emp. Func.
Grupo de Cliente
Obr.
Tipo
Char
Int
Formato
Char
Int
Descrição
Erro
Código
Obr.
Tipo
Int
Formato
Descrição
Código
Obr.
Formato
Descrição
Código
Nome/Razão Social
Nome Informal
Idi Tipo Conta
Idi Tip Pessoa
Obr.
ttAddCrmConfigurPessoalFacil
Atributo
nomeRazao
idiTipCta
idiTipPessoa
nomeInfor
Sexo
dataNasc
Respons
Repres
estadCiv
CPF
melhorHor
RG
Fatur
Tratam
Fonte
Vinculo
nomContat
Telef
Ramal
Celular
email1
email2
Lograd
Refer
Numero
CEP
Bairro
Cidade
Uf
Pais
Descr
webSite
EmpFunc
grpClien
ttError01
Atributo
Erro
numIdAccountFacil
ttAccountFacilit
Atributo
numId
ttPessoaFacil
Atributo
num_id
nom_razao_social
nom_infml
idi_tip_cta
idi_tip_pessoa
Tipo
Int
Char
Char
Int
Int
CRM
tip_cta
tip_pessoa
dsl_observacao
idi_sexo
sexo
nom_celular
nom_contato
nom_cpf
nom_cnpj
nom_reg_geral
nom_emp_func
nom_email_1
nom_email_2
nom_telefone
num_ramal
nom_web_site
num_id_contat
num_id_estado_civil
num_id_pais
num_id_uf
num_id_bairro
num_id_cidad
estado_civil
nom_cep
pais
uf
cidad
bairro
nom_lograd_ender
num_lograd
nom_refer
num_id_fonte
num_id_grp_clien
num_id_horar
num_id_repres
num_id_tip_vinc
num_id_tratam
num_id_usuar_cadastro
num_id_usuar_respons
fonte
grp_clien
horar
repres
tip_vinc
tratam
usuar_cadastro
usuar_respons
val_faturam
dat_nascimento
dat_cadastro
dsl_erro_proces
4
Char
Char
Char
Int
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Char
Tipo Conta
Tipo Pessoa
Observação
Idi Sexo
Sexo
Celular
Contato
CPF
CNPJ
RG
Empresa Funcionário
Email 1
Email 2
Telefone
Ramal
Web Site
Código do Contato
Código do Estado Civil
Código do País
Código da Unidade de Federação
Código do Bairro
Código da Cidade
Estado Civil
CEP
País
UF
Cidade
Bairro
Endereço
Numero
Referência
Código da Fonte
Código do Grupo de Cliente
Código do Horário
Código do Representante
Código do Tipo de Vínculo
Código do Tratamento
Código do Usuário Cadastrado
Código do Usuário Responsável
Fonte
Grupo de Cliente
Melhor Horário
Representante
Tipo de Vinculo
Tratamento
Usuário de Cadastro
Usuário Responsável
Faturamento
Data Nascimento
Data Cadastro
Erros Processo
CRM
5
Métodos
Métodos básicos
Método: FindAccount
Descrição: retorna as contas recém inseridas na tabela crm_pessoa, a partir do cadastro
facilitado de contas
Requisitos: nenhum
Parâmetros:
Parâmetro
Tipo
ttAccount
ttGeradas
Tt
Tt
Formato
I
O
IO
Descrição
X
Contas ainda não geradas
Contas geradas
X
Método: checkConfigFacilitAccount
Descrição: retorna uma temp-table com a parametrização de campos necessárias para
preenchimento do cadastro facilitado de contas.
Requisitos: nenhum
Parâmetros:
Parâmetro
Tipo
pi-tipCta
pi-tipPessoa
l-erro
ttCrmConfigurPessoalFacil
Int
Int
Log
Tt
For
mat
o
I
O
IO
X
X
Descrição
Tipo de conta
Tipo de pessoa
Erro
Parametrização de campos da cadastro
facilitado de contas.
X
X
Método: findZipCode
Descrição: retorna o endereço da conta a partir do cep.
Requisitos: nenhum
Parâmetros:
Parâmetro
Tipo
Cep
Ttender
l-suspenso
Char
Tt
Log
Formato
I
O
X
X
X
IO
Descrição
Cep
Relação com o endereço da conta
suspenso
Método: addConfigFacilitAccount
Descrição: adiciona um novo registro na tabela de facilitado de contas.
Requisitos: nenhum
Parâmetros:
CRM
6
Parâmetro
Tipo
ttAddCrmConfigurPess
oalFacil
pi-facilPessoa
ttError01
Tt
Formato
I
O
IO
X
Conta facilitada
X
Int
Tt
Descrição
X
Id da Conta facilitada gerada
Relação de erros
Método: destroyHandle
Descrição: remove os handles da memória.
Requisitos: nenhum
Parâmetros: nenhum
Método: addAccount
Descrição: adiciona novas contas na tabela crm_pessoa.
Requisitos: nenhum
Parâmetros:
Parâmetro
Tipo
ttAccount
ttError01
ttAccount
Tt
Tt
Tt
Formato
I
O
IO
X
Descrição
Contas ainda não geradas
Relação de erros
Relação de contas restantes aguardando
geração na tabela crm_pessoa
X
X
Método: DeleteAccountFacilit
Descrição: remove contas facilitadas.
Requisitos: nenhum
Parâmetros:
Parâmetro
Tipo
ttAccountFacilit
l-pushButtonDelete
ttError01
Tt
Log
Tt
Formato
I
O
X
x
X
IO
Descrição
Contas ainda não geradas
remover
Relação de erros
Método: InfoGrpClien
Descrição: retornas as informações default do grupo de cliente que poderão ser
utilizados no cadastro da conta.
CRM
7
Requisitos: nenhum
Parâmetros:
Parâmetro
Tipo
grpCliente
Classificação
Transporte
ramoAtividade
Representante
Responsável
CondPagamento
Portador
tabelaPreco
categCliente
Int
Int
Int
Int
Int
Int
Int
Int
Int
Char
Formato
I
O
IO
X
Descrição
Grupo de cliente
Classificação
Transporte
Ramo de atividade
Representante
Responsável
Condição de pagamento
Portador
Tabela de preço
Categoria de cliente
X
X
X
X
X
X
X
X
X
Método: LoadPersonAccount
Descrição: retornas as contas facilitadas ainda não geradas na tabela crm_pessoa.
Requisitos: nenhum
Parâmetros:
Parâmetro
Tipo
ttPessoaFacil
Tt
Formato
I
O
IO
X
Descrição
Contas ainda não geradas
Método: integracaoAtiva
Descrição: verifica se os parâmetros de integração do CRM estão ativos.
Requisitos: nenhum
Parâmetros:
Parâmetro
Tipo
plIntgrEMS
Log
Formato
I
O
X
IO
Descrição
Integração com ERP
CRM
8
Método: integradoCRMEMS
Descrição: verifica se a integração on-line com o ERP está ativa.
Requisitos: nenhum
Parâmetros:
Parâmetro
Tipo
isIntegrated
Log
Formato
I
O
X
IO
Descrição
Integração on-line
Download