TipoEnderecoTipoEnderecoTipoDocumentoCliente
Pré-requisitos
Exemplo de Utilização:
Neste método recebemos como Payload uma lista de 1 ou mais clientes. 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 "1" para o primeiro elemento "2" 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:
DICA 01: Formato do número do Ticket
O Número do Ticket do Live deverá ser uma string de 16 caracteres, composta pelo primeiro dígito um Zero(0) para ticket de entrada seguido do ano atual (dois dígitos), mês, dia, hora, minuto, segundo e milissegundos atuais.
Exemplo de número para a data de criação igual “2019-12-11 14:05:46.677”
Numero Ticket = 0191211140546677.
Exemplo de consumo Via SoapUI:
Parâmetros de Entrada
| Campo | Tipo | Formato | Descrição | Obrigatório? |
|---|---|---|---|---|
| Data | VarChar(8) | yyyyMMdd | Data da solicitação ex: 20200729 | Sim |
| Hora | VarChar(6) | hhmmss | Hora da solicitação ex: 160055 | Sim |
| CodigoSistemaSatelite | VarChar(10) | Cliente Solicita com time de Serviços Live | Sim | |
| Chave | Guid | Chave de acesso Obtida no método ObterChaveAcesso | Sim | |
| Numero | String | 0AAMMDDHHMMSSMMM | Número do Ticket de entrada, ver detalhes no item "DICA 01" acima | Sim |
| Documentos | List | Objetos de Ticket(Documento) no formato da mensagem ver detalhes abaixo | Sim |
Documentos - Campos de Entrada
Importante
Os parâmetros devem ser passados na ordem apresentada abaixo.
Cliente (Campos) | Tipo | Descrição/ Formato | Obrigatório? | Observação |
| NumeroSequencia | Varchar(6) | Numero sequencia do documento implementar a cada documento. Ex: 1 | Sim | |
| Apelido | Varchar(100) | Apelido do Cliente | Não | |
| CPF_CNPJ | Varchar(20) | Numero do documento do Cliente CPF ou CNPJ Formatos CPF válidos: 67925165030 679.251.650-30 Formatos CNPJ válidos: 95823917000100 | Sim | 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 | 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 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 | 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 / 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/ Formato | Obrigatório? | Observação |
| Descricao | Varchar(60) | Descrição do endereço eletrônico do cliente. ex: [email protected] | Sim | |
| TipoEnderecoEletronico | Varchar | Tipo 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 |
Exemplo de chamada e retorno do método ManterClienteLC_Integracao e ManterClienteLC_Integracao_Xml
1 - Exemplo somente com campos obrigatórios:
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:liv="http://LiveConnector/" xmlns:ren="http://schemas.datacontract.org/2004/07/Rentech.Framework.Data" xmlns:ren1="http://schemas.datacontract.org/2004/07/Rentech.PracticoLive.Connector.Objects">
<soapenv:Header />
<soapenv:Body>
<liv:ManterClienteLC_Integracao>
<liv:cliente>
<ren1:Chave>9635e913-e264-458a-8015-2fd924e7ff96</ren1:Chave>
<ren1:CodigoSistemaSatelite>05140003</ren1:CodigoSistemaSatelite>
<ren1:Data>99999999</ren1:Data>
<ren1:Hora>160000</ren1:Hora>
<ren1:Numero>0201211140546806</ren1:Numero>
<ren1:Documentos>
<ren1:LC_Cliente>
<ren1:NumeroSequencia>1</ren1:NumeroSequencia>
<ren1:CPF_CNPJ>73412674028</ren1:CPF_CNPJ>
<ren1:DataNascimento>1999-12-25</ren1:DataNascimento>
<ren1:ListaEnderecos>
<ren1:LC_Endereco>
<ren1:Bairro>Santana</ren1:Bairro>
<ren1:CEP>02511000</ren1:CEP>
<ren1:Complemento>1 ANDAR</ren1:Complemento>
<ren1:Estado>SP</ren1:Estado>
<ren1:Logradouro>AVENIDA BRAZ LEME</ren1:Logradouro>
<ren1:Numero>1000</ren1:Numero>
<ren1:TipoEndereco>Principal</ren1:TipoEndereco>
</ren1:LC_Endereco>
</ren1:ListaEnderecos>
<ren1:Nome_RazaoSocial>Rafael</ren1:Nome_RazaoSocial>
</ren1:LC_Cliente>
</ren1:Documentos>
</liv:cliente>
</liv:ManterClienteLC_Integracao>
</soapenv:Body>
</soapenv:Envelope>
2 - Exemplo com demais campos:
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:liv="http://LiveConnector/" xmlns:ren="http://schemas.datacontract.org/2004/07/Rentech.Framework.Data" xmlns:ren1="http://schemas.datacontract.org/2004/07/Rentech.PracticoLive.Connector.Objects">
<soapenv:Header />
<soapenv:Body>
<liv:ManterClienteLC_Integracao>
<liv:cliente>
<ren1:Chave>afd7b010-7f22-4d0e-98d4-e6d1e786dddd</ren1:Chave>
<ren1:CodigoSistemaSatelite>99999999</ren1:CodigoSistemaSatelite>
<ren1:Data>20200729</ren1:Data>
<ren1:Hora>160000</ren1:Hora>
<ren1:Numero>0201211140546810</ren1:Numero>
<ren1:Documentos>
<ren1:LC_Cliente>
<ren1:NumeroSequencia>1</ren1:NumeroSequencia>
<ren1:Apelido>Meu apelido</ren1:Apelido>
<ren1:CPF_CNPJ>73412674028</ren1:CPF_CNPJ>
<ren1:DataNascimento>1999-12-25</ren1:DataNascimento>
<ren1:Inativo>false</ren1:Inativo>
<ren1:Indicacao>indicacao</ren1:Indicacao>
<ren1:ListaClassificacaoCliente>
<ren1:LC_ClassificacaoCliente>
<ren1:Descricao>UPA</ren1:Descricao>
<ren1:DescricaoTipoClassificacao>CLIENTE FIDELIDADE</ren1:DescricaoTipoClassificacao>
<ren1:ParticipaDesconto>false</ren1:ParticipaDesconto>
</ren1:LC_ClassificacaoCliente>
</ren1:ListaClassificacaoCliente>
<ren1:ListaDocumentosCliente>
<ren1:LC_DocumentoCliente>
<ren1:Identificacao>73412674028</ren1:Identificacao>
<ren1:TipoDocumentoCliente>CPF</ren1:TipoDocumentoCliente>
</ren1:LC_DocumentoCliente>
</ren1:ListaDocumentosCliente>
<ren1:ListaEnderecos>
<ren1:LC_Endereco>
<ren1:Bairro>Santana</ren1:Bairro>
<ren1:CEP>02511000</ren1:CEP>
<ren1:Complemento>1 ANDAR</ren1:Complemento>
<ren1:Estado>SP</ren1:Estado>
<ren1:Logradouro>AVENIDA BRAZ LEME</ren1:Logradouro>
<ren1:Numero>1000</ren1:Numero>
<ren1:TipoEndereco>Principal</ren1:TipoEndereco>
</ren1:LC_Endereco>
</ren1:ListaEnderecos>
<ren1:ListaEnderecosEletronico>
<ren1:LC_EnderecoEletronico>
<ren1:Descricao>[email protected]</ren1:Descricao>
<ren1:TipoEnderecoEletronico>Site</ren1:TipoEnderecoEletronico>
</ren1:LC_EnderecoEletronico>
</ren1:ListaEnderecosEletronico>
<ren1:ListaLimiteCredito>
<ren1:LC_LimiteCredito>
<ren1:Ativo>true</ren1:Ativo>
<ren1:CodigoLoja>99999999</ren1:CodigoLoja>
<ren1:LimiteCredito>1000</ren1:LimiteCredito>
<ren1:LimiteMensal>10000</ren1:LimiteMensal>
<ren1:NomeContrato>Contrato 999888</ren1:NomeContrato>
</ren1:LC_LimiteCredito>
</ren1:ListaLimiteCredito>
<ren1:ListaTelefones>
<ren1:LC_Telefone>
<ren1:Complemento>Ramal 333</ren1:Complemento>
<ren1:DDD>11</ren1:DDD>
<ren1:Numero>11999999990</ren1:Numero>
<ren1:TipoTelefone>Celular</ren1:TipoTelefone>
</ren1:LC_Telefone>
</ren1:ListaTelefones>
<ren1:Nome_RazaoSocial>Rafael</ren1:Nome_RazaoSocial>
<ren1:Sexo>Masculino</ren1:Sexo>
<ren1:TipoClassificaoCliente>Cliente</ren1:TipoClassificaoCliente>
<ren1:TipoCliente>Fisica</ren1:TipoCliente>
</ren1:LC_Cliente>
</ren1:Documentos>
</liv:cliente>
</liv:ManterClienteLC_Integracao>
</soapenv:Body>
</soapenv:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<ManterClienteLC_IntegracaoResponse xmlns="http://LiveConnector/">
<ManterClienteLC_IntegracaoResult xmlns:a="http://schemas.datacontract.org/2004/07/Rentech.PracticoLive.Connector.Objects" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"/>
</ManterClienteLC_IntegracaoResponse>
</s:Body>
</s:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:liv="http://LiveConnector/"> <soapenv:Header/> <soapenv:Body> <liv:ManterClienteLC_Integracao_Xml> <liv:codigoSistemaSatelite>1111111</liv:codigoSistemaSatelite> <liv:xmlTicketCliente> <![CDATA[<?xml version="1.0"?> <LC_TicketCliente> <Chave>4212ce50-4b8f-4da6-a0b6-c25c9f87d406</Chave> <CodigoSistemaSatelite>111111111</CodigoSistemaSatelite> <Data>20200729</Data> <Hora>160000</Hora> <Numero>00003</Numero> <Documentos> <LC_Cliente> <Apelido>Rafael P</Apelido> <CPF_CNPJ>01068124083</CPF_CNPJ> <DataNascimento>01/02/1999</DataNascimento> <Inativo>false</Inativo> <Indicacao/> <Nome_RazaoSocial>Rafael P</Nome_RazaoSocial> <Nota>0</Nota> <NumeroSequencia>1</NumeroSequencia> <Observacoes>Observação TESTE </Observacoes> <Sexo>1</Sexo> <TipoCliente>1</TipoCliente> <TipoClassificacaoCliente>2</TipoClassificacaoCliente> <ListaClassificacaoCliente> <LC_ClassificacaoCliente> <Descricao>ATACADO VIP</Descricao> <DescricaoTipoClassificacao>CLIENTE ATACADO</DescricaoTipoClassificacao> <ParticipaDesconto>false</ParticipaDesconto> </LC_ClassificacaoCliente> </ListaClassificacaoCliente> <ListaDocumentosCliente> <LC_DocumentoCliente> <Identificacao>01068124083</Identificacao> <TipoDocumentoCliente>1</TipoDocumentoCliente> </LC_DocumentoCliente> </ListaDocumentosCliente> <ListaEnderecos> <LC_Endereco> <Bairro>ANHANGABAU</Bairro> <CEP>13208056</CEP> <Cidade_NumeroMunicipioIBGE>3525904</Cidade_NumeroMunicipioIBGE> <Complemento>1 ANDAR</Complemento> <Estado>SP</Estado> <Logradouro>AVENIDA NOVE DE JULHO</Logradouro> <Numero>2960</Numero> <TipoEndereco>0</TipoEndereco> </LC_Endereco> </ListaEnderecos> <ListaEnderecosEletronico> <LC_EnderecoEletronico> <Descricao>[email protected]</Descricao> <TipoEnderecoEletronico>0</TipoEnderecoEletronico> </LC_EnderecoEletronico> </ListaEnderecosEletronico> <ListaTelefones> <LC_Telefone> <Complemento>RAMAL 8800</Complemento> <DDD>11</DDD> <Numero>123456789321</Numero> <TipoTelefone>0</TipoTelefone> </LC_Telefone> </ListaTelefones> <ListaLimiteCredito> <LC_LimiteCredito> <Ativo>true</Ativo> <CodigoLoja>01851716000165</CodigoLoja> <LimiteCredito>75</LimiteCredito> <LimiteMensal>750</LimiteMensal> <NomeContrato>TESTE JOAO 1</NomeContrato> </LC_LimiteCredito> <LC_LimiteCredito> <Ativo>false</Ativo> <CodigoLoja>01851716000165</CodigoLoja> <LimiteCredito>40</LimiteCredito> <LimiteMensal>400</LimiteMensal> <NomeContrato>TESTE JOAO 2</NomeContrato> </LC_LimiteCredito> </ListaLimiteCredito> </LC_Cliente> </Documentos> </LC_TicketCliente>]]> </liv:xmlTicketCliente> </liv:ManterClienteLC_Integracao_Xml> </soapenv:Body> </soapenv:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ManterClienteLC_Integracao_XmlResponse xmlns="http://LiveConnector/"> <ManterClienteLC_Integracao_XmlResult> <![CDATA[<?xml version="1.0" encoding="utf-8"?> <Resultado> <LC_Retorno> <Chave>27badbda-d179-4c85-9172-c7bec32632d0</Chave> <CodigoErro>0</CodigoErro> <CodigoSistemaSatelite>05140003</CodigoSistemaSatelite> <Data>10/08/2020</Data><DescricaoErro>Processamento realizado com sucesso</DescricaoErro> <Hora>11:59</Hora> <NumeroSequencia>0</NumeroSequencia> <NumeroTicket>0</NumeroTicket> </LC_Retorno> </Resultado>]]> </ManterClienteLC_Integracao_XmlResult> </ManterClienteLC_Integracao_XmlResponse> </s:Body> </s:Envelope>