Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Informações
titleDocumentos - Campos de Entrada
Aviso
titleImportante

Os parâmetros devem ser passados na ordem apresentada abaixo.



Cliente (Campos)

Tipo

Descrição/ FormatoObrigatório?Observação
NumeroSequenciaVarchar(6)

Numero sequencia do documento implementar a cada documento.

Ex: 1

Sim
ApelidoVarchar(100)Apelido do ClienteNã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
95.823.917/0001-00


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. 


CodigoLojaVarChar(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ãoCaso seja informada um código de loja inválido será retornado erro na inclusão.
DataNascimentoDatetime
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
InativoBoolean

Indica se o Cliente está inativo.

Valor padrão =  Falso

Não
IndicacaoVarchar(120)Indicação do cliente.Não
LGPD_AceiteCarta

Boolean

Aceite da Carta LGPDNão
LGPD_DataAceiteCartaDatetime
Data do aceita da carta LGPD ex:
aaaa/mm/dd
Não
LGPD_IDCartaGuidIdentificação única interna LGPDNãoEnvio do ID da carta consentimento
ListaClassificacaoClientearray 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
ListaDocumentosClientearray list

Lista de documentos do cliente


Não


ListaEnderecosarray listLista de endereços do cliente

Sim

Deve ter pelo menos 1 Endereço como Principal


ListaEnderecosEletronicoarray listLista de endereços eletrônicos do clienteNão
ListaLimiteCreditoarray listLista de limite de crédito do clienteNão
ListaModalidadesarray list

Lista de limite de modalidades

Não
ListaTelefonesarray listLista de telefones do clienteNã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
NumeroPreVendaIntNumero de Pré-Venda associada ao clienteNã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

TipoClassificacaoClienteVarChar

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/ FormatoObrigatório?Observação
BairroVarchar(50)

Bairro do endereço do cliente.

Caso ultrapassar o tamanho máximo o valor será truncado.

Sim
CEPVarchar(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_NumeroMunicipioIBGEIntCódigo IBGE da cidade do endereço do cliente.NãoCaso 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
NumeroIntNúmero do endereço do cliente.Não
TipoEnderecoVarChar

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 / FormatoObrigatório?
Descricao

Varchar(20)

Descricao do classifidor do clienteSim
DescricaoTipoClassificacao

Varchar(20)

Descricao do tipo do classifidor do clienteSim
ParticipaDescontoBooleanClassificação participa de descontosNão

ListaDocumentosCliente

Tipo

Descrição / FormatoObrigatório?Observação
Identificacao

Varchar(50)

Identificação de documento do cliente.Sim
TipoDocumentoClienteVarchar(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/ FormatoObrigatório?Observação
DescricaoVarchar(60)Descrição do endereço eletrônico do cliente. ex: [email protected]

Sim



TipoEnderecoEletronicoVarchar

Tipo do endereço eletrônico informado:

Email 

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 / FormatoObrigatório?
AtivoBooleanStatus do contrato de crédito do cliente.Sim
CodigoLojaVarchar(20)Código de loja do crédito do cliente.Sim
LimiteCreditoDoubleLimite de crédito do clienteSim
LimiteMensalDoubleLimite mensagem de crédito do cliente.Sim
EstadoVarchar(20)Nome do contrato de crédito do clienteSim

ListaModalidades

Tipo

Observação / FormatoObrigatório?
CodigointCódigo da modalidade.Sim
DescricaoVarchar(30)Descrição da Modalidade Sim

ListaTelefones

Tipo

Observação / FormatoObrigatório?Observação
ComplementoVarchar(30)

Complemento do telefone, pode ser usado para adicionar o DDI por exemplo.

Ex: DDI +55

Não
DDDVarchar(3)DDD do Telefone cadastradoSim
NumeroVarchar(9)Numero do telefoneSim
TipoTelefoneVarchar(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




...