# 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.
| Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
|---|---|---|---|---|---|
| Codigo | Código do bloqueio | String | 10 | Sim | |
| NomeOrigem | Nome da origem do bloqueio | String | 40 | Sim | |
| Descricao | Descrição do bloqueio | String | 60 | Sim | |
| TipoValidacao | Tipo da Validação em que o bloqueio será verificado | Int | 1 | 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 | Não |
| IdentificadorInterno | Identificador interno | String | Identificador enviado pelo cliente para ser utilizado no retorno de integrações | Não |
Atenção
Os campos "Codigo" e "NomeOrigem" compõem a chave de identificação da integração de bloqueio.
Exemplo layout ODBC
select
'Codigo do Bloqueio' as Codigo,
'Sistema da origem ' as NomeOrigem,
'Bloqueio Exemplo' as Descricao,
'1' as TipoValidacao,
'Identificador Exemplo' as IdentificadorInterno
# Cadastrar Grupo Econômico
O cadastro de grupos econômicos é utilizado para associar vários clientes a um grupo.
| Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
|---|---|---|---|---|---|
| CodigoSistemaGestao | Código do sistema de gestâo do grupo econômico | String | 50 | Sim | |
| Nome | Nome do grupo econômico | String | 100 | Sim | |
| NomeOrigem | Nome da origem do grupo econômico | String | 40 | Sim | |
| IdentificadorInterno | Identificador Interno | String | Identificador enviado pelo cliente para ser utilizado no retorno de integrações | Sim |
Exemplo layout ODBC
select
'Codigo de Gestao' as CodigoSistemaGestao,
'Nome do Grupo Econômico' as Nome,
'Nome da Origem' as NomeOrigem,
'Identificador Exemplo' as IdentificadorInterno
# Cadastro representante
Esse serviço tem como objetivo o cadastro dos representantes no Sistema DepsNet, onde posteriormente pode ser associado a títulos, notas, notas complementares e cheques.
| Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
|---|---|---|---|---|---|
| Documento | Documento do representante. | String | 15 | - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação | Sim |
| Tipo | Tipo pessoa do representante | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
| NomeOrigem | Nome da origem do representante | String | 40 | Origem cadastrada no Sistema DepsNet | Sim |
| Nome | Nome do Representante | String | 200 | - 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 | Sim |
| RazaoSocial | Razão Social | String | 200 | Para pessoa jurídica deve ser informado a Razão Social da empresa. Para pessoa física e tipo exportação não deve ser enviado esse campo ou enviar sem informação | Sim* Somente para pessoa jurídica! |
| RG | RG | String | 20 | Somente deve ser informado para pessoa do tipo "F". Caso o tipo de pessoa for "J" ou "E" não deve ser enviado o campo ou enviar sem informação | Não |
| CodigoSistemaGestao | Código do sistema de gestão | String | 50 | Não | |
| InscricaoEstadual | Inscrição estadual | String | 30 | Somente deve ser informado para pessoa do tipo "J". Caso o tipo de pessoa for "F" ou "E" não deve ser enviado o campo ou enviar sem informação. | Não |
| DataNascimento | Data de nascimento ou Data de fundação | DateTime | - 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. - Se o tipo do cliente é "E" não deve ser enviado o campo ou enviar sem informação. Formato: dd/mm/aaaa | Não | |
| Pais | País | String | 50 | País do representante, somente utilizado para pessoa do tipo exportação. Caso o tipo de pessoa for "J" ou "F" não deve ser enviado o campo ou enviar sem informação. | Não |
| Complemento | Complemento | String | 50 | Complemento do representante, somente utilizado para pessoa do tipo exportação. Caso o tipo de pessoa for "J" ou "F" não deve ser enviado o campo ou enviar sem informação | Não |
| IdentificadorInterno | Identificador interno | String | Identificador enviado pelo cliente para ser utilizado no retorno de integrações. | Não |
Atenção
Os campos "Documento", "Tipo" e "NomeOrigem" compõem a chave de identificação da integração de representante.
Exemplo layout ODBC
select
'123456789012345' as Documento,
'F' as Tipo,
'Sistema de Origem' as NomeOrigem,
'Representante Exemplo' as Nome,
'Razão Social' as RazaoSocial,
'123456012345' as RG,
'Codigo Sistema de Gestao' as CodigoSistemaGestao,
'' as InscricaoEstadual,
'01/01/1991' as DataNascimento,
'' as Pais,
'' as Complemento,
'Identificador Exemplo' as IdentificadorInterno
# Cadastro de Clientes
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, o mesmo deve estar cadastrado 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.
# Cadastrar Cliente
Abaixo será apresentada toda a documentação necessária para utilização do serviço de cadastrar cliente.
| Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
|---|---|---|---|---|---|
| Documento | Documento do cliente | String | 15 | - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação | Sim |
| Tipo | Tipo pessoa do cliente | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
| NomeOrigem | Nome da origem de informação cadastral | String | 40 | Origem cadastrada no Sistema DepsNet | Sim |
| Nome | Nome do cliente | String | 200 | - 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 de cliente é "E" deve ser informado um nome identificador do cliente exportação | Sim |
| RazaoSocial | Razão Social | String | 200 | Para pessoa jurídica deve ser informado a Razão Social da empresa. Para pessoa física e tipo exportação não deve ser enviado esse campo ou enviar sem informação | Sim* Somente para pessoa jurídica |
| RG | RG | String | 20 | Somente deve ser informado para pessoa do tipo "F". Caso o tipo de pessoa for "J" ou "E" não deve ser enviado o campo ou enviar sem informação | Não |
| CodigoSistemaGestao | Código do sistema de gestão | String | 50 | Não | |
| InscricaoEstadual | Inscrição estadual | String | 30 | Somente deve ser informado para pessoa do tipo "J". Caso o tipo de pessoa for "F" ou "E" não deve ser enviado o campo ou enviar sem informação | Não |
| DataNascimento | Data de nascimento | DateTime | - 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. - Se o tipo do cliente é "E" não deve ser enviado o campo ou enviar sem informação. Formato: dd/mm/aaaa 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. | Não | |
| Cedente | Cedente | String | 1 | 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 "S" se sim ou "N" se não for ou então se não for enviada no comando, será cadastrado automaticamente como não | Não |
| Pais | País | String | 50 | País do cliente, somente utilizado para pessoa do tipo exportação. Caso o tipo de pessoa for "J" ou "F" não deve ser enviado o campo ou enviar sem informação | Não |
| Complemento | Complemento | String | 50 | Complemento do cliente, somente utilizado para pessoa do tipo exportação. Caso o tipo de pessoa for "J" ou "F" não deve ser enviado o campo ou enviar sem informação | Não |
| DataClienteDesde | Data de cadastro do cliente na organização | DateTime | Data que identifica desde quando o cliente faz parte do cadastro da organização. Formato da data: dd/mm/aaaa | Não | |
| ContribuinteIcms | Contribuinte icms | String | Se cliente é contribuinte ICMS ou não. N = Não S = Sim | Não | |
| TipoFaturamento | Tipo de faturamento | String | 50 | IdentificadorDescrição do tipo faturamento do cliente | Não |
| CodigoColigado | Código do coligado no sistema de gestão | String | 100 | Somente deve ser informado para pessoa do tipo "J" | Não |
| NomeColigado | Nome do coligado no sistema de gestão | String | 300 | Somente deve ser informado para pessoa do tipo "J" | Não |
| IdentificadorInterno | Identificador interno | String | Identificador enviado pelo cliente para ser utilizado no retorno de integrações | Não |
Atenção
Os campos "Documento", "Tipo" e "NomeOrigem" compõem a chave de identificação da integração de cliente.
Exemplo layout ODBC
select
'123456789012345' as Documento,
'J' as Tipo,
'Nome da Origem' as NomeOrigem,
'Nome da Empresa.Ltda' as Nome,
'Razão Social' as RazaoSocial,
'' as RG,
'ODBCCOD00' as CodigoSistemaGestao,
'123456789012345' as InscricaoEstadual,
'01/01/2007' as DataNascimento,
'S' as Cedente,
'' as Pais,
'' as Complemento,
'01/01/2004' as DataClienteDesde,
'S' as ContribuinteIcms,
'Descrição faturamento' as TipoFaturamento,
'Codigo do coligado' as CodigoColigado,
'Nome do coligado' as NomeColigado,
'Identificador Exemplo' as IdentificadorInterno
# Associar Bloqueio Cliente
| Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
|---|---|---|---|---|---|
| Documento | Documento do cliente | String | 15 | - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação | Sim |
| Tipo | Tipo pessoa do cliente | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
| NomeOrigem | Nome da origem do cliente | String | 40 | Origem cadastrada no Sistema DepsNet | Sim |
| CodigoBloqueio | Código do bloqueio | String | 10 | Sim | |
| NomeOrigemBloqueio | Nome da origem do bloqueio | String | 40 | Sim | |
| IdentificadorInterno | Identificador interno | String | Identificador enviado pelo cliente para ser utilizado no retorno de integrações | Não |
Atenção
A chave de identificação de associação de bloqueio com cliente é composta pelas informações de bloqueio ("CodigoBloqueio" e "NomeOrigemBloqueio") e pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
Exemplo layout ODBC
select
'123456789012345' as Documento,
'J' as Tipo,
'Nome da Origem' as NomeOrigem,
'FFF000' as CodigoBloqueio,
'Nome da Origem do Bloqueio' as NomeOrigemBloqueio,
'Identificador Exemplo' as IdentificadorInterno
# Desassociar Bloqueio Cliente
| Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
|---|---|---|---|---|---|
| Documento | Documento do cliente | String | 15 | - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação | Sim |
| Tipo | Tipo pessoa do cliente | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
| NomeOrigem | Nome da origem do cliente | String | 40 | Origem cadastrada no Sistema DepsNet | Sim |
| CodigoBloqueio | Código do bloqueio | String | 10 | Não* | |
| NomeOrigemBloqueio | Nome da origem do bloqueio | String | 40 | Não* | |
| DataDesbloqueio | Data em que foi realizada a inativação do bloqueio (desbloqueio) | DateTime | Formato da data: dd/mm/aaaa | Não* | |
| IdentificadorInterno | Identificador interno | String | Identificador enviado pelo cliente para ser utilizado no retorno de integrações | Não |
Atenção
A chave de identificação de desassociação de bloqueio com cliente é composta pelas informações de bloqueio ("CodigoBloqueio" e "NomeOrigemBloqueio") e pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
Observação
Os campos de "CodigoBloqueio" e "NomeOrigemBloqueio" não são obrigatórios, caso informado, o sistema realizará a desassociação somente deste bloqueio, caso não informado, sistema desassociará todos os bloqueios do cliente.
Observação
Se o campo "DataDesbloqueio" for informado, deve também ser informado o código de bloqueio.
Exemplo layout ODBC
select
'123456789012345' as Documento,
'E' as Tipo,
'Nome da Origem' as NomeOrigem,
'FFF000' as CodigoBloqueio,
'Nome da Origem do Bloqueio' as NomeOrigemBloqueio,
'01/05/2021' as DataDesbloqueio,
'Identificador Exemplo' as IdentificadorInterno
# Associar Informação Cadastral Cliente
| Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
|---|---|---|---|---|---|
| Documento | Documento do cliente | String | 15 | - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação | Sim |
| Tipo | Tipo pessoa do cliente | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
| NomeOrigem | Nome da origem do cliente | String | 40 | Sim | |
| CodigoSistemaGestaoInformacaoCadastral Ou CSGInformacaoCadastral | Código do sistema de gestão da informação cadastral | String | 50 | Sim | |
| NomeOrigemInformacaoCadastral | Nome da origem de informação cadastral | String | 40 | Sim | |
| IdentificadorInterno | Identificador interno | String | Identificador enviado pelo cliente para ser utilizado no retorno de integrações | Não | |
| CodigoSistemaGestaoSubgrupoInformacaoCadastral Ou CSGSubgrupoInformacaoCadastral | Código do sistema de gestão do subgrupo da informação cadastral em caso de cadastro de uma nova | String | 50 | Não | |
| DescricaoInformacaoCadastral | Descrição da informação cadastral em caso de cadastro de uma nova | String | 200 | Não |
Atenção
A chave de identificação de associação informação cadastral cliente é composta pelas informações da informação cadastral ("CSGInformacaoCadastral" e "NomeOrigemInformacaoCadastral") e pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
O sistema mantem 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 “DescricaoInformacaoCadastral”, caso o “CodigoSistemaGestaoCadastral” já exista, esses campos serão ignorados
Exemplo layout ODBC
select
'123456789012345' as Documento,
'E' as Tipo,
'Nome da Origem' as NomeOrigem,
'CDG000444' as CSGInformacaoCadastral,
'00001' as CSGSubgrupoInformacaoCadastral,
'Informação Cadastral' as DescricaoInformacaoCadastral,
'Nome da Origem' as NomeOrigemInformacaoCadastral,
'Identificador Exemplo' as IdentificadorInterno
# Desassociar Informação Cadastral Cliente
| Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
|---|---|---|---|---|---|
| Documento | Documento do cliente | String | 14 | - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação | Sim |
| Tipo | Tipo pessoa do cliente | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
| NomeOrigem | Nome da origem do cliente | String | 40 | Sim | |
| CsgInformacaoCadastral | Código de sistema de gestão da informação cadastral | String | 50 | Código de sistema de gestão. Caso seja informado, remove apenas a informação cadastral informada | Não |
| NomeGrupoInformacaoCadastral | Nome do grupo de informação cadastral | String | 40 | Nome do Grupo Informação Cadastral. Caso seja informado, irá remover apenas as informações cadastrais do grupo informado | Não |
| IdentificadorInterno | Identificador interno | String | Identificador enviado pelo cliente para ser utilizado no retorno de integrações | Não |
Atenção
A chave de identificação de desassociação informação cadastral cliente é composta pelas informações da informação cadastral ("CSGInformacaoCadastral" e "NomeOrigemInformacaoCadastral") e pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
Exemplo layout ODBC
select
'123456789012345' as Documento,
'E' as Tipo,
'Nome da Origem' as NomeOrigem,
'CDG000444' as CSGInformacaoCadastral,
'Nome da Origem' as NomeOrigemInformacaoCadastral,
'Identificador Exemplo' as IdentificadorInterno
# Associar Grupo Econômico Cliente
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 (Documento, Tipo, NomeOrigem) e também as informações de grupo (NomeGrupoPessoa ou CodigoSistemaGestao).
Desassociação de Cliente do Grupo: Para desassociar o cliente do grupo, somente é necessário enviar as informações do cliente (Documento, Tipo, NomeOrigem) e deixar as 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 (NomeGrupoPessoa ou CodigoSistemaGestao e NomeOrigem).
| Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
|---|---|---|---|---|---|
| Documento | Documento do cliente | String | 14 | - CNPJ quando for pessoa jurídica - CPF quando for pessoa física | Conforme regra que será utilizada |
| Tipo | Tipo pessoa do cliente | String | 1 | J - Jurídica F - Física | Conforme regra que será utilizada |
| NomeOrigem | Nome da origem do cliente | String | 40 | Conforme regra que será utilizada | |
| NomeGrupoPessoa | Nome do grupo econômico | String | 100 | Conforme regra que será utilizada | |
| CodigoSistemaGestao | Código interno do sistema de gestão | String | 50 | Conforme regra que será utilizada | |
| IdentificadorInterno | Identificador interno | String | Identificador enviado pelo cliente para ser utilizado no retorno de integrações | Não |
Atenção
A chave de identificação de associação grupo econômico cliente é composta pelas informações do grupo econômico ("CodigoSistemaGestao" e "NomeGrupoPessoa") e pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
Exemplo layout ODBC
select
'123456789012345' as Documento,
'J' as Tipo,
'Nome da Origem' as NomeOrigem,
'Grupo Econômico Integração' as NomeGrupoPessoa,
'CDG000444' as CodigoSistemaGestao,
'Identificador Exemplo' as IdentificadorInterno
# Associar Representante Cliente
| Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
|---|---|---|---|---|---|
| Documento | Documento do cliente | String | 15 | - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação | Sim |
| Tipo | Tipo pessoa do cliente | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
| NomeOrigem | Nome da origem do cliente | String | 40 | Sim | |
| DocumentoRepresentante | Documento do representante | String | 14 | - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação | Não |
| TipoRepresentante | Tipo pessoa do representante | String | 1 | J - Jurídica F - Física E - Exportação | Não |
| NomeOrigemRepresentante | Nome da origem do representante | String | 40 | Não | |
| IdentificadorInterno | Identificador interno | String | Identificador enviado pelo cliente para ser utilizado no retorno de integrações | Não |
Atenção
A chave de identificação de associação representante cliente é composta pelas informações do representante ("DocumentoRepresentante", "TipoRepresentante" e "NomeOrigemRepresentante") e pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
Para que todos os representantes sejam desassociados do cliente, deve-se enviar apenas as informações do cliente ("Documento", "Tipo" e "NomeOrigem"), enquanto os campos referentes à representante devem ser enviados em branco ("DocumentoRepresentante", "TipoRepresentante" e "NomeOrigemRepresentante").
Exemplo layout ODBC
select
'123456789012345' as Documento,
'J' as Tipo,
'Nome da Origem' as NomeOrigem,
'12345600000' as DocumentoRepresentante,
'J' as TipoRepresentante,
'Nome da Origem Representante' as NomeOrigemRepresentante,
'Identificador Exemplo' as IdentificadorInterno
# Associar Resposta Questionário
Essa funcionalidade tem como objetivo associar respostas a questionários ja configurados no DepsNet
| Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
|---|---|---|---|---|---|
| Documento | Documento do cliente | String | 15 | - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação | Sim |
| Tipo | Tipo pessoa do cliente | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
| NomeOrigem | Nome da origem do cliente | String | 40 | Sim | |
| TipoRelacionamento | Tipo do relacionamento do cliente | String | 1 | C - Cliente R - Representante | Sim |
| Pergunta | Descrição da pergunta | String | 300 | Sim | |
| Resposta | Descrição da resposta | String | 100 | Sim | |
| DataValidade | Data de validade da resposta | DateTime | Formato: dd/MM/aaaa HH:mm:ss | Não¹ | |
| IdentificadorInterno | Identificador interno | String | Identificador enviado pelo cliente para ser utilizado no retorno de integrações | Não |
Observações
- 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.
Atenção
Caso não exista um questionário ativo configurado com a pergunta e resposta integrada, será considerado como inválido, e não haverá nenhuma atualização
Exemplo layout ODBC
select
'123456789012345' as Documento,
'J' as Tipo,
'Nome da Origem' as NomeOrigem,
'C' as TipoRelacionamento,
'Possui bom histórico?' as Pergunta,
'Sim' as Resposta,
'Identificador Exemplo' as IdentificadorInterno
# Cadastrar Contato
| Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
|---|---|---|---|---|---|
| Documento | Documento do cliente | String | 15 | - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação | Sim |
| Tipo | Tipo pessoa do cliente | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
| NomeOrigem | Nome da origem do cliente | String | 40 | Sim | |
| NomeContato | Nome 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¹ | |
| E-mail do contato | String | 200 | Não¹² | ||
| Observacao | Observação a respeito do contato | String | 250 | Não¹ | |
| TipoRelacionamento | Tipo de relacionamento | String | 1 | R - Representante C - Cliente | Sim |
| Preferencial | Contato preferencial | Int | 1 | 0 - Não preferencial 1 - Preferencial | 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 | Não |
| Ativo | Contato ativo ou inativo | Int | 1 | 1 - Ativo 0 - Inativo Caso não informado, contato é considerado ativo | Não |
| IdentificadorInterno | Identificador interno | String | Identificador enviado pelo cliente para ser utilizado no retorno de integrações | Não |
Observações
Um dos campos (Telefone, celular, email ou observacao) deve ser obrigatório.
No campo Email pode ser enviado mais de um e-mail desde que os mesmos estejam separados por ";".
Atenção
A chave de identificação de associação de contato é composta pelas informações do contato "NomeContato" e pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
Exemplo layout ODBC
select
'123456789012345' as Documento,
'F' as Tipo,
'Nome da Origem' as NomeOrigem,
'Nome do Contato' as NomeContato,
'Cargo' as Cargo,
'04834333434' as Telefone,
'048999009900' as Celular,
'[email protected]' as Email,
'Observação do contato' as Observacao,
'C' as TipoRelacionamento,
'0' as Preferencial,
'1' as Ativo,
'N' as Excluir,
'Identificador Exemplo' as IdentificadorInterno
# Cadastrar Contato Obsoleto
O cadastro de contatos é utilizado para associação com clientes.
| Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
|---|---|---|---|---|---|
| CodigoTipoContato | Código do tipo de contato | String | 20 | Sim | |
| Documento | Documento do cliente | String | 14 | - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação | Sim |
| Tipo | Tipo pessoa do cliente | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
| NomeOrigem | Nome da origem do cliente | String | 40 | Sim | |
| NomeContato | Nome do contato | String | 200 | Sim | |
| TipoContato | Tipo do contato | String | 3 | Enviar fixo "ADM" | Sim |
| NomeTipoContato | Nome do tipo de contato | String | 20 | Nome do Tipo de contato. Exemplo: E-mail, telefone, Skype | Sim |
| Endereco | Endereço | String | 30 | Endereço de e-mail, telefone, apelido etc... | Sim |
| TipoRelacionamento | Tipo de relacionamento | String | 1 | R - Representante C - Cliente | Não |
Atenção
A chave de identificação de associação de contato é composta pelas informações do contato "NomeContato" e pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
Exemplo layout ODBC
select !!novo
'12345678901234567890' as CodigoTipoContato,
'12345678901234' as Documento,
'J' as Tipo,
'Nome da Origem' as NomeOrigem,
'Nome do Contato' as NomeContato,
'ADM' as TipoContato,
'Email' as NomeTipoContato,
'[email protected]' as Endereco,
'C' as TipoRelacionamento
# Cadastrar Endereço
O cadastro de endereço é utilizado para associar um endereço com 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.
| Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
|---|---|---|---|---|---|
| Documento | Documento do cliente | String | 15 | CNPJ, CPF ou Código identificador exportação | Sim |
| Tipo | Tipo pessoa do cliente | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
| NomeOrigem | Nome da origem do cliente | String | 40 | Sim | |
| NomeCidade | Nome da cidade | String | 50 | Sim | |
| UF | Sigla do estado | String | 2 | Se o tipo de cliente é "E" deve ser informado a sigla "EX" | Sim |
| Rua | Rua | String | 200 | Não | |
| Bairro | Bairro | String | 100 | Não | |
| CEP | CEP | 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. | Int | Não | ||
| Confirmado | Confirmação de endereço de entrega. 0 – Não confirmado. 1 - Confirmado | Int | 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. | Não | |
| Apelido | Nome ou descrição associada a endereço de entrega | String | 200 | Campo obrigatório caso o tipo endereço seja Entrega. | Não |
| IdentificadorInterno | Identificador interno | String | Identificador enviado pelo cliente para ser utilizado no retorno de integrações | Não |
Atenção
A chave de identificação de cadastro de endereço é composta pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
Exemplo layout ODBC
select
'123456789012345' as Documento,
'F' as Tipo,
'Sistema de Gestão' as NomeOrigem,
'Cidade' as NomeCidade,
'SC' as UF,
'Rua Geral Alvaro Luiz' as Rua,
'Centro Cidade' as Bairro,
'88800111' as CEP,
'2500' as Numero,
'Sem Complemento' as Complemento,
'3' as TipoEndereco,
'0' as Confirmado,
'Minha casa' as Apelido,
'Identificador Interno' as IdentificadorInterno
# Cadastrar Informação Complementar
| Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
|---|---|---|---|---|---|
| Documento | Documento do cliente | String | 14 | CNPJ, CPF ou Código identificador exportação | Sim |
| Tipo | Tipo pessoa do cliente | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
| NomeOrigem | Nome da origem do cliente | String | 40 | Sim | |
| Complemento | Complemento | String | Sim | ||
| DataInsercao | Data da inserção | DateTime | Data de inserção não é obrigatória, caso não informada, será colocada a data atual Formato da data: dd/mm/aaaa | Não | |
| Login | Login do usuário no DepsNet | String | 50 | Login do usuário não é obrigatório, caso não informado ou não encontrado, será colocado login como "administrador" | Não |
| IdentificadorInterno | Identificador Interno | String | Identificador enviado pelo cliente para ser utilizado no retorno de integrações | Não |
Atenção
A chave de identificação da integração de informação complementar é composta pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
Exemplo layout ODBC
select
'12345678901234' as Documento,
'F' as Tipo,
'Nome da Origem' as NomeOrigem,
'Complemento' as Complemento,
'01/01/2017' as DataInsercao,
'Login' as Login,
'Identificador Interno' as IdentificadorInterno
# Cadastrar Informação Externa
Essa funcionalidade tem como objetivo cadastrar informações externas do cliente que podem ser acessadas através do DEPS .Net
| Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
|---|---|---|---|---|---|
| DocumentoCliente | Documento do cliente | String | 14 | CNPJ, CPF ou Código identificador exportação | Sim |
| TipoCliente | Tipo pessoa do cliente | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
| NomeOrigemCliente | Nome da origem do cliente | 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 | String | 150 | Sim | |
| IdentificadorInterno | Identificador interno | String | Identificador enviado pelo cliente para ser utilizado no retorno de integrações | Não |
Atenção
A chave de identificação da integração de informação externa é composta pelas informações do cliente ("DocumentoCliente", "TipoCliente" e "NomeOrigemCliente") e pelas informações externas ("Nome").
Exemplo layout ODBC
select
'12345678901234' as DocumentoCliente,
'E' as TipoCliente,
'Nome da Origem' as NomeOrigemCliente,
'google' as Nome,
'Descricao Google' as Descricao,
'http://google.com/' as UrlHiperLink
'Identificador Interno' as IdentificadorInterno
# Cadastrar Informação Cadastral
Essa funcionalidade tem como objetivo cadastrar informações cadastrais que podem ser acessadas através do DepsNet
| Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
|---|---|---|---|---|---|
| CodigoSistemaGestao | Código do sistema de gestão | String | 50 | Sim | |
| Nome | Nome da informação cadastral | String | 200 | Sim | |
| NomeOrigem | Nome da origem da informação cadastral | String | 50 | Sim | |
| CodigoSistemaGestaoSubgrupoInformacaoCadastral Ou CSGSubGrupoInfCad | Código do sistema de gestão do subgrupo da informação cadastral | String | 50 | Sim |
Atenção
A chave de identificação da integração de informação cadastral é composta pelas informações ("CodigoSistemaGestao" e "NomeOrigem").
Exemplo layout ODBC
select
'Codigo do Sistema' as DocumentoCliente,
'Nome Info Cadastral' as Nome,
'Nome da Origem Info Cadastral' as NomeOrigem,
'Codigo do Sistema Subgrupo Info Cadastral' as CSGSubGrupoInfCad
# Cadastrar Informação Blacklist
Essa funcionalidade tem como objetivo cadastrar informações na Blacklist que podem ser acessadas através do DEPS .Net
| Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
|---|---|---|---|---|---|
| Nome | Nome de pessoa. | String | 200 | Não | |
| RazaoSocial | Razão Social. | String | 200 | Para pessoa jurídica deve ser informado a Razão Social da empresa. | Não |
| Documento | Documento do cliente. | String | 15 | CNPJ, CPF ou Código identificador exportação. | Não |
| E-mail do contato. | String | 200 | Não | ||
| Telefone | Telefone do contato. | String | 25 | Não | |
| NomeCidade | Nome da cidade do endereço. | String | 40 | Sim* | |
| UF | Unidade federativa do endereço. | String | 2 | Sim* | |
| Rua | Nome da rua. | String | 200 | Sim* | |
| Bairro | Nome do bairro. | String | 100 | Sim* | |
| CEP | Código de endereço postal do logradouro. | String | 10 | Sim* | |
| Complemento | Complemento do logradouro. | String | Não | ||
| Numero | Número do logradouro. | String | 10 | Sim* | |
| TipoRegistroProfissional | Tipo de registro profissional. | String | 30 | Tipos presentes no DepsNet: CRO, CFMV, ANVISA | Sim* |
| UFRegistroProfissional | Unidade federativa do registro profissional. | String | 2 | Sim* | |
| CodigoRegistroProfissional | Código do registro profissional | String | 30 | Sim* | |
| IdentificadorInterno | Identificador interno | String | Identificador enviado pelo cliente para ser utilizado no retorno de integrações | Não |
Observações
Para integração de endereço ou dados profissionais devem ser enviadas todas as informações obrigatórias, o não cumprimento dessa regra não impedirá a integração de outras informações não relacionadas.
As informações de endereço serão concatenadas e salvas como uma única informação na base de dados da blacklist, informação de registro profissional seguirá o mesmo comportamento.
Caso o tipo de registro profissional esteja parametrizado no DepsNet para não receber Uf, caso esta seja enviada, será desconsiderada.
Segue o layout final das informações concatenadas.
- Endereço: "Rua, Número, Complemento, Cep, Bairro, Cidade/Uf"
- Registro profissional: "Uf-Tipo-Código"
Exemplo layout ODBC
SELECT 'Felipe' AS Nome,
'Felipe pneus LTDA' AS RazaoSocial,
'11122233365' AS Documento,
'[email protected]' AS Email,
'988990999' AS Telefone,
'Sao Paulo' AS NomeCidade,
'SP' AS UF,
'Zona sul' AS Bairro,
'88815155' AS CEP,
'Complemento' AS Complemento,
'Jorge Lacerda' AS Rua,
'000' AS Numero,
'CRO' AS TipoRegistroProfissional,
'SP' AS UFRegistroProfissional,
'15000000' AS CodigoRegistroProfissional,
'Identificador Interno' as IdentificadorInterno
# Cadastrar Dados Profissionais
Essa funcionalidade tem como objetivo cadastrar dados profissionais que podem ser acessados através do DepsNet
| Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
|---|---|---|---|---|---|
| Documento | Documento da pessoa | String | 14 | - CNPJ quando for pessoa jurídica; - CPF quando for pessoa física | Sim |
| TipoPessoa | Tipo da pessoa | String | 1 | J - Jurídica F - Física | Sim |
| Uf | Unidade Federativa (Estado) | String | 2 | Sim* | |
| NumeroRegistro | Número do registro | String | 30 | Sim | |
| TipoRegistroProfissional | Tipo de registro profissional | String | 30 | Tipos presentes no DepsNet: CRO, CFMV, ANVISA | Sim |
| Ativo | Se o registro está ativo | String | 1 | S - Sim N - Não | Sim |
| CodigoAreaAtuacao | Código da área de atuação do registro | String | 30 | Sim* |
Observações
• Caso o tipo de registro profissional esteja parametrizado no DepsNet para não receber Uf, caso esta seja enviada, será desconsiderada. • Caso o tipo de registro profissional esteja parametrizado no DepsNet para não receber Área de atuação, caso esta seja enviada, será desconsiderada.
Exemplo layout ODBC
SELECT
'11111111111' AS Documento,
'F' AS TipoPessoa,
'PA' AS Uf,
'145654' AS NumeroRegistro,
'CRO' AS TipoRegistroProfissional,
'S' AS Ativo,
'CD' AS CodigoAreaAtuacao