# Integração de cadastros
# Cadastrar bloqueio
Os bloqueios cadastrais 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.
| Código | Descrição | Tipo | Tam. | Informações |
|---|---|---|---|---|
| @#B0 | Código do bloqueio | String | 10 | |
| @#B1 | Nome da origem | String | 40 | |
| @#B2 | Descrição do bloqueio | String | 60 | |
| @#B3 | Tipo da validação do bloqueio | Int | 1 | Validação em que bloqueio será verificado 1. Por Raiz 2. Por CNPJ 3. Por Grupo Ex.: Caso um bloqueio deva ser somente bloqueio para CNPJ, enviar tipo validação = 2. Se o campo não for informado, adicionará como padrão 1. |
Atenção
Os campos "@#B0" e "@#B1" compõem a chave de identificação da integração de bloqueio.
Exemplo layout TXT
@#B0INT_BLOO15@#B1Nome da Origem@#B2Descrição do Bloqueio@#B31
# Cadastro grupo econômico
O cadastro de grupos econômicos é utilizado para associar vários clientes a um grupo.
| Código | Descrição | Tipo | Tam. | Informações |
|---|---|---|---|---|
| @#G0 | Código do sistema de gestão de grupo pessoa | String | 50 | |
| @#G1 | Nome do grupo pessoa | String | 100 | |
| @#G2 | Nome da origem | String | 40 |
Exemplo layout TXT
@#G0CDGSG_004@#G1Nome do Grupo Pessoa@#G2Nome da Origem
# Cadastro representante
Esse serviço tem como objetivo o cadastro de representante, o mesmo pode ser associado a uma nota fiscal ou título.
| Código | Descrição | Tipo | Tam. | Informações |
|---|---|---|---|---|
| @#R0 | Documento do cliente | String | 15 | - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação |
| @#R1 | Tipo pessoa do cliente | String | 1 | J - Jurídica F - Física E - Exportação |
| @#R2 | Nome da origem | String | 40 | Origem cadastrada no Sistema DepsNet |
| @#R3 | 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 |
| @#R4 | 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 enviar essa TAG sem informação. |
| @#R5 | RG | String | 20 | Somente deve ser informado para pessoa do tipo "F". Caso o tipo de pessoa for "J" ou "E" enviar essa TAG sem informação. |
| @#R6 | Código do sistema de gestão | String | 50 | |
| @#R7 | Inscrição estadual | String | 15 | Somente deve ser informado para pessoa do tipo "J". Caso o tipo de pessoa for "F" ou "E" enviar essa TAG sem informação. |
| @#R8 | 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" enviar essa TAG sem informação Formato: dd/mm/aaaa | |
| @#R9 | 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 esse código ou enviar sem informação. |
| @#RA | 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. |
Atenção
Os campos "@#R0" , "@#R1" e "@#R2" compõem a chave de identificação da integração de representante.
Exemplo layout TXT
@#R022345678901234@#R1E@#R2Nome da Origem@#R3Representante EXPORTAÇÂO@#R4@#R5@#R6CDGsg005@#R7@#R815/04/2005@#R9ARGENTINA@#RASEM COMPLEMENTO
# Cadastro 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 e desassociar grupo econômico.
- Associar representante.
Atençã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
| Código | Descrição | Tipo | Tam. | Informações |
|---|---|---|---|---|
| Iniciar com @#InicioCliente | ||||
| @#C0 | Documento do cliente | String | 15 | - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação |
| @#C1 | Tipo pessoa do cliente | String | 1 | J - Jurídica F - Física E - Exportação |
| @#C2 | Nome da origem | String | 40 | Origem cadastrada no Sistema DepsNet. |
| @#C3 | 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 |
| @#C4 | 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 enviar essa TAG sem informação. |
| @#C5 | RG | String | 20 | Somente deve ser informado para pessoa do tipo "F". Caso o tipo de pessoa for "J" ou "E" enviar essa TAG sem informação. |
| @#C6 | Código do sistema de gestão. | String | 50 | |
| @#C7 | Inscrição estadual | String | 15 | Somente deve ser informado para pessoa do tipo "J". Caso o tipo de pessoa for "F" ou "E" enviar essa TAG sem informação. |
| @#C8 | 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" enviar essa TAG 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. | |
| @#C9 | 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. |
| @#CA | País | String | 50 | País do cliente, é utilizado somente quando o cliente é do tipo "Exportação". Não sendo um campo obrigatório. Ao informar esse marcador será obrigatório informar também o marcador: @#CB. |
| @#CB | Complemento | String | 50 | Complemento do cliente, é utilizado somente quando o cliente é do tipo "Exportação". Não sendo um campo obrigatório. Ao informar esse marcador será obrigatório informar também o marcador: @#CA. |
| @#CC | Data cliente desde | DateTime | Data cliente desde: Data que identifica desde quando o cliente faz parte do cadastro da organização. Não é um campo obrigatório. Formato da data: dd/mm/aaaa. |
Atenção
Os campos "@#C0", "@#C1" e "@#C2" compõem a chave de identificação da integração de cliente.
Exemplo layout TXT
@#InicioCliente@#C0EXP000E277@#C1E@#C2NomedaOrigem@#C3INTEGRAÇÂOEXPORTAÇÂO@#C4@#C5@#C6CODsg007@#C7@#C815/04/1994@#C9S@#CAAlmenha@#CBSem complemento@#CC08/07/2011
@#FimCliente
# Associar bloqueio cliente
Atenção
Para cada associação de bloqueio deve ser adicionada uma nova linha no arquivo de cadastro de cliente com a seguinte TAG: @#AssociarBloqueio.
| Código | Descrição | Tipo | Tam. | Informações |
|---|---|---|---|---|
| @#B0 | Código do bloqueio. | String | 10 | |
| @#B1 | Nome da origem de informação cadastral do bloqueio. | String | 40 |
Exemplo layout TXT
@#InicioCliente@#C0EXP000E277@#C1E@#C2NomedaOrigem@#C3INTEGRAÇÂOEXPORTAÇÂO@#C4@#C5@#C6CODsg007@#C7@#C815/04/1994@#C9S@#CAAlmenha@#CBSemcomplemento@#CC08/07/2011
@#AssociarBloqueio@#B0CCCODGB001@#B1Origem Info Cadastral
@#FimCliente
# Desassociar bloqueio cliente
Atenção
Para cada desassociação de bloqueio deve ser adicionada uma nova linha no arquivo de cadastro de cliente com a seguinte TAG: @#DesassociarBloqueio.
- O campo de "@#B0" e "@#B1" 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.
- Para excluir todos os bloqueios informar os campos "@#B0" e "@#B1" vazios.
| Código | Descrição | Tipo | Tam. | Informações |
|---|---|---|---|---|
| @#B0 | Código do bloqueio. | String | 10 | |
| @#B1 | Nome da origem de informação cadastral do bloqueio. | String | 40 |
Exemplo layout TXT
@#InicioCliente@#C0EXP000E277@#C1E@#C2NomedaOrigem@#C3INTEGRAÇÂOEXPORTAÇÂO@#C4@#C5@#C6CODsg007@#C7@#C815/04/1994@#C9S@#CAAlmenha@#CBSemcomplemento@#CC08/07/2011
@#DesassociarBloqueio@#B0CCCODGB001@#B1Origem Info Cadastral
@#FimCliente
# Associar informação cadastral cliente
Atenção
Para cada associação de informação cadastral deve ser adicionada uma nova linha no arquivo de cadastro de cliente com a seguinte TAG: @#AssociarInformacaoCadastral.
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".
| Código | Descrição | Tipo | Tam. | Informações |
|---|---|---|---|---|
| @#I0 | Código do sistema de gestão da informação cadastral. | String | 50 | |
| @#I1 | Nome da origem da informação cadastral. | String | 40 |
Exemplo layout TXT
@#InicioCliente@#C0EXP000E277@#C1E@#C2NomedaOrigem@#C3INTEGRAÇÂOEXPORTAÇÂO@#C4@#C5@#C6CODsg007@#C7@#C815/04/1994@#C9S@#CAAlmenha@#CBSemcomplemento@#CC08/07/2011
@#AssociarInformacaoCadastral@#I0CODG004545454@#I1Origem Info Cadastral
@#FimCliente
# Associar representante cliente
Atenção
Para cada associação de representante deve ser adicionada uma nova linha no arquivo de cadastro de cliente com a seguinte TAG: @#AssociarRepresentante.
| Código | Descrição | Tipo | Tam. | Informações |
|---|---|---|---|---|
| @#R0 | Documento do representante. | String | 15 | - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação |
| @#R1 | Tipo do representante | String | 1 | J - Jurídica F - Física E - Exportação |
| @#R2 | Nome da origem | String | 40 |
Atenção
Finalizar o bloco do cliente com @#FimCliente
Exemplo layout TXT
@#InicioCliente@#C0EXP000E277@#C1E@#C2NomedaOrigem@#C3INTEGRAÇÂOEXPORTAÇÂO@#C4@#C5@#C6CODsg007@#C7@#C815/04/1994@#C9S@#CAAlmenha@#CBSemcomplemento@#CC08/07/2011
@#AssociarRepresentante@#R054444057000152@#R1J@#R2Origem Nome
@#FimCliente
# Cadastro contato
O cadastro de contatos é utilizado para associação com clientes.
| Código | Descrição | Tipo | Tam. | Informações |
|---|---|---|---|---|
| @#C0 | Documento do cliente | String | 15 | - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação |
| @#C1 | Tipo pessoa do cliente. | String | 1 | J - Jurídica F - Física E - Exportação |
| @#C2 | Nome da origem. | String | 40 | |
| @#C3 | Nome do contato. | String | 200 | |
| @#C4 | Cargo do contato. | String | 100 | |
| @#C5 | Telefone do contato. | String | 25 | Obs¹ |
| @#C6 | Tipo do relacionamento. | String | 1 | C - Cliente R - Representante |
| @#C7 | Celular do contato. | String | 25 | Obs¹ |
| @#C8 | E-mail do contato. | String | 200 | Obs¹ ² |
| @#C9 | Observação do contato. | String | 250 | Obs¹ |
| @#CA | Contato preferencial. | Int | 1 | 0 - Não preferencial 1 - Preferencial |
Atenção
A chave de identificação de integração de contato é composta pelas informações do cliente ("@#C0", "@#C1", "@#C2" e "@#C3").
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 ";".
Exemplo layout TXT
@#C0123456789012345@#C1J@#C2Nome de Origem@#C3Contato Integração TXT@#C4Cargo@#C59934449874@#C6C@#C74848887711@#[email protected]@#C9Observação para contato via integração TXT@#CA1
# Cadastro contato obsoleto
O cadastro de contatos é utilizado para associação com clientes.
| Código | Descrição | Tipo | Tam. | Informações |
|---|---|---|---|---|
| @#C0 | Nome do tipo de contato. | String | 20 | |
| @#C1 | Documento do cliente. | String | 15 | - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação |
| @#C2 | Tipo pessoa do cliente. | String | 1 | J - Jurídica F - Física E - Exportação |
| @#C3 | Nome da origem. | String | 40 | |
| @#C4 | Nome do contato. | String | 200 | |
| @#C5 | Tipo do contato. | String | 3 | Enviar fixo "ADM". |
| @#C6 | Endereço | String | 50 | Endereço de e-mail, telefone, apelido etc. |
| @#C7 | Tipo de relacionamento. | String | 1 | R - Representante C - Cliente. |
Atenção
A chave de identificação de integração de contato é composta pelas informações do cliente ("@#C1", "@#C2" e "@#C3") e pelas informações de contato ("@#C4" e "@#C0").
Exemplo layout TXT
@#C0Nome do Contato@#C11123456789550@#C2F@#C3NOME ORIGEM@#C4NOME do contato@#C5ADM@#[email protected]@#C7C
# Cadastro endereço
O cadastro de endereço é utilizado para associação de 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.
| Código | Descrição | Tipo | Tam. | Informações |
|---|---|---|---|---|
| @#E0 | Documento do cliente. | String | 15 | - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação |
| @#E1 | Tipo pessoa do cliente. | String | 1 | J - Jurídica F - Física E - Exportação |
| @#E2 | Nome da origem. | String | 40 | |
| @#E3 | Nome da cidade. | String | 40 | |
| @#E4 | Nome da UF. | String | 2 | Se o tipo de cliente é "E" deve ser informado a sigla "EX" |
| @#E5 | Rua. | String | 200 | |
| @#E6 | Bairro. | String | 100 | |
| @#E7 | CEP. | String | 10 | |
| @#E8 | Número. | String | 10 | |
| @#E9 | Complemento. | String | 80 |
Atenção
A chave de identificação de integração de endereço é composta pelas informações do cliente ("@#E0", "@#E1" e "@#E2") e pelas informações de contato ("@#E3").
Exemplo layout TXT
@#E0123456789012345@#E1J@#E2Nome da Origem@#E3Sao Carlos@#E4SP@#E5AVENIDA Drumont@#E6Centro@#E744412784@#E8254@#E9Sem complemento
# Cadastro informação complementar
O cadastro de informação complementar do cliente. Pode ser relacionado com um ou mais informações complementares ao cliente.
| Código | Descrição | Tipo | Tam. | Informações |
|---|---|---|---|---|
| @#I0 | Documento do cliente. | String | 15 | - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação |
| @#I1 | Tipo pessoa do cliente | String | 1 | J - Jurídica F - Física E - Exportação |
| @#I2 | Nome da origem. | String | 40 | |
| @#I3 | Complemento. | String | ||
| @#I4 | Data da inserção. | DateTime | Caso não informada será utilizada a data atual. Formato: dd/mm/aaaa | |
| @#I5 | Login do usuário. | String | 40 | Caso não seja informado ou não encontrar o usuário informado será utilizado o login do administrador. |
Atenção
Os campos "@#I0", "@#I1" e "@#I2" compõem a chave de identificação da integração de cliente.
Exemplo layout TXT
@#I0123456789012345@#I1J@#I2NOME da ORIGEM@#I3Complemente@#I418/04/2017@#I5USUARIO
# Desassociar informação cadastral cliente
Essa funcionalidade tem como objetivo desassociar um ou mais informações cadastrais somente informando o cliente desejado.
| Código | Descrição | Tipo | Tam. | Informações |
|---|---|---|---|---|
| @#I0 | Documento. | String | 15 | - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação |
| @#I1 | Nome da origem | String | 40 | |
| @#I2 | Tipo pessoa do cliente. | String | 1 | J - Jurídica F - Física E - Exportação |
| @#I3 | Código do sistema de gestão da informação cadastral. | String | 50 | Não obrigatório. Caso seja informado, remove apenas a informação cadastral informada. |
| @#I4 | Nome do grupo de informação cadastral. | String | 40 | Não obrigatório. Caso seja informado, irá remover apenas as informações cadastrais do grupo informado. |
Atenção
A chave de identificação de desassociação informação cadastral cliente é composta pelas informações da informação cadastral ("@#I3" e "@#I4") e pelas informações do cliente ("@#I0", "@#I1" e "@#I2").
Exemplo layout TXT
@#I0123456789012345@#I1Origem Nome@#I2J@#I3CDG444@#I4Grupo Info Cadastral
# 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 (@#G0, @#G1, @#G2) e também as informações de grupo (@#G3 ou @#G4).
Desassociação de Cliente do Grupo: Para desassociar o cliente do grupo, somente é necessário enviar as informações do cliente (@#G0, @#G1, @#G2) 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 (@#G3 ou @#G4 e @#G2).
| Código | Descrição | Tipo | Tam. | Informações |
|---|---|---|---|---|
| @#G0 | Documento. - CNPJ quando for pessoa jurídica - CPF quando for pessoa física | String | 14 | Conforme regra que será utilizada |
| @#G1 | Tipo do cliente: J - Jurídica F - Física | String | 1 | Conforme regra que será utilizada |
| @#G2 | Nome da origem. | String | 40 | Conforme regra que será utilizada |
| @#G3 | Código do sistema de gestão do grupo econômico. | String | 50 | Conforme regra que será utilizada |
| @#G4 | Nome do grupo econômico | String | 100 | Conforme regra que será utilizada |
Atenção
A chave de identificação de associação de grupo econômico é composta pelas informações do cliente ("@#G0", "@#G1" e "@#G2") e pelas informações do grupo econômico ("@#G3").
Exemplo layout TXT
@#G095865703000199@#G1J@#G2Sistema de Gestão@#G3csgGrp001@#G4Grupo Econômico Integração
# Cadastro informação externa
Essa funcionalidade tem como objetivo cadastrar informações externas do cliente que podem ser acessadas através do DEPS .Net.
| Código | Descrição | Tipo | Tam. | Informações |
|---|---|---|---|---|
| @#I0 | Documento do cliente. | String | 15 | - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação |
| @#I1 | Tipo pessoa do cliente | String | 1 | J - Jurídica F - Física E - Exportação |
| @#I2 | Nome da origem do cliente. | String | 40 | |
| @#I3 | Nome que será apresentado no hiperlink. | String | 60 | |
| @#I4 | Descrição da informação externa que será apresentada através do hiperlink. | String | 150 | |
| @#I5 | Url de acesso a informação externa. | String | 150 |
Atenção
A chave de identificação da integração de informação externa é composta pelas informações do cliente ("@#I0", "@#I1" e "@#I2") e pelas informações externas ("@#I3").
Exemplo layout TXT
@#I0123456789012345@#I1F@#I2Origem Cliente@#I3Google@#I4Site google@#I5http://www.google.com.br