# Integração de Contas a Receber
# Cadastrar Parametrização Categoria
O cadastro de parametrização categoria é utilizado para cadastrar os tipos de parametrização de Contas a Receber. O cadastro pode ser feito também pelo DepsNet.
Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|---|
CodigoCategoria | Código da categoria | Int | 1 | Código interno da categoria no DepsNet - Desconsiderar | Não |
CodSGParamCategoria | Código do sistema de gestão da parametrização categoria | String | 50 | Sim | |
NomeParamCategoria | Nome da parametrização da categoria | String | 100 | Sim | |
ContaInadimplencia | Conta inadimplência | Int | 1 | 0- Não conta inadimplência 1 - Conta Inadimplência | Não |
ContaPagamento | Conta pagamento | Int | 1 | 0 - Não conta pagamento 1 - Conta pagamento | Não |
TipoRelacionamento | Tipo do relacionamento | Int | 1 | 1 - Título 2 - Cheque 3 - Nota complementar | Sim |
NomeCategoria | Nome da categoria | String | 30 | É necessário cadastrar a categoria através do DepsNet para integrar as parametrizações de categorias | 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 parametrização categoria é composta pelas informações ("CodSGParamCategoria", "TipoRelacionamento" e "NomeParamCategoria").
Observação
As informações de "ContaInadimplencia", "ContaPagamento", "TipoRelacionamento" e "NomeCategoria" são somente inseridas ao cadastrar uma parametrização de categoria, ou seja, caso essas informações sejam alteradas quando a parametrização já estiver cadastrada no DepsNet, não é possível realizar a atualização dessas informações. Somente pelo DepsNet.
Exemplo layout ODBC
select
'' as CodigoCategoria,
'Codigo do Sistema de Gestao de Parametrização Categoria' as CodSGParamCategoria,
'Nome da parametrização da categoria' as NomeParamCategoria,
'1' as ContaInadimplencia,
'1' as ContaPagamento,
'1' as TipoRelacionamento,
'Portador' as NomeCategoria,
'Identificador Interno' as IdentificadorInterno
# Cadastrar Nota
O cadastro de nota é utilizado para inserção se notas fiscais. Notas podem ter ou não títulos associados.
Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|---|
Codigo | Código da nota | String | 30 | Sim | |
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 | |
DocumentoRepresentante | Documento do representante | String | 14 | CNPJ, CPF ou Código identificador 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 | |
DataEmissao | Data da emissão da total | DateTime | Formato: dd/mm/aaaa | Sim | |
DocumentoNota | Documento da nota | String | 30 | Sim | |
Serie | Série | String | 10 | Não | |
Situacao | Situação | Int | 1-Faturamento normal 2- Devolução 3-Cancelamento | Sim | |
Valor | Valor da nota | Decimal | 18,2 | Símbolo decimal: "," | Sim |
Status | Status da nota | Int | 1 - Sim 2 - Não | Sim | |
DocumentoCedente | Documento do cliente cedente | String | 14 | CNPJ, CPF ou Código identificador exportação | Não |
TipoCedente | Tipo pessoa do cliente cedente | String | 1 | J - Jurídica F - Física E - Exportação | Não |
NomeOrigemCedente | Nome da origem do cedente | 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 da integração de notas é composta pelas informações da nota ("Codigo") e pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
Observação
Caso não seja necessário o cadastra do cedente da nota, as identificações: DocumentoCedente, TipoCedente e NomeOrigemCedente não devem ser enviadas no comando.
Exemplo layout ODBC
select
'COD1234567890' as Codigo,
'12345678901234' as Documento,
'J' as Tipo,
'Sistema de Gestão' as NomeOrigem,
'1234567891011' as DocumentoRepresentante,
'F' as TipoRepresentante,
'Origem Representante' as NomeOrigemRepresentante,
'02/05/2017' as DataEmissao,
'DOCNOTA0033' as DocumentoNota,
'1A' as Serie,
'1' as Situacao,
'1000,00' as Valor,
'1' as Status,
'13131313131313' as DocumentoCedente,
'F' as TipoCedente,
'Origem Cedente' as NomeOrigemCedente,
'Identificador Interno' as IdentificadorInterno
# Cadastrar Cheque
O cadastro de cheque é utilizado no contas a receber. Pode ser relacionado com um ou mais parametrizações de categorias para cheques.
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 | |
CodigoSistemaGestaoParametrizacaoCategoria ou CsgParamCategoria | Código do sistema de gestão da parametrização categoria | String | 50 | Não | |
NomeParamCategoria | Nome da parametrização da categoria | String | 100 | Não | |
NomeCategoria | Nome da categoria da parametrização da categoria | String | 30 | Não | |
Valor | Valor do cheque | Decimal | 18,2 | Símbolo decimal: "," | Sim |
Banco | Banco | String | 50 | Não | |
Agencia | Agência | String | 20 | Não | |
Situacao | Situação | Int | 1 - Compensado 2 - Devolvido 0 - Não compensado | Sim | |
ContaCorrente | Conta corrente | String | 15 | Não | |
CpfCnpj | CNPJ caso pessoa jurídica ou CPF caso pessoa física | String | 14 | CNPJ ou CPF | Sim |
DataEmissao | Data de emissão do cheque | DateTime | Formato: dd/mm/aaaa | Sim | |
DataVencimento | Data de vencimento do cheque | DateTime | Formato: dd/mm/aaaa | Não | |
Numero | Número que não pode ser repetido pelo cliente, CMC7 ou código primário | String | 40 | Sim | |
NumeroCheque | Número interno onde o cliente pode inserir alguma informação de controle interno dele | String | 40 | Sim | Não |
DocumentoCedente | Documento do cliente cedente | String | 14 | CNPJ, CPF ou Código identificador exportação | Não |
TipoCedente | Tipo pessoa do cliente cedente | String | 1 | J - Jurídica F - Física E - Exportação | Não |
NomeOrigemCedente | Nome da origem do cedente | String | 40 | Não | |
NomeEmitente | Nome do emitente do cheque | String | 200 | 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 cheques é composta pelas informações do cheque ("Numero") e pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
Observação
Caso não seja necessário o cadastra do cedente da nota, as identificações: DocumentoCedente, TipoCedente e NomeOrigemCedente não devem ser enviadas no comando.
Exemplo layout ODBC
select
'09090127925' as Documento,
'F' as Tipo,
'Origem Cliente' as NomeOrigem,
'COD-sistemaGESTAO00' as CodigoSistemaGestaoParametrizacaoCategoria,
'CHEQUE' as NomeParamCategoria,
'Portador' as NomeCategoria,
'200,00' as Valor,
'Bradesco' as Banco,
'3500' as Agencia,
'1' as Situacao,
'888999' as ContaCorrente,
'00011100011' as CpfCnpj,
'24/03/2017' as DataEmissao,
'24/05/2017' as DataVencimento,
'123123' as Numero,
'333666' as NumeroCheque,
'05578580971' as DocumentoCedente,
'F' as TipoCedente,
'Origem Cedente' as NomeOrigemCedente,
'Emitente do cheque' as NomeEmitente, !!
'Identificador Interno' as IdentificadorInterno
# Associar Divisor Limite Cheque
Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|---|
CMC7 | Número que não pode ser repetido pelo cliente, CMC7 ou código primário | String | 40 | Sim | |
CSGDivisorLimite | Código sistema de gestão do divisor de limite | String | 50 | Não | |
ValorDivisorLimite | Valor do divisor de limite | Decimal | 18,2 | Não | |
Desassociar | Flag "S" ou vazio | String | 1 | Ao enviar "S", e um CSGDivisorLimite for informado, irá desassociar o mesmo. Caso não informado um CSGDivisorLimite, desassociará todos os divisores limite do título | 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 divisor limite cheque é composta pelas informações do divisor limite ("CSGDivisorLimite") e pela chave do cheque ("CMC7").
Observações
Os campos CSGDivisorLimite e ValorDivisorLimite são obrigatórios somente na associação de divisor de limite, onde o campo Desassociar não deve estar preenchido com a flag "S".
Para a associação do divisor de limite com o cheque, o divisor deve estar parametrizado para a origem do cheque.
Exemplo layout ODBC
select
'1245666555' as CMC7,
'CDGsgDIVLim001' as CSGDivisorLimite,
'100,66' as ValorDivisorLimite,
'' as Desassociar,
'Identificador Interno' as IdentificadorInterno
# Cadastro de Nota Complementar
O serviço de cadastro de nota complementar tem como objetivo o cadastro de notas de débito e crédito que posteriormente pode ser associado a um título. Além do serviço de cadastrar é possível associar e desassociar a nota complementar em uma parametrização de categoria.
# Cadastrar Nota Complementar
Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|---|
Codigo | Código da nota complementar | String | 30 | Sim | |
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 | |
CodigoNota | Código da nota | String | 30 | Não | |
DataEmissao | Data da emissão da nota | DateTime | Formato: dd/mm/aaaa | Sim | |
DocumentoNotaComplementar | Documento da nota complementar | String | 30 | Sim | |
Saldo | Saldo | Decimal | 18,2 | Símbolo decimal: "," | Não |
TipoNotaComplementar | Tipo | Int | 1 - Crédito 2 - Débito | Sim | |
Valor | Valor | Decimal | 18,2 | Símbolo decimal: "," | Sim |
DocumentoCedente | Documento do cliente cedente. | String | 14 | CNPJ, CPF ou Código identificador exportação | Não |
TipoCedente | Tipo pessoa do cliente cedente | String | 1 | J - Jurídica F - Física E - Exportação | Não |
NomeOrigemCedente | Nome da origem do cedente | 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 da integração de nota complementar é composta pelas informações da nota complementar ("Codigo") e pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
Observação
Caso não seja necessário o cadastro do cedente da nota, as identificações: DocumentoCedente, TipoCedente e NomeOrigemCedente não devem ser enviadas no comando.
Exemplo layout ODBC
select
'CDG0012121' as Codigo, !!
'00000000000' as Documento,
'F' as Tipo,
'Origem Cliente' as NomeOrigem,
'' as CodigoNota,
'01/01/2017' as DataEmissao,
'Complementação' as DocumentoNotaComplementar,
'2520,10' as Saldo,
'1' as TipoNotaComplementar,
'5010,52' as Valor,
'00000000000000' as DocumentoCedente,
'J' as TipoCedente,
'Origem Cedente' as NomeOrigemCedente,
'Identificador Interno' as IdentificadorInterno
# Associar Parametrização Categoria Nota Complementar
Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|---|
Codigo | Código da nota complementar | String | 30 | Sim | |
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 | |
CSGParamCategoria | Código de sistema de gestão de parametrização categoria | String | 100 | Não | |
NomeParametrizacaoCategoria | Nome da parametrização categoria | String | 100 | Não | |
NomeCategoria | Nome da categoria de parametrização de categoria | String | 30 | 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 parametrização categoria nota complementar é composta pelas informações da parametrização categoria ("CSGParamCategoria" ou "NomeParametrizacaoCategoria") e pelas informações da nota complementar ("Codigo").
Observação
São obrigatórios os campos NomeParametrizacaoCategoria e CSGParamCategoria somente na associação de nota complementar com parametrização categoria. Para desassociar todas as parametrizações de categoria da nota complementar não deve ser informado esse campo.
Exemplo layout ODBC
select
'CDG448484' as Codigo, !!
'1234678901234' as Documento,
'J' as Tipo,
'Origem Cliente' as NomeOrigem,
'CODGsgparamt556' as CSGParamCategoria, !!
'Parametrizacao Categoria' as NomeParametrizacaoCategoria,
'Nome Categoria' as NomeCategoria,
'Identificador Interno' as IdentificadorInterno
# Desassociar Parametrização Categoria Nota Complementar
Campo | Descrição Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|
Documento | Documento do cliente | String | 14 | CNPJ, CPF ou Código identificador exportação |
Tipo | Tipo pessoa do cliente | String | 1 | J - Jurídica F - Física E - Exportação |
NomeOrigem | Nome da origem do cliente | String | 40 | |
CodigoNotaComplementar | Código da nota complementar | String | 30 | |
CsgParamCategoria | Código de sistema de gestão de parametrização categoria | String | 20 | Código de sistema de gestão. Caso seja informado, remove apenas a parametrização categoria informada |
NomeCategoria | Nome da categoria de parametrização de categoria | String | 40 | Nome da Categoria. Caso seja informado, irá remover apenas as parametrizações de categoria da categoria informada |
IdentificadorInterno | Identificador interno | String | Identificador enviado pelo cliente para ser utilizado no retorno de integrações |
Atenção
A chave de identificação de desassociação parametrização categoria nota complementar é composta pelas informações da parametrização categoria ("CsgParamCategoria" ou "NomeCategoria") e pelas informações da nota complementar ("CodigoNotaComplementar").
Exemplo layout ODBC
select !!novo
'1234678901234' as Documento,
'J' as Tipo,
'Origem Cliente' as NomeOrigem,
'CDGNTCOMP0505' as CodigoNotaComplementar,
'CODGsgparamt556' as CSGParamCategoria,
'Nome Categoria' as NomeCategoria,
'Identificador Interno' as IdentificadorInterno
# Associar Divisor Limite Nota Complementar
Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|---|
CodigoNotaComplementar | Código da nota complementar | String | 30 | Sim | |
CSGDivisorLimite | Código sistema de gestão do divisor de limite | String | 50 | Não | |
ValorDivisorLimite | Valor do divisor de limite. | Decimal | 18,2 | Não | |
Desassociar | Flag "S" ou vazio | String | 1 | Ao enviar "S", e um CSGDivisorLimite for informado, irá desassociar o mesmo. Caso não informado um CSGDivisorLimite, desassociará todos os divisores limite do título | 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 divisor limite nota complementar é composta pelas informações do divisor limite ("CSGDivisorLimite") e pelas informações da nota complementar ("CodigoNotaComplementar").
Observações
Os campos CSGDivisorLimite e ValorDivisorLimite são obrigatórios somente na associação de divisor de limite, onde o campo Desassociar não deve estar preenchido com a flag "S".
Para a associação do divisor de limite com o nota complementar, o divisor deve estar parametrizado para a origem da nota complementar.
Exemplo layout ODBC
select !!novo
'CDG23231234' as CodigoNotaComplementar,
'CDGsg111' as CSGDivisorLimite,
'600,30' as ValorDivisorLimite,
'S' as Desassociar,
'Identificador Interno' as IdentificadorInterno
# Cadastro de Título
Além do serviço de cadastrar títulos é possível realizar as seguintes associações:
- Associar título com nota fiscal
- Associar título com cheque
- Associar título com nota complementar
- Associar e desassociar título com parametrização de categoria
# Cadastrar título
Atenção
As informações de Codigo, Documento e NumeroBoleto podem ser utilizadas no processo de negativação Serasa, para envio no campo NossoNumero da remessa, caso sejam selecionados no momento da negativação. Para utilização com sucesso dessas informações, o valor selecionado deve seguir as exigências da Serasa, sendo composto somente de números e ter no máximo 9 dígitos. Obs.: Caracteres especiais e espaços são removidos pelo sistema no momento da geração da remessa.
Negativação Serasa, Negativação Boa Vista, Protesto Nacional, Protesto São Paulo e Escritórios de Cobrança são funcionalidades que utilizam diretamente de várias informações dos títulos, portanto caso o cliente venha utilizar um desses processos, integração deve ser pensada e realizada de maneira a fornecer dados formatados para não gerar nenhum problema nestes processos.
Código | Campo | Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|---|
Codigo | Código do título | String | 30 | Sim | |
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 | |
DocumentoRepresentante | Documento do representante | String | 15 | CNPJ, CPF ou Código identificador 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 | |
DocumentoTitulo | Documento do título | String | 30 | Este campo é utilizado como agrupador de títulos, quando for realizado parcelamento de uma compra, e cada parcela for integrada como um título. Valores de data/valor da última/maior compra podem ser diretamente impactados por esse campo. | Sim |
DataEmissao | Data de emissão | DateTime | Formato: dd/mm/aaaa | Sim | |
DataVencimentoProrrogado | Data de vencimento prorrogado | DateTime | Formato: dd/mm/aaaa | Sim | |
DataVencimento | Data de vencimento | DateTime | Formato: dd/mm/aaaa | Sim | |
MotivoProrrogacao | Motivo prorrogação | Int | 1 - Considera para o cálculo a data de vencimento original 2 - Considera para o cálculo a data de vencimento prorrogado | Sim | |
Observacao | Observação | String | 200 | Não | |
Parcela | Parcela do título | String | 10 | Sim | |
Valor | Valor do título | Decimal | 18,2 | Símbolo decimal: "," | Sim |
DocumentoCedente | Documento do cliente cedente | String | 15 | CNPJ, CPF ou Código identificador exportação | Não |
TipoCedente | Tipo pessoa do cliente cedente | String | 1 | J - Jurídica F - Física E - Exportação | Não |
NomeOrigemCedente | Nome da origem do cedente | String | 40 | Não | |
IdentificadorInterno | Identificador interno | String | Identificador enviado pelo cliente para ser utilizado no retorno de integrações | Não | |
NumeroBoleto | Número do boleto do título | String | 100 | Não | |
Observacao1 | Observação extra | String | 200 | Não | |
Observacao2 | Observação extra | String | 200 | Não | |
Observacao3 | Observação extra | String | 200 | Não | |
Desconto | Desconto do título | Decimal | 18,2 | Desconto a ser aplicado ao título na recuperação de crédito. Símbolo decimal: "," | Não |
Atenção
A chave de identificação da integração de títulos é composta pelas informações do título ("Codigo") e pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
Observação
Caso não seja necessário o cadastro do cedente do título, as identificações: DocumentoCedente, TipoCedente e NomeOrigemCedente não devem ser enviadas no comando.
O campo "Validar dados" com a opção 'Sim', os campos obrigatórios e os clientes serão validados antes de realizar a integração, se algum dos campos obrigatórios não for enviado, a informação não será integrada, e se o cliente não for encontrado, o mesmo será cadastrado. Esta deve ser a opção padrão após o cliente entrar em produção.
O campo "Validar dados" com a opção 'Não', os dados não serão validados ao realizar a integração, ou seja, serão salvos no banco de dados em tabelas temporárias todos os registros integrados, e posteriormente serão salvos nas respectivas tabelas reais de clientes já cadastrados dentro do DepsNet, se o cliente não estiver cadastrado, esta opção não realiza o cadastro do mesmo. Essa função só deve ser utilizada para carga de dados, devido ao ganho de performance.
Exemplo layout ODBC
select
'000Cod35' as Codigo,
'12345678901234' as Documento,
'J' as Tipo,
'Origem Cliente' as NomeOrigem,
'000002222231211' as DocumentoRepresentante,
'J' as TipoRepresentante,
'Origem Representante' as NomeOrigemRepresentante,
'DOCTitulo' as DocumentoTitulo,
'24/01/2017' as DataEmissao,
'05/02/2017' as DataVencimentoProrrogado,
'03/02/2017' as DataVencimento,
'1' as MotivoProrrogacao,
'Sem observação' as Observacao,
'1' as Parcela,
'3643,52' as Valor,
'00011100033' as DocumentoCedente,
'J' as TipoCedente,
'Origem Cedente' as NomeOrigemCedente,
'Identificador Interno' as IdentificadorInterno,
'332323000' as NumeroBoleto,
'Sem observação' as Observacao1,
'Sem observação' as Observacao2,
'Sem observação' as Observacao3,
'100,00' as Desconto
# Associar Título Cliente Relacionado
Código | Campo | Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|---|
Desassociar | Flag ‘S’ ou vazio. | String | 1 | Para desassociar o cliente relacionado do título deve ser enviado "S". Caso contrário deve ser enviado em branco. Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet | Não |
CodigoTitulo | Código do título | String | 30 | Sim | |
Documento | Documento do cliente do título | String | 15 | CNPJ, CPF ou Código identificador exportação | Sim |
Tipo | Tipo pessoa do cliente do título | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
NomeOrigem | Nome da origem do cliente do título | String | 40 | Sim | |
DocumentoCliente | Documento do cliente relacionado | String | 15 | CNPJ, CPF ou Código identificador exportação | Sim |
TipoCliente | Tipo pessoa do cliente relacionado | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
OrigemCliente | Nome da origem do cliente relacionado | String | 40 | Sim | |
TipoRelacao | Tipo da relação entre título e cliente | String | 3 | AVA - Avalista PED - Cliente do pedido | Sim |
IdentificadorInterno | Identificador interno | String | Identificador enviado pelo cliente para ser utilizado no retorno de integrações | Não |
Exemplo layout ODBC
SELECT
'' AS Desassociar,
'COD_TITULO' AS CodigoTitulo,
'11100011122' AS Documento,
'F' AS Tipo,
'Origem cliente titulo' AS NomeOrigem,
'22211122200' AS DocumentoCliente,
'F' AS TipoCliente,
'Origem cliente relacionado' AS OrigemCliente,
'PED' AS TipoRelacao,
'Identificador Interno' as IdentificadorInterno
# Associar Título Pedido Relacionado
Código | Campo | Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|---|
Desassociar | Flag ‘S’ ou vazio. | String | 1 | Para desassociar o cliente relacionado do título deve ser enviado "S". Caso contrário deve ser enviado em branco. Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet | Não |
CodigoTitulo | Código do título | String | 30 | Sim | |
Documento | Documento do cliente do título | String | 15 | CNPJ, CPF ou Código identificador exportação | Sim |
Tipo | Tipo pessoa do cliente do título | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
NomeOrigem | Nome da origem do cliente do título | String | 40 | Sim | |
CodigoPedido | Código do pedido relacionado | String | 30 | Sim | |
IdentificadorInterno | Identificador interno | String | Identificador enviado pelo cliente para ser utilizado no retorno de integrações | Não |
Exemplo layout ODBC
SELECT
'' AS Desassociar,
'COD_TITULO' AS CodigoTitulo,
'00011100012' AS Documento,
'F' AS Tipo,
'Origem cliente título' AS Origem,
'COD_PEDIDO' AS CodigoPedido,
'Identificador Interno' as IdentificadorInterno
# Associar Parametrização Categoria Título
Código | Campo | Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|---|
Codigo | Código do título | String | 30 | Sim | |
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 | |
NomeParametrizacaoCategoria | Nome da parametrização categoria | String | 100 | Não | |
NomeCategoria | Nome da categoria da parametrização categoria | String | 30 | Não | |
CsgParamCategoria | Código sistema de gestão da parametrização de categoria | String | 50 | 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 parametrização categoria título é composta pelas informações da parametrização categoria ("NomeParametrizacaoCategoria" ou "CsgParamCategoria"), pelas informações do título ("Codigo") e pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
Observação
Os campos NomeParametrizacaoCategoria e CsgParamCategoria são obrigatórios somente na associação de título com parametrização categoria. Para desassociar todas as parametrizações de categoria do título não deve ser informado esses campos.
O campo "Validar dados" com a opção 'Sim', os campos obrigatórios e os clientes serão validados antes de realizar a integração, se algum dos campos obrigatórios não for enviado, a informação não será integrada, e se o cliente não for encontrado, o mesmo será cadastrado. Esta deve ser a opção padrão após o cliente entrar em produção.
O campo "Validar dados" com a opção 'Não', os dados não serão validados ao realizar a integração, ou seja, serão salvos no banco de dados em tabelas temporárias todos os registros integrados, e posteriormente serão salvos nas respectivas tabelas reais de clientes já cadastrados dentro do DepsNet, se o cliente não estiver cadastrado, esta opção não realiza o cadastro do mesmo. Essa função só deve ser utilizada para carga de dados, devido ao ganho de performance.
Exemplo layout ODBC
select
'Cod003332' as Codigo,
'12345678901234' as Documento,
'J' as Tipo,
'Origem Cliente' as NomeOrigem,
'Parametrização Título' as NomeParametrizacaoCategoria,
'Portador' as NomeCategoria,
'222333' as CsgParamCategoria,
'Identificador Interno' as IdentificadorInterno
# Desassociar Parametrização Categoria Título Cliente
Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|---|
Documento | Documento do cliente | String | 14 | CNPJ ou CPF | Sim |
Tipo | Tipo do cliente | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
NomeOrigem | Nome da origem do cliente | String | 40 | Sim | |
CodigoTitulo | Código do título | String | 30 | Sim | |
CsgParamCategoria | Código de sistema de gestão de parametrização categoria | String | 50 | Código de sistema de gestão. Caso seja informado, remove apenas a parametrização categoria informada | Não |
NomeCategoria | Nome da categoria de parametrização de categoria | String | 30 | Nome da Categoria. Caso seja informado, irá remover apenas as parametrizações de categoria da categoria informada | 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 parametrização categoria título cliente é composta pelas informações da parametrização categoria ("NomeParametrizacaoCategoria" ou "CsgParamCategoria"), pelas informações do título ("CodigoTitulo") e pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
Exemplo layout ODBC
select
'12345678901234' as Documento,
'F' as Tipo,
'Origem Cliente' as NomeOrigem,
'Titulo00660' as CodigoTitulo,
'CodGestao001' as CsgParamCategoria,
'Portador' as NomeCategoria,
'Identificador Interno' as IdentificadorInterno
# Associar Nota
Código | Campo | Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|---|
Codigo | Código do título | String | 30 | Sim | |
Documento | Documento do cliente do título | String | 14 | CNPJ, CPF ou Código identificador exportação | Sim |
Tipo | Tipo pessoa do cliente do título. | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
NomeOrigem | Nome da origem do cliente do título | String | 40 | Sim | |
CodigoNota | Código da nota | String | 30 | Sim | |
DocumentoNota | Documento do cliente da nota | String | 14 | CNPJ, CPF ou Código identificador exportação | Sim |
TipoNota | Tipo pessoa do cliente da nota. | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
NomeOrigemNota | Nome da origem do cliente da nota. | 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 nota é composta pelas informações da nota ("CodigoNota"), pelas informações do título ("Codigo") e pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
Exemplo layout ODBC
select
'Cod555' as Codigo,
'12345678901234' as Documento,
'J' as Tipo,
'Origem Cliente' as NomeOrigem,
'000222CoD' as CodigoNota,
'12345670000234' as DocumentoNota,
'F' as TipoNota,
'Origem Cliente Nota' as NomeOrigemNota,
'Identificador Interno' as IdentificadorInterno
# Associar Nota Complementar
Código | Campo | Tipo | Tam. | Informações | *Obrigatório |
---|---|---|---|---|---|
Codigo | Código do título | String | 30 | Sim | |
Documento | Documento do cliente do título | String | 15 | CNPJ, CPF ou Código identificador exportação | Sim |
Tipo | Tipo pessoa do cliente do título. | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
NomeOrigem | Nome da origem do cliente do título | String | 40 | Sim | |
CodigoNota | Código da nota | String | 30 | Sim | |
DocumentoNota | Documento do cliente da nota complementar | String | 15 | CNPJ, CPF ou Código identificador exportação | Sim |
TipoNota | Tipo pessoa do cliente da nota complementar | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
NomeOrigemNota | Nome da origem do cliente da nota complementar | 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 nota complementar é composta pelas informações da nota complementar ("CodigoNota"), pelas informações do título ("Codigo") e pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
Exemplo layout ODBC
select
'Cod0033' as Codigo,
'123456789012345' as Documento,
'J' as Tipo,
'Origem Cliente' as NomeOrigem,
'Codnota0022' as CodigoNota,
'11222233356' as DocumentoNota,
'J' as TipoNota,
'Origem Cliente Nota' as NomeOrigemNota,
'Identificador Interno' as IdentificadorInterno
# Associar Cheque
Código | Campo | Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|---|
Codigo | Código do título | String | 30 | Sim | |
Documento | Documento do cliente do título | String | 14 | CNPJ, CPF ou Código identificador exportação | Sim |
Tipo | Tipo pessoa do cliente do título | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
NomeOrigem | Nome da origem do cliente do título | String | 40 | Sim | |
Numero | Número do cheque | String | 40 | Sim | |
DocumentoCheque | Documento do cliente do cheque | String | 14 | CNPJ, CPF ou Código identificador exportação | Sim |
TipoCheque | Tipo do cliente do cheque | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
NomeOrigemCheque | Nome da origem do cliente do cheque | String | 40 | Sim | |
ValorUtilizado | Valor Utilizado | Decimal | 18,2 | 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 de cheque é composta pelas informações do cheque ("Numero"), pelas informações do título ("Codigo") e pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
Exemplo layout ODBC
select
'Cod00333' as Codigo,
'12345678901234' as Documento,
'J' as Tipo,
'Origem Cliente' as NomeOrigem,
'0033551' as Numero,
'00000000000' as DocumentoCheque,
'F' as TipoCheque,
'Origem Cheque' as NomeOrigemCheque,
'00,0' as ValorUtilizado,
'Identificador Interno' as IdentificadorInterno
# Associar Recuperação Negociação
Código | Campo | Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|---|
Codigo | Código do título | String | 30 | Sim | |
Documento | Documento do cliente do título | String | 15 | CNPJ, CPF ou Código identificador exportação | Sim |
Tipo | Tipo pessoa do cliente do título | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
NomeOrigem | Nome da origem do cliente do título | String | 40 | Sim | |
CodigoNegociacao | Código da negociação da recuperação de crédito | Int | Não | ||
NumeroParcela | Número da parcela da negociação da recuperação de crédito | Int | 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 recuperação negociação título é composta pelas informações da negociação ("CodigoNegociacao" e "NumeroParcela"), pelas informações do título ("Codigo") e pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
Observação
Os campos CodigoNegociacao e NumeroParcela são obrigatórios somente na associação de título com recuperação negociação. Para desassociar a recuperação negociação do título não deve ser informado esses campos.
Exemplo layout ODBC
select
'Cod11244' as Codigo,
'123456789012345' as Documento,
'J' as Tipo,
'Origem Cliente' as NomeOrigem,
'10506' as CodigoNegociacao,
'1' as NumeroParcela,
'Identificador Interno' as IdentificadorInterno
# Associar Divisor Limite
Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|---|
CodigoTitulo | Código do título | String | 30 | Sim | |
Documento | Documento do cliente do título | String | 15 | CNPJ, CPF ou Código identificador exportação | Sim |
Tipo | Tipo pessoa do cliente do título | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
NomeOrigem | Nome da origem do cliente do título | String | 40 | Sim | |
CSGDivisorLimite | Código sistema de gestão do divisor limite | String | 50 | Não | |
ValorDivisorLimite | Valor do divisor de limite | Decimal | 18,2 | Não | |
Desassociar | Flag "S" ou vazio | String | 1 | Ao enviar "S", e um CSGDivisorLimite for informado, irá desassociar o mesmo. Caso não informado um CSGDivisorLimite, desassociará todos os divisores limite do título | Não |
IdentificadorInterno | Identificador interno | String | Identificador enviado pelo cliente para ser utilizado no retorno de integrações | Não |
Observações
Os campos CSGDivisorLimite e ValorDivisorLimite são obrigatórios somente na associação de divisor de limite, onde o campo Desassociar não deve estar preenchido com a flag "S".
Para a associação do divisor de limite com o título, o divisor deve estar parametrizado para a origem do título.
Exemplo layout ODBC
select
'Cod11244' as CodigoTitulo,
'123456789012345' as Documento,
'J' as Tipo,
'Origem Cliente' as NomeOrigem,
'CSGAVISTA001' as CSGDivisorLimite,
'322,02' as ValorDivisorLimite,
'' as Desassociar,
'Identificador Interno' as IdentificadorInterno
# Cadastrar Movimento Geral
O cadastro de movimento geral é utilizado para dar movimentações em títulos. O tipo de movimento geral já deve ser cadastrado antes de realizar as integrações de movimentação geral, seu cadastro é feito pelo DepsNet.
Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|---|
CodigoTitulo | Código do título | String | 30 | Sim | |
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 | |
NomeTipoMovimentacao | Nome do tipo de movimentação | String | 50 | Nome ou código sistema de gestão deve ser obrigatório | |
DocumentoMovimentacao | Documento da movimentação | String | 30 | Sim | |
DataMovimentacao | Data da movimentação | DateTime | Formato: dd/mm/aaaa | Sim | |
ValorMovimentacao | Valor da movimentação | Decimal | 18,2 | Símbolo decimal: "," | Sim |
CodigoSistemaGestaoTipoMovimentacao Ou CSGTipoMovimento | Código sistema de gestão do tipo de movimentação | String | 50 | Nome ou código sistema de gestão deve ser obrigatório | |
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 movimentação geral é composta pelas informações do tipo de movimentação geral ("CodigoSistemaGestaoTipoMovimentacao" ou "NomeTipoMovimentacao"), pelas informações do título ("CodigoTitulo") e pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
Observações
O campo "Validar dados" com a opção 'Sim', os campos obrigatórios e os clientes serão validados antes de realizar a integração, se algum dos campos obrigatórios não for enviado, a informação não será integrada, e se o cliente não for encontrado, o mesmo será cadastrado. Esta deve ser a opção padrão após o cliente entrar em produção.
O campo "Validar dados" com a opção 'Não', os dados não serão validados ao realizar a integração, ou seja, serão salvos no banco de dados em tabelas temporárias todos os registros integrados, e posteriormente serão salvos nas respectivas tabelas reais de clientes já cadastrados dentro do DepsNet, se o cliente não estiver cadastrado, esta opção não realiza o cadastro do mesmo. Essa função só deve ser utilizada para carga de dados, devido ao ganho de performance.
Exemplo layout ODBC
select
'CodTITULO001112' as CodigoTitulo,
'12345678901234' as Documento,
'J' as Tipo,
'Origem Cliente' as NomeOrigem,
'SALDO' as NomeTipoMovimentacao,
'DOCMOV0022' as DocumentoMovimentacao,
'13/02/2017' as DataMovimentacao,
'300,00' as ValorMovimentacao,
'SALDO' as CodigoSistemaGestaoTipoMovimentacao,
'Identificador Interno' as IdentificadorInterno
# Cadastrar Movimento Baixas
O cadastro de movimento de baixas é utilizado para dar baixa em títulos. O tipo de baixa já deve ser cadastrado antes de realizar as integrações de movimentações de baixa, seu cadastro é feito pelo DepsNet.
Campo | Descrição | Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|---|
CodigoTitulo | Código do título | String | 30 | Sim | |
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 | |
NomeTipoBaixa | Nome do tipo de baixa | String | 50 | Nome ou código sistema de gestão deve ser obrigatório | |
DocumentoBaixa | Documento da baixa | String | 30 | Sim | |
DataBaixa | Data da baixa | DateTime | Formato: dd/mm/aaaa | Sim | |
ValorBaixa | Valor da baixa | Decimal | 18,2 | Símbolo decimal: "," | Sim |
CodigoSistemaGestaoTipoBaixa Ou CSGTipoBaixa | Nome ou código sistema de gestão deve ser obrigatório | ||||
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 movimentação baixa é composta pelas informações do tipo de movimentação baixa ("CodigoSistemaGestaoTipoBaixa" ou "NomeTipoBaixa"), pelas informações do título ("CodigoTitulo") e pelas informações do cliente ("Documento", "Tipo" e "NomeOrigem").
Observações
O campo "Validar dados" com a opção 'Sim', os campos obrigatórios e os clientes serão validados antes de realizar a integração, se algum dos campos obrigatórios não for enviado, a informação não será integrada, e se o cliente não for encontrado, o mesmo será cadastrado. Esta deve ser a opção padrão após o cliente entrar em produção.
O campo "Validar dados" com a opção 'Não', os dados não serão validados ao realizar a integração, ou seja, serão salvos no banco de dados em tabelas temporárias todos os registros integrados, e posteriormente serão salvos nas respectivas tabelas reais de clientes já cadastrados dentro do DepsNet, se o cliente não estiver cadastrado, esta opção não realiza o cadastro do mesmo. Essa função só deve ser utilizada para carga de dados, devido ao ganho de performance.
Exemplo layout ODBC
select
'CodTITULO001112' as CodigoTitulo,
'12345678901234' as Documento,
'F' as Tipo,
'Origem Cliente' as NomeOrigem,
'BAIXA' as NomeTipoBaixa,
'DOCbaixa0055' as DocumentoBaixa,
'18/02/2017' as DataBaixa,
'300,00' as ValorBaixa,
'BAIXA' as CodigoSistemaGestaoTipoBaixa,
'Identificador Interno' as IdentificadorInterno
# Cadastrar Índice de Faturamento Resumido
Código | Campo | Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|---|
Documento | Documento | String | 15 | CNPJ, CPF ou Código identificador exportação | Sim |
Tipo | Tipo pessoa | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
NomeOrigem | Nome da origem | String | 40 | Sim | |
ValorElegivel | Valor elegível | Decimal | 18,2 | Símbolo decimal: "," | Sim |
Prazo | Prazo | Int | Sim | ||
Endividamento | Endividamento | Decimal | 18,2 | Símbolo decimal: "," | Sim |
Share | Share | Decimal | 18,2 | Símbolo decimal: "," | Sim |
Atenção
A chave de identificação da integração de índice de faturamento resumido é composta pelas informações da pessoa ("Documento", "Tipo" e "NomeOrigem").
Exemplo layout ODBC
select
'12345678901324' as Documento,
'J' as Tipo,
'Origem CLiente' as NomeOrigem,
'35' as ValorElegivelParaDesconto, !!
'15' as Prazo,
'732,69' as Endividamento,
'150' as Share
# Cadastrar Faturamento Declarado
Código | Campo | Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|---|
Documento | Documento | String | 15 | CNPJ, CPF ou Código identificador exportação | Sim |
Tipo | Tipo pessoa | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
NomeOrigem | Nome da origem | String | 40 | Sim | |
DataOperacao | Data da operação | DateTime | Formato: dd/mm/aaaa | Sim | |
ValorFaturamento | Valor do faturamento | Decimal | 18,2 | Símbolo decimal: "," | Sim |
Atenção
A chave de identificação da integração de índice de faturamento declarado é composta pelas informações da pessoa ("Documento", "Tipo" e "NomeOrigem") e "DataOperacao".
Exemplo layout ODBC
select
'123456789012345' as Documento,
'J' as Tipo,
'Origem' as NomeOrigem,
'01/01/2017' as DataOperacao,
'1500,52' as ValorFaturamento
# Cadastrar Informações Consolidadas - Analítico
Código | Campo | Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|---|
Documento | Documento | String | 15 | CNPJ, CPF ou Código identificador exportação | Sim |
Tipo | Tipo pessoa | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
NomeOrigem | Nome da origem | String | 40 | Sim | |
Periodo | Período | DateTime | Formato: dd/mm/aaaa | Sim | |
Valor | Valor | Decimal | 18,2 | Símbolo decimal: "," | Sim |
Liquidez | Liquidez | Decimal | 18,2 | Símbolo decimal: "," | Sim |
Recompra | Decimal | 18,2 | Símbolo decimal: "," | Sim |
Atenção
A chave de identificação da integração de índice de informações consolidadas é composta pelas informações da pessoa ("Documento", "Tipo" e "NomeOrigem") e "Periodo".
Exemplo layout ODBC
select !! novo
'123456789012345' as Documento,
'J' as Tipo,
'Origem' as NomeOrigem,
'01/01/2017' as Periodo,
'1500,52' as Valor,
'1200,03' as Liquidez,
'2522,41' as Recompra
# Cadastrar Valores em Aberto - Analítico
Código | Campo | Tipo | Tam. | Informações | Obrigatório |
---|---|---|---|---|---|
Documento | Documento | String | 15 | CNPJ, CPF ou Código identificador exportação | Sim |
Tipo | Tipo pessoa | String | 1 | J - Jurídica F - Física E - Exportação | Sim |
NomeOrigem | Nome da origem | String | 40 | Sim | |
ValorAVencer | Valor à vencer | Decimal | 18,2 | Símbolo decimal: "," | Sim |
ValorVencido | Valor vencido | Decimal | 18,2 | Símbolo decimal: "," | Sim |
Atenção
A chave de identificação da integração de índice de valores em aberto é composta pelas informações da pessoa ("Documento", "Tipo" e "NomeOrigem").
Exemplo layout ODBC
select
'123456789012345' as Documento,
'J' as Tipo,
'Origem' as NomeOrigem,
'1200,03' as ValorAVencer,
'2522,41' as ValorVencido