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