TipoDocumentoClienteTipoEnderecoTipoEnderecoTipoDocumentoCliente
Informações | ||||||
---|---|---|---|---|---|---|
| ||||||
O método ManterClienteLC_Integracao do Live Connector tem a função de Incluir/alterar clientes do sistema externo para o Live. Existem dois métodos para incluir clientes:
Recebe Objeto Xml no formato Rentech.PracticoLive.Connector.Objects este é o método Padrão e usado pela maioria dos usuários
Recebe as informações de entrada no formato XML. Este método é utilizado pelos usuários que por alguma limitação técnica não conseguem manipular o formato padrão.
|
Nota | ||
---|---|---|
| ||
|
Informações | |||||
---|---|---|---|---|---|
| |||||
Neste método recebemos como Payload uma lista de 1 ou mais clientes ficando . Fica a critério do integrador a quantidade de clientes por requisição, nossa recomendação é passar 1(um) por requisição para maior controle de cada lado da integração e facilitar a abertura de chamados para o Suporte dos sistemas. Para esta finalidade utiliza-se o campo "NumeroSequencia" para determinar o registro na lista ex: passar "011" para o primeiro elemento "022" para o segundo e implementar para cada elemento. Como se trata de um método de entrada é obrigatório passar o numero do ticket(Campo Numero do XML) no formato que o Live Connector aceita conforme regra abaixo:
Exemplo de consumo Via SoapUI: |
Informações | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||
|
Informações | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||
| DataNascimento | Datetime | Sim | |||||||||||||||||||||||||||||
Inativo | Boolean | Indica se o Cliente está inativo. Valor padrão = Falso | Não | |||||||||||||||||||||||||||||
Indicacao | Varchar(120) | Indicação do cliente. | Não | |||||||||||||||||||||||||||||
LGPD_AceiteCarta | Boolean | Aceite da Carta LGPD | Não | |||||||||||||||||||||||||||||
LGPD_DataAceiteCarta | Datetime | Data do aceita da carta LGPD ex:aaaa/mm/dd | Não | |||||||||||||||||||||||||||||
LGPD_IDCarta | Guid | Identificação única interna LGPD | Não | |||||||||||||||||||||||||||||
ListaClassificacaoCliente | array list | Lista de classificação do cliente. O Classificador deve estar cadastrado previamente no TOTVS Live no momento da implantação. Exemplo: Para uma integração Ecommerce pode-se criar no Live um Tipo classificador "CLIENTE ECOMMERCE" e um classificador "ECOMMERCE" e deixar esses valores fixos no Request da integração. | Não | ListaDocumentosCliente | array list | Sim | ||||||||||||||||||||||||||
ListaEnderecos | array list | Lista de endereços do cliente | Sim Deve ter pelo menos 1 Endereço como Principal | |||||||||||||||||||||||||||||
ListaEnderecosEletronico | array list | Lista de endereços eletrônicos do cliente | Não | |||||||||||||||||||||||||||||
ListaLimiteCredito | array list | Lista de limite de crédito do cliente | Não | |||||||||||||||||||||||||||||
ListaModalidades | array list | Lista de limite de modalidades | Não | |||||||||||||||||||||||||||||
ListaTelefones | array list | Lista de telefones do cliente | Não | |||||||||||||||||||||||||||||
Nome_RazaoSocial | Varchar(100) | Nome para pessoa física ou razão social para pessoa jurídica. | Sim | |||||||||||||||||||||||||||||
Nota | Varchar(225) | Nota do cliente. | Não | |||||||||||||||||||||||||||||
NumeroPreVenda | Int | Numero de Pré-Venda associada ao cliente | Não | |||||||||||||||||||||||||||||
Observacoes | Varchar(255) | Observações do cliente. | Não | |||||||||||||||||||||||||||||
Sexo | int | Sexo do cliente. Masculino = 0, Feminino = 1 | Sim | |||||||||||||||||||||||||||||
TipoClassificaoCliente | int | Tipo de classificação do cliente: Indefinido = 0, Cliente = 1 Revendedor = 2 | Sim | |||||||||||||||||||||||||||||
TipoCliente | int | Tipo do cliente Física = 0, Jurídica = 1, Informal = 2 | Sim | |||||||||||||||||||||||||||||
ListaClassificacaoCliente | Tipo | |||||||||||||||||||||||||||||||
Descricao | Varchar(20) | |||||||||||||||||||||||||||||||
DescricaoTipoClassificacao | Varchar(20) | |||||||||||||||||||||||||||||||
ParticipaDesconto | Boolean | |||||||||||||||||||||||||||||||
ListaDocumentosCliente | Tipo | Descrição / Formato | Obrigatório? | |||||||||||||||||||||||||||||
Identificacao | Varchar(50) | Identificação de documento do cliente. | Sim | TipoDocumentoCliente | Varchar(20) |
Este campo é utilizado como código referência para Clientes do Tipo Informal(TipoCliente). Este campo recebe e válida um CPF ou CNPJ válido. | ||||
CodigoLoja | VarChar(9) | Código Loja onde o cliente foi cadastrado. Se for informado essa ele vai encontrar a Central da Loja e cadastrar o cliente na Central. | Não | Caso seja informada um código de loja inválido será retornado erro na inclusão. |
DataNascimento | Datetime | Data de nascimento do cliente ex:1999-12-25 A data deve estar em um intervalo entre 1900-01-01 e a data Atual. | Sim | |
Inativo | Boolean | Indica se o Cliente está inativo. Valor padrão = Falso | Não | |
Indicacao | Varchar(120) | Indicação do cliente. | Não | |
LGPD_AceiteCarta | Boolean | Aceite da Carta LGPD | Não | |
LGPD_DataAceiteCarta | Datetime | Data do aceita da carta LGPD ex:aaaa/mm/dd | Não | |
LGPD_IDCarta | Guid | Identificação única interna LGPD | Não | Envio do ID da carta consentimento |
ListaClassificacaoCliente | array list | Lista de classificação do cliente. O Classificador deve estar cadastrado previamente no TOTVS Live no momento da implantação. Exemplo: Para uma integração Ecommerce pode-se criar no Live um Tipo classificador "CLIENTE ECOMMERCE" e um classificador "ECOMMERCE" e deixar esses valores fixos no Request da integração. | Não | |
ListaDocumentosCliente | array list | Lista de documentos do cliente | Não | |
ListaEnderecos | array list | Lista de endereços do cliente | Sim Deve ter pelo menos 1 Endereço como Principal | |
ListaEnderecosEletronico | array list | Lista de endereços eletrônicos do cliente | Não | |
ListaLimiteCredito | array list | Lista de limite de crédito do cliente | Não | |
ListaModalidades | array list | Lista de limite de modalidades | Não | |
ListaTelefones | array list | Lista de telefones do cliente | Não | |
Nome_RazaoSocial | Varchar(100) | Nome para pessoa física ou razão social para pessoa jurídica. | Sim | |
Nota | Varchar(225) | Nota do cliente. | Não | |
NumeroPreVenda | Int | Numero de Pré-Venda associada ao cliente | Não | |
Observacoes | Varchar(255) | Observações do cliente. | Não | |
Sexo | VarChar | Sexo do cliente: Masculino Feminino O valor é case sensitive e deve ser passado exatamente como exemplo acima. | Não Caso não informado assume o padrão do sistema como sexo Masculino | Método ManterClienteLC_Integracao_Xml utiliza o tipo Int. 0 - Masculino 1 - Feminino |
TipoClassificacaoCliente | VarChar | Tipo de classificação do cliente: Indefinido Cliente Revendedor O valor é case sensitive e deve ser passado exatamente como exemplo acima. | Não Caso não informado assume o padrão do sistema como tipo Cliente | Método ManterClienteLC_Integracao_Xml utiliza o tipo Int. 0 - Indefinido 1 - Cliente 2 - Revendedor |
TipoCliente | VarChar | Tipo do cliente Física Jurídica O valor é case sensitive e deve ser passado exatamente como exemplo acima. | Não Caso não informado assume o padrão do sistema como pessoa Física | Método ManterClienteLC_Integracao_Xml utiliza o tipo Int. 0 - Física 1 - Jurídica |
ListaEnderecos
Tipo
CEP do endereço do cliente.
Formato aceito:
02511000
02511-000
02511.000
Varchar(200)
Complemento do endereço do cliente.
Este campo pode ser usado para adicionar o Pais do Cliente caso necessário.
Varchar(2)
Varchar(100)
Tipo do endereço do cliente:
Principal
Entrega
Comercial
Cobrança
ListaEnderecos | Tipo | Descrição/ Formato | Obrigatório? | Observação |
Bairro | Varchar(50) | Bairro do endereço do cliente. Caso ultrapassar o tamanho máximo o valor será truncado. | Sim | |
CEP | Varchar(10) | CEP do endereço do cliente. Formato aceito: 02511000 02511-000 02511.000 Caso ultrapassar o tamanho máximo o valor será truncado. | Sim | |
Cidade_NumeroMunicipioIBGE | Int | Código IBGE da cidade do endereço do cliente. | Não | Caso o código do IBGE não seja enviado, as informações de Cidade / Estado/ Pais não serão registradas no Live. |
Complemento | Varchar(200) | Complemento do endereço do cliente. Este campo pode ser usado para adicionar o Pais do Cliente caso necessário. | Não | |
Estado | Varchar(2) | Estado do endereço do cliente. | Sim | |
Logradouro | Varchar(100) | Logradouro do endereço do cliente. | Sim | |
Numero | Int | Número do endereço do cliente. | Não | |
TipoEndereco | VarChar | Tipo do endereço do cliente: Principal Entrega Comercial Cobrança |
Residencial O valor é case sensitive e deve ser passado exatamente como exemplo acima. Deve ser passado pelo menus 1(um) endereço como Principal. | Sim |
ListaEnderecosEletronico
Tipo
Caso não informado a tag, assume o valor como Principal | Método ManterClienteLC_Integracao_Xml utiliza o tipo Int. 0 - Principal 1 - Entrega 2 - Comercial 3 - Cobrança 4 - Residencial |
ListaClassificacaoCliente | Tipo | Descrição / Formato | Obrigatório? |
Descricao | Varchar( |
20) |
Descricao do |
classifidor do cliente |
Não
(Se torna obrigatório se passar valor no campo TipoEnderecoEletronico)
Tipo do endereço eletrônico informado:
Email = 0,
Site = 1
Aceita apenas um Endereço eletrônico por tipo
Sim | |||
DescricaoTipoClassificacao | Varchar(20) | Descricao do tipo do classifidor do cliente | Sim |
ParticipaDesconto | Boolean | Classificação participa de descontos | Não |
ListaDocumentosCliente | Tipo | Descrição |
Não
(Se torna obrigatório se passar valor no campo Descricao)
ListaLimiteCredito
Tipo
/ Formato | Obrigatório? |
Observação | ||
Identificacao | Varchar(50) | Identificação de documento |
do cliente. | Sim |
TipoDocumentoCliente | Varchar(20) |
Tipo do |
Documento do Cliente aceitos: RG, Cracha, CPF, CNPJ, IE, IM Ex: CPF para clientes pessoa física: O valor é case sensitive e deve ser passado exatamente como exemplo acima. | Sim | Método ManterClienteLC_Integracao_Xml utiliza o tipo Int. 0 - RG 1 - Cracha 2 - CPF 3 - CNPJ 4 - IE 5 - IM *** Para cliente informal deve passar um CPF válido. |
ListaEnderecosEletronico | Tipo | Descrição |
ListaModalidades
Tipo
/ Formato | Obrigatório? |
Observação | |
Descricao | Varchar( |
60) | Descrição |
do endereço eletrônico do cliente. ex: [email protected] | Sim |
TipoEnderecoEletronico | Varchar | Tipo |
Complemento do telefone, pode ser usado para adicionar o DDI por exemplo.
Ex: DDI +55
Principal = 0, Cobrança = 1,
Residencial = 2, Entrega = 3,
Recados = 4, Fax = 5,
Comercial = 6, Celular = 7
do endereço eletrônico informado: Site Aceita apenas um Endereço eletrônico por tipo O valor é case sensitive e deve ser passado exatamente como exemplo acima. | Sim | Método ManterClienteLC_Integracao_Xml utiliza o tipo Int. 0 - Email 1 - Site |
ListaLimiteCredito | Tipo | Observação / Formato | Obrigatório? |
Ativo | Boolean | Status do contrato de crédito do cliente. | Sim |
CodigoLoja | Varchar(20) | Código de loja do crédito do cliente. | Sim |
LimiteCredito | Double | Limite de crédito do cliente | Sim |
LimiteMensal | Double | Limite mensagem de crédito do cliente. | Sim |
Estado | Varchar(20) | Nome do contrato de crédito do cliente | Sim |
ListaModalidades | Tipo | Observação / Formato | Obrigatório? |
Codigo | int | Código da modalidade. | Sim |
Descricao | Varchar(30) | Descrição da Modalidade | Sim |
ListaTelefones | Tipo | Observação / Formato | Obrigatório? | Observação |
Complemento | Varchar(30) | Complemento do telefone, pode ser usado para adicionar o DDI por exemplo. Ex: DDI +55 | Não | |
DDD | Varchar(3) | DDD do Telefone cadastrado | Sim | |
Numero | Varchar(9) | Numero do telefone | Sim | |
TipoTelefone | Varchar(30) | Tipo do telefone: Principal Cobrança Residencial Entrega Recados Fax Comercial Celular O valor é case sensitive e deve ser passado exatamente como exemplo acima. | Sim | Método ManterClienteLC_Integracao_Xml utiliza o tipo Int. 0 - Principal 1 - Cobrança 2 - Residencial 3 - Entrega 4 - Recados 5 - Fax 6 - Comercial 7 - Celular |
Informações | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||
1 - Exemplo somente com campos obrigatórios:
2 - Exemplo com demais campos:
| ||||||||||||||||||||||||||||||||||||
Informações | ||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||
|