# Integração de cadastros

# Cadastrar bloqueio

Os bloqueios são cadastrados para posteriormente serem utilizados na associação com clientes. Esses bloqueios podem vir de origens diferentes, podendo ser de provedores ou sistemas de gestão.

A interface do WebService pode ser consultada em: http://localhost:71/CadastroBloqueio.svc (opens new window)

Método relacionado a este serviço: CadastrarBloqueio DcBloqueio

Campo Descrição Tipo Tam. Obr.
Codigo Código do bloqueio String 10 Sim
NomeOrigem Nome da origem deve ser o mesmo cadastrado no Sistema DepsNet.
A origem é o nome do sistema de gestão de onde o WebService é invocado
String 40 Sim
NomeBloqueio Nome do bloqueio String 60 Sim
TipoValidacao Tipo da validação do bloqueio
1. Por Raiz
2. Por CNPJ
3. Por Grupo
Ex.: Caso um bloqueio deva ser somente bloqueio para CNPJ, enviar tipo validação = 2.
Obs.: Se o campo não for informado, adicionará como padrão 1.
Int 1 Não
  • Para retorno dos dados: DataContractRetornoProcessamento

# Cadastrar grupo econômico

O cadastro de grupos econômicos é utilizado para associar vários clientes a um grupo. Caso no grupo de pessoas um cliente não esteja cadastrado, será emitida uma mensagem de aviso ao usuário, para cadastro do cliente e depois do grupo.

A interface do WebService pode ser consultada em: http://localhost:71/CadastroGrupoEconomico.svc (opens new window)

Método relacionado a este serviço: CadastrarGrupoEconomico DcGrupoEconomico

Campo Descrição Tipo Tam. Obr.
CodigoSistemaGestao Código interno do sistema de gestão, mesmo código de onde o WebService é invocado. String 50 Não
Nome Nome do grupo econômico String 100 Sim
NomeOrigem Nome da origem deve ser o mesmo cadastrado no Sistema DepsNet.
A origem é o nome do sistema de gestão de onde o WebService é invocado.
String 40 Sim
  • Para retorno dos dados: DataContractRetornoProcessamento

# Cadastrar representante

Esse serviço tem como objetivo cadastrar os representantes no sistema, o mesmo pode ser associado a uma nota fiscal ou título.

A interface do WebService pode ser consultada em: http://localhost:71/CadastroRepresentante.svc (opens new window)

Método relacionado a este serviço: CadastrarRepresentante DcRepresentante

Campo Descrição Tipo Tam. Obr.
Tipo Tipo do representante:
J - Jurídica
F - Física
E - Exportação
String 1 Sim
Documento - CNPJ quando for pessoa jurídica
- CPF quando for pessoa física
- Código identificador para pessoa do tipo Exportação
String 15 Sim
Nome - Se o tipo do representante é "J" deve ser informado o nome fantasia
- Se o tipo do representante é "F" então é o nome da pessoa
- Se o tipo de representante é "E" deve ser informado um nome identificador do representante exportação
String 200 Sim
NomeOrigem Nome da origem deve ser o mesmo cadastrado no Sistema DepsNet.
A origem é o nome do sistema de gestão de onde o WebService é invocado
String 40 Sim
RazaoSocial Se o tipo do representante for "J" então recebe a razão social.
Se o tipo da pessoa for "F" ou "E" deverá ser enviado em branco.
String 200 Somente para representante do tipo jurídica
RG Registro geral. String 20 Somente para representante do tipo física
CodigoSistemaGestao Código interno do sistema de gestão String 50 Não
InscricaoEstadual Inscrição estadual da empresa String 30 Somente quando o representante for pessoa jurídica
DataNascimento - Se o tipo do representante for "J" então utilizar a data de fundação da empresa representante.
- Se o tipo do representante for "F" então utilizar a data de nascimento da pessoa física.
DateTime Não
Pais País do cliente, utilizado somente para pessoas do tipo "E", exportação. String 50 Não
Complemento Complemento utilizado somente para pessoas do tipo "E", exportação. String 50 Não
  • Para retorno dos dados: DataContractRetornoProcessamento

# Cadastro de cliente

Nesse serviço além da funcionalidade de cadastro de cliente, existem outros métodos referentes a associações e desassociações do cliente com outras informações onde serão descritos logo abaixo.

Esse serviço é relacionado aos seguintes métodos:

  • Associar e desassociar bloqueio
  • Associar e desassociar informação cadastral
  • Associar grupo econômico
  • Associar representante

Observação

Antes de realizar as associações de informação cadastral, bloqueio, representante e grupo econômico com cliente os mesmos devem estar cadastrados no DepsNet.

Campos de Nome e Razão Social não aceitam a sequência de caracteres '&#', quando enviados o sistema adicionará um espaço entre os caracteres, para evitar problemas na visualização do cliente.

A interface do WebService pode ser consultada em: http://localhost:71/CadastroCliente.svc (opens new window)

# Cadastrar cliente

Método relacionado a este serviço: DcCliente

Campo Descrição Tipo Tam. Obr.
Tipo Tipo do cliente:
J - Jurídica
F - Física
E - Exportação
String 1 Sim
Documento - CNPJ quando for pessoa jurídica
- CPF quando for pessoa física
- Código identificador para pessoa do tipo Exportação
String 15 Sim
Nome - Se o tipo do cliente é "J" deve ser informado o nome fantasia
- Se o tipo do cliente é "F" então é o nome da pessoa
- Se o tipo do cliente é "E" deve ser informado um nome identificador do cliente exportação
String 200 Sim
RazaoSocial Se o tipo da cliente for "J" então recebe a razão social da empresa.
Se o tipo da pessoa for "F" ou "E" deverá ser enviado em branco.
String 200 Somente para clientes onde o tipo de pessoa é "Jurídica".
RG Registro geral String 20 Somente se o cliente for pessoa física.
CodigoSistemaGestao Código interno do sistema de gestão, mesmo código de onde o WebService é invocado. String 50 Sim
InscricaoEstadual Inscrição estadual da empresa. String 30 Somente quando é cliente PJ
DataNascimento - Se o tipo do cliente é "J" então utilizar a data de fundação da empresa
- Se o tipo do cliente é "F" então utilizar a data de nascimento da pessoa física
Obs.: Para clientes já cadastrados no Deps, essa informação só será atualizada se a parametrização “Atualizar data fundação/nascimento via integração” estiver como “Sim” e o cliente não possuir consulta.
DateTime Formato:dd/mm/aaaa Não
NomeOrigem Nome da origem deve ser o mesmo cadastrado no Sistema DepsNet.
A origem é o nome do sistema de gestão de onde o WebService é invocado.
String 40 Sim
Cedente Todo cliente quando cadastrado já é considerado um sacado,
para que o mesmo também seja considerado um cedente, está opção deverá ser inserida como
verdadeira (1), caso contrário, falsa (0).
int 1 Sim
Pais País do cliente, utilizado somente para pessoas do tipo "E", exportação. String 50 Não
Complemento Complemento utilizado somente para pessoas do tipo "E", exportação. String 50 Não
DataClienteDesde Data que identifica desde quando o cliente faz parte do cadastro da organização. DateTime Formato:dd/mm/aaaa Não
ContribuinteIcms Se cliente é contribuinte ICMS ou não.
0 = Não
1 = Sim
int Não
TipoFaturamento IdentificadorDescrição do tipo faturamento do cliente String 50 Não
CodigoColigado Código do coligado no sistema de gestão. String 100 Não
NomeColigado Nome do coligado no sistema de gestão. String 300 Não

# Associar bloqueio cliente

Método relacionado a este serviço: DcClienteBloqueio

Campo Descrição Tipo Tam. Obr.
TipoCliente Tipo do cliente:
J - Jurídica
F - Física
E - Exportação
String 1 Sim
DocumentoCliente - Se o tipo do cliente for "J" então documento é CNPJ
- Se o tipo do cliente for "F" então documento é CPF
- Se o tipo da cliente for "E" então documento é o que representa o cliente do tipo exportação
String 15 Sim
NomeOrigemCliente Nome da origem deve ser o mesmo cadastrado no Sistema DepsNet.
A origem é o nome do sistema de gestão de onde o WebService é invocado.
String 40 Sim
CodigoBloqueio Código do bloqueio String 10 Sim

# Desassociar bloqueio cliente

Método relacionado a este serviço: DcClienteBloqueio

Campo Descrição Tipo Tam. Obr.
TipoCliente Tipo do cliente:
J - Jurídica
F - Física
E - Exportação
String 1 Sim
DocumentoCliente - Se o tipo do cliente for "J" então documento é CNPJ
- Se o tipo do cliente for "F" então documento é CPF
- Se o tipo da cliente for "E" então documento é o que representa o cliente do tipo exportação.
String 15 Sim
NomeOrigemCliente Nome da origem deve ser o mesmo cadastrado no Sistema DepsNet.
A origem é o nome do sistema de gestão de onde o WebService é invocado.
String 40 Sim
CodigoBloqueio Código do bloqueio. String 10 Não*

Atenção

O campo de "CodigoBloqueio" não é obrigatório, caso informado o sistema realizará a desassociação somente deste bloqueio, caso não informado, sistema desassociará todos os bloqueios do cliente.

# Associar cliente informação cadastral

Método relacionado a este serviço: DcClienteInformacaoCadastral

Campo Descrição Tipo Tam. Obr.
TipoCliente Tipo do cliente:
J - Jurídica
F - Física
E - Exportação
String 1 Sim
DocumentoCliente - Se o tipo do cliente for "J" então documento é CNPJ
- Se o tipo do cliente for "F" então documento é CPF
- Se o tipo da cliente for "E" então documento é o que representa o cliente do tipo exportação
String 15 Sim
NomeOrigemCliente Nome da origem deve ser o mesmo cadastrado no Sistema DepsNet.
A origem é o nome do sistema de gestão de onde o WebService é invocado.
String 40 Sim
CodigoSistemaGestaoInformacaoCadastral Código do sistema de gestão da informação cadastral String 50 Sim
CodigoSistemaGestaoSubgrupoInformacaoCadastral Código do sistema de gestão do subgrupo da informação cadastral em caso de cadastro de uma nova String 50 Não
Descricao Descrição da informação cadastral em caso de cadastro de uma nova String 200 Não

Observação

O sistema mantém apenas uma informação cadastral por subgrupo de informação cadastral, de acordo com a parametrização de sistema "Desassociar ao associar informação cadastral".

Caso seja desejado cadastrar uma informação cadastral nova, preencher os campos “CodigoSistemaGestaoSubgrupoInformacaoCadastral” e “Descricao”, caso o “CodigoSistemaGestaoInformacaoCadastral” já exista, esses campos serão ignorados.

# Desassociar cliente informação cadastral

Método relacionado a este serviço: DcDesassociarInformacaoCadastralCliente

Campo Descrição Tipo Tam. Obr.
TipoCliente Tipo do cliente:
J - Jurídica
F - Física
E - Exportação
String 1 Sim
DocumentoCliente - Se o tipo do cliente for "J" então documento é CNPJ
- Se o tipo do cliente for "F" então documento é CPF
- Se o tipo da cliente for "E" então documento é o que representa o cliente do tipo exportação
String 15 Sim
NomeOrigemCliente Nome da origem deve ser o mesmo cadastrado no Sistema DepsNet.
A origem é o nome do sistema de gestão de onde o WebService é invocado
String 40 Sim
CodigoSistemaGestaoInformacaoCadastral Código de sistema de gestão.
Caso seja informado, remove apenas a informação cadastral informada.
String 50 Não*
NomeGrupoInformacaoCadastral Nome do Grupo Informação Cadastral.
Caso seja informado, irá remover apenas as informações cadastrais do grupo informado.
String 40 Não*

Atenção

Os campos de "CodigoSistemaGestaoInformacaoCadastral" e "NomeGrupoInformacaoCadastral" não são obrigatórios, caso informado o sistema realizará a desassociação somente da informação cadastral informada pelo código de sistema de gestão, ou conforme grupo de informação cadastral. Caso não informado os campos, o sistema desassociará todas as informações cadastrais do cliente conforme a origem do cliente.

# Associar cliente grupo econômico

Método relacionado a este serviço: DcClienteGrupoEconomico

Nesse serviço é possível realizar a associação do cliente a um grupo econômico e também a sua desassociação do grupo. Segue abaixo descrição das regras de funcionalidade desse serviço:

  • Associação de Cliente ao Grupo: Para realizar a associação de cliente ao grupo é necessário que sejam enviadas as informações do cliente (TipoCliente, DocumentoCliente, NomeOrigemCliente) e também as informações de grupo (NomeGrupoEconomico ou CGSGrupoEconomico).

  • Desassociação de Cliente do Grupo: Para desassociar o cliente do grupo, somente é necessário enviar as informações do cliente (TipoCliente, DocumentoCliente, NomeOrigemCliente) e deixar a informações de grupo em branco ou nulo.

  • Desassociação de TODOS os Clientes do Grupo: Para desassociação de todos os clientes, deve-se manter as informações do cliente em branco ou nulo e informar somente as informações do grupo (NomeGrupoEconomico ou CGSGrupoEconomico e NomeOrigemCliente).

Campo Descrição Tipo Tam. Obr.
TipoCliente Tipo do cliente:
J - Jurídica
F - Física
String 1 Conforme regra que será utilizada
DocumentoCliente - Se o tipo do cliente for "J" então documento é CNPJ
- Se o tipo do cliente for "F" então documento é CPF
String 14 Conforme regra que será utilizada
NomeOrigemCliente Nome da origem deve ser o mesmo cadastrado no Sistema DepsNet.
A origem é o nome do sistema de gestão de onde o WebService é invocado.
String 40 Conforme regra que será utilizada
NomeGrupoEconomico Nome do Grupo Econômico String 100 Conforme regra que será utilizada
CGSGrupoEconomico Código sistema de gestão do grupo econômico String 50 Conforme regra que será utilizada

# Associar cliente representante

Método relacionado a este serviço: DcClienteRepresentante

Campo Descrição Tipo Tam. Obr.
TipoCliente Tipo do cliente:
J - Jurídica
F - Física
E - Exportação
String 1 Sim
DocumentoCliente - Se o tipo do cliente for "J" então documento é CNPJ
- Se o tipo do cliente for "F" então documento é CPF
- Se o tipo da cliente for "E" então documento é o que representa o cliente do tipo exportação
String 15 Sim
NomeOrigemCliente Nome da origem deve ser o mesmo cadastrado no Sistema DepsNet.
A origem é o nome do sistema de gestão de onde o WebService é invocado.
String 40 Sim
TipoRepresentante Tipo do cliente:
J - Jurídica
F - Física
E - Exportação
String 1 Sim
DocumentoRepresentante - Se o tipo do representante for "J" então documento é CNPJ
- Se o tipo do representante for "F" então documento é CPF
- Se o tipo do representante for "E" então documento é o que representa o cliente do tipo exportação
String 15 Sim

Para retorno dos dados: DataContractRetornoProcessamento

# Associar resposta questionário

Método relacionado a este serviço: DcRespostaQuestionario

Campo Descrição Tipo Tam. Obr.
TipoCliente Tipo do cliente:
J - Jurídica
F - Física
E - Exportação
String 1 Sim
DocumentoCliente - Se o tipo do cliente for "J" então documento é CNPJ
- Se o tipo do cliente for "F" então documento é CPF
- Se o tipo da cliente for "E" então documento é o que representa o cliente do tipo exportação
String 15 Sim
NomeOrigemCliente Nome da origem deve ser o mesmo cadastrado no Sistema DepsNet.
A origem é o nome do sistema de gestão de onde o WebService é invocado.
String 40 Sim
Pergunta Descrição da pergunta String 300 Sim
Resposta Descrição da resposta String 100 Sim
DataValidade Data de validade da resposta
Obs.: Quando não enviado não será adicionado data de validade a resposta, e quando enviada se a data for maior que a data limite calculada baseada nos meses configurados na pergunta, será considerada e salva a data limite.
DateTime Não

Para retorno dos dados: DataContractRetornoProcessamento

# Cadastrar contato

O cadastro de contatos é utilizado para associar um contato a um cliente. A interface do WebService pode ser consultada em: http://localhost:71/CadastroContatoNovo.svc (opens new window)

Método relacionado a este serviço: CadastrarContato DcCadastroContato

Campo Descrição Tipo Tam. Obr.
DocumentoCliente - Se o tipo do cliente for "J" então documento é CNPJ
- Se o tipo do cliente for "F" então documento é CPF
- Se o tipo do cliente for "E" então documento é o que representa o cliente do tipo exportação
String 15 Sim
TipoCliente Tipo do cliente:
J - Jurídica
F - Física
E - Exportação
String 1 Sim
NomeOrigemCliente Nome da origem deve ser o mesmo cadastrado no Sistema DepsNet.
A origem é o nome do sistema de gestão de onde o WebService é invocado.
String 40 Sim
NomeContato Nome da pessoa do contato String 200 Sim
Cargo Cargo do contato String 100 Não
Telefone Telefone do contato String 25 Não
Celular Celular do contato String 25 Não
Email E-mail do contato String 200 Não
Observacao Observação a respeito do contato String 250 Não
TipoRelacionamento Tipo de relacionamento.
R - Representante
C - Cliente
String 1 Sim
Preferencial Contato preferencial
0 - Não preferencial
1 - Preferencial
Int 1 Sim
Excluir Deve excluir o contato ou não String 1 S - Excluir
N - Não excluir
Caso não informado ou qualquer informação diferente de S, é considerado cadastro
Ativo Contato ativo ou inativo Int 1 1 - Ativo
0 - Inativo
Caso não informado, contato é considerado ativo

Observação

Um dos campos (telefone, celular, e-mail ou observacao) deve ser obrigatório.

A chave de identificação de associação de contato é composta pelas informações do contato "NomeContato" e pelas informações do cliente ("DocumentoCliente", "TipoCliente" e "NomeOrigemCliente").

Para retorno dos dados: DataContractRetornoProcessamento

# Cadastrar contato obsoleto

O cadastro de contatos é utilizado para associar um contato a um cliente.

A interface do WebService pode ser consultada em: http://localhost:71/CadastroContato.svc (opens new window)

Método relacionado a este serviço: CadastrarContato DcContato

Campo Descrição Tipo Tam. Obr.
TipoCliente Tipo do cliente:
J - Jurídica
F - Física
E - Exportação
String 1 Sim
DocumentoCliente - Se o tipo do cliente for "J" então documento é CNPJ
- Se o tipo do cliente for "F" então documento é CPF
- Se o tipo do cliente for "E" então documento é o que representa o cliente do tipo exportação
String 15 Sim
NomeOrigemCliente Nome da origem deve ser o mesmo cadastrado no Sistema DepsNet.
A origem é o nome do sistema de gestão de onde o WebService é invocado.
String 40 Sim
NomeContato Nome da pessoa do contato String 200 Sim
NomeTipoContato Nome do Tipo de contato.
Exemplo: E-mail, telefone, Skype.
String 20 Sim
Endereco Endereço de e-mail, número de telefone, usuário de Skype, ou outro contato. String 50 Sim
TipoRelacionamento Tipo de relacionamento.
R - Representante.
C - Cliente.
String 1 Não

Para retorno dos dados: DataContractRetornoProcessamento

# Cadastrar endereço

O cadastro de endereço é utilizado para associar um endereço a um respectivo cliente. A cidade enviada no serviço não precisa estar previamente cadastrada, enviando o estado (UF) e o nome da cidade, a mesma já é cadastrada automaticamente pelo serviço.

A interface do WebService pode ser consultada em: http://localhost:71/CadastroEndereco.svc (opens new window)

Método relacionado a este serviço: CadastrarEndereco DcEndereco

Campo Descrição Tipo Tam. Obr.
TipoCliente Tipo do cliente:
J - Jurídica
F - Física
E - Exportação
String 1 Sim
DocumentoCliente - Se o tipo do cliente for "J" então documento é CNPJ
- Se o tipo do cliente for "F" então documento é CPF
- Se o tipo do cliente for "E" então documento é o que representa o cliente do tipo exportação
String 15 Sim
NomeOrigemCliente Nome da origem deve ser o mesmo cadastrado no Sistema DepsNet.
A origem é o nome do sistema de gestão de onde o WebService é invocado.
String 40 Sim
UF Unidade Federativa
- Se o tipo de cliente é "E" deve ser informado a sigla "EX".
String 2 Sim
Cidade Nome da Cidade String 50 Sim
Rua Nome da rua. String 200 Não
Bairro Nome do bairro. String 100 Não
Cep CEP da localidade. String 10 Não
Numero Número. String 15 Não
Complemento Complemento. String 80 Não
TipoEndereco Tipo do endereço pode ser
1 - Faturamento
2 - Cobrança
3 - Comercial
4 - Residencial
5 - Entrega
Obs.: É dado preferência ao endereço de tipo cobrança.
String 1 Não
Confirmado Confirmação de endereço de entrega.
0 – Não confirmado.
1 - Confirmado
Obs.: Caso não seja informado ao adicionar um endereço, será considerado não confirmado. Caso o endereço já estiver cadastrado pro cliente e confirmado, o confirmado enviado na integração será desconsiderado. Caso não seja informado ou seja enviado como não confirmado e o endereço seja do Tipo Entrega, será verificado se o codigoPessoa já possui um endereço com as mesmas informações, caso possua e este endereço esteja confirmado no sistema, será atribuido confirmado.
String 1 Não*
Apelido Nome ou descrição associada a endereço de entrega.
Obs.: Obrigatório caso seja enviado um endereço.
String 200 Não*

Para retorno dos dados: DataContractRetornoProcessamento

# Cadastro informação complementar

Esse serviço tem o objetivo de cadastrar as informações complementares.

A interface do WebService pode ser consultada em: http://localhost:71/CadastroInformacaoComplementar.svc (opens new window)

Método relacionado a este serviço: CadastrarInformacaoComplementar DcInformacaoComplementar

Campo Descrição Tipo Tam. Obr.
TipoCliente Tipo do cliente:
J - Jurídica
F - Física
E - Exportação
String 1 Sim
DocumentoCliente - Se o tipo do cliente for "J" então documento é CNPJ
- Se o tipo do cliente for "F" então documento é CPF
- Se o tipo da cliente for "E" então documento é o que representa o cliente do tipo exportação
String 15 Sim
NomeOrigemCliente Nome da origem deve ser o mesmo cadastrado no Sistema DepsNet.
A origem é o nome do sistema de gestão de onde o WebService é invocado.
String 40 Sim
Complemento Complemento a ser associado ao cliente. String Sim
NomeUsuario Informar o login do usuário no DepsNetEsse campo não é obrigatório,
caso não informado ou não encontrado, será colocado login como "administrador".
String 40 Não

# Cadastro de informação externa

Esse serviço tem o objetivo de cadastrar as informações externas.

A interface do WebService pode ser consultada em: http://localhost:71/CadastroInformacaoExterna.svc (opens new window)

Método relacionado a este serviço: CadastrarInformacaoExterna DcInformacaoExterna

Campo Descrição Tipo Tam. Obr.
TipoCliente Tipo do cliente:
J - Jurídica
F - Física
E - Exportação
String 1 Sim
DocumentoCliente - Se o tipo do cliente for "J" então documento é CNPJ
- Se o tipo do cliente for "F" então documento é CPF
- Se o tipo da cliente for "E" então documento é o que representa o cliente do tipo exportação
String 15 Sim
NomeOrigemCliente Nome da origem deve ser o mesmo cadastrado no Sistema DepsNet.
A origem é o nome do sistema de gestão de onde o WebService é invocado.
String 40 Sim
Nome Nome que será apresentado no hiperlink String 60 Sim
Descricao Descrição da informação externa que será apresentada através do hiperlink String 150 Sim
UrlHiperLink Url de acesso a informação externa 150 Sim