Integração de Pedidos

Cadastrar Situação

Campo	Descrição	Tipo	Tam.	Informações	Obrigatório
Nome	Nome da situação do pedido	String	50	Exemplo: Aprovado, Bloqueado, Faturado...	Sim
CodigoSistemaGestao	Código do sistema de gestão da situação do pedido	String	50	Código sistema de gestão passou a ser obrigatório a partir da versão v21_8 do DepsNet, por conta de implementação de chave única dessa informação no banco de dados. Clientes antigos que não utilizavam este campo não devem ser afetados.	Sim*
Condicao	Condição da situação	Int		1 - Toma crédito: Quando o pedido estiver com esta situação, deve ser descontado o valor do limite disponível 0 - Não toma crédito: Quando o pedido estiver com esta situação, não deve ser descontado valor	Não
Tipo	Tipo da situação	Int		0 - Nenhum 1 - Aprovado 2 - Bloqueado 3 - Faturado	Não
ContaAutomacao	Conta para automação	Int		1 - Sim 0 - Não	Não
UtilizaAlcadaReanalise		Int		1 - Sim 0 - Não	Não
PermiteMultiplosMotivos	Permite mais de um motivo	Int		1 - Sim 0 - Não	Não
ObrigatoriedadeMotivo	Obrigatoriedade de informar motivo	Int		0 - Sem obrigação 1 - Apenas motivo obrigatório 2 - Apenas informação complementar obrigatório 3 - Motivo ou informação complementar obrigatório	Não

Atenção

Os campos "Nome" ou "CodigoSistemaGestao" compõe a chave de identificação da integração de situação.

Exemplo layout ODBC

select	
'Aprovado' as Nome,
'CODG000002' as CodigoSistemaGestao,
'1' as Condicao,
'1' as Tipo,
'1' as ContaAutomacao,
'1' as UtilizaAlcadaReanalise,
'1' as PermiteMultiplosMotivos,
'1' as ObrigatoriedadeMotivo

Cadastrar Motivo

Campo	Descrição	Tipo	Tam.	Informações	Obrigatório
Nome	Nome do motivo	String	50		Sim
CodigoSistemaGestao	Código do sistema de gestão	String	50		Não

Exemplo layout ODBC

select	
'Nome do Motivo' as Nome,
'CODGSG003' as CodigoSistemaGestao

Cadastrar Categoria Pedido

Campo	Descrição	Tipo	Tam.	Informações	Obrigatório
Nome	Nome da categoria de pedido	String	50		Sim

Exemplo layout ODBC

select 
'Categoria Pedido' as Nome

Cadastrar Parametrização Categoria Pedido

Campo	Descrição	Tipo	Tam.	Informações	Obrigatório
NomeCategoria	Nome da categoria de pedido	String	50		Sim
Nome	Nome da parametrização da categoria de pedido	String	100		Sim
AprovadoAutomacao	Aprovados via automação	Int		O pedido pode ter sua situação alterada para aprovada, pela automação: 1 - Sim 0 - Não	Não
BloqueadoAutomacao	Bloqueados via automação	Int		O pedido pode ter sua situação alterada para bloqueada, pela automação: 1 - Sim 0 - Não	Não
CodigoSistemaGestao	Código de alguma informação vinda do sistema de gestão, para identificação no mesmo	String	50		Não
IdentificadorInterno	Identificador interno	String		Identificador enviado pelo cliente para ser utilizado no retorno de integrações	Não

Atenção

Os campos"Nome" ou "CodigoSistemaGestao" compõe a chave de identificação da integração de parametrização categoria de pedido.

As informações referentes aos campos: AprovadoAutomacao,BloqueadoAutomacao são utilizadas apenas na inserção da parametrização da categoria de pedido, não sendo possível realizar a atualização da informação pelo serviço após cadastrada.

Exemplo layout ODBC

select	
'Categoria de Pedido' as NomeCategoria,
'Parametrização Categoria' as Nome,
'1' as AprovadoAutomacao,
'1' as BloqueadoAutomacao,
'CODGinfo0035' as CodigoSistemaGestao,
'CodInterno' as IdentificadorInterno

Associar Motivo Situação Pedido

Campo	Descrição	Tipo	Tam.	Informações	Obrigatório
NomeSituacao	Nome da situação do pedido	String	50	Nome da situação do pedido	Sim
NomeMotivo	Nome do motivo	String	50	Nome do motivo	Sim

Exemplo layout ODBC

select	
'Situação Pedido' as NomeSituacao,
'Motivo' as NomeMotivo

Cadastrar Segmento Produto

Campo	Descrição	Tipo	Tam.	Informações	Obrigatório
Nome	Nome do segmento de produto	String	50		Sim
CodigoSistemaGestao	Código do sistema de gestão	String	50		Não
NomeOrigem	Nome da origem de informação cadastral	String	40		Sim

Atenção

Os campos "Nome" e "NomeOrigem" compõem a chave de identificação da integração de segmento produto.

Exemplo layout ODBC

select	
'Segmento do produto' as Nome,
'CODG00212' as CodigoSistemaGestao,
'Origem Informação Cadastral' as NomeOrigem

Cadastrar Grupo Produto

Campo	Descrição	Tipo	Tam.	Informações	Obrigatório
Nome	Nome do grupo de produto	String	50		Sim
CodigoSistemaGestao	Código do sistema de gestão	String	50		Não
NomeSegmento	Nome do segmento de produto	String	50		Sim

Atenção

Os campos "Nome" e "NomeSegmento" compõem a chave de identificação da integração de grupo produto.

Exemplo layout ODBC

select	
'Grupo de Produto' as Nome,
'CDGsg7754' as CodigoSistemaGestao,
'Segmento de Produto' as NomeSegmento

Cadastrar Item Produto

Campo	Descrição	Tipo	Tam.	Informações	Obrigatório
Nome	Nome do item produto	String	100		Não
CodigoSistemaGestao	Código do sistema de gestão	String	50		Sim
CodigoSistemaGestaoGrupoProduto	Código do sistema de gestão do grupo de produto	String	50		Sim

Atenção

Os campos "Nome" e "NomeGrupoProduto" compõem a chave de identificação da integração de item produto.

Exemplo layout ODBC

select	
'Item Produto' as Nome,
'CDGsg445' as CodigoSistemaGestao,
'Grupo de Produto' as Código do sistema de gestão

Cadastro de Pedidos

Além do serviço de cadastrar pedidos é possível realizar as seguintes associações:

• Associar pedido com situação

Cadastrar Pedido

Código	Campo	Tipo	Tam.	Informações	Obrigatório
Codigo	Código interno do pedido	String	30		Sim
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
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
TipoPagamento	Tipo de pagamento do pedido	Int		Tipo de pagamento: 0 - A prazo 1 - A vista 2 - Antecipado	Sim Se o campo não for informado, adicionará como padrão 0
CodigoOriginal	Código ou número original do pedido	String	30	Pode ser entendido como código de prospecção do pedido ou número da ordem de pedido	Sim
CodigoPedido	Código ou número do pedido de referência no sistema de gestão	String	30	Referência principal para o usuário da empresa	Sim
DataEmissao	Data da emissão do pedido	DateTime			Sim
DataFaturamento	Data de previsão de faturamento do pedido	DateTime			Não
DataPrimeiroVencimento	Data do primeiro vencimento do pedido ou data de vencimento da primeira parcela do pedido	DateTime			Sim
DiasEntreParcelas	Quantidade de dias entre as parcelas do pedido	Int			Não
Prazo	Faixas de prazo, que devem ser separadas por "/"	String	150	Exemplo: 30/60/90Quando não houver prazo ou pedido for avista, informar 000	Não
QuantidadeParcelas	Quantidade de parcelas do pedido	Int			Não
ValorBruto	Valor do pedido (bruto)	Decimal		Valor que deve ser considerado impostos, descontos, permitindo realizar projeção do faturamento	Sim
ValorEntrada	Valor já pago do pedido ou valor pago parcial, como uma entrada	Decimal		Obs.: Esse dado deve ser enviado via integração de dados	Sim
ValorLiquido	Valor do pedido(liquido)	Decimal		Valor que deve ser considerado apenas os itens sem impostos	Sim
ValorSaldo	Valor de saldo do pedido	Decimal		Valor de saldo do pedido	Sim
IdentificadorInterno	Identificador interno	String		Identificador enviado pelo cliente para ser utilizado no retorno de integrações	Não
DataAtualizaSituacao	Data atualiza situação	DateTime		Data para definir a partir de que dia o pedido poderá ser analisado	Não
Solicitante	Solicitante do pedido	String	90		Não

Atenção

A chave de identificação do cadastro pedido é composta pela informação do pedido ("Codigo").

Exemplo layout ODBC

select	
'CODG0000' as Codigo,
'12345678901234' as DocumentoCliente,
'J' as TipoCliente,
'Origem Cliente' as NomeOrigemCliente,
'00000000000' as DocumentoRepresentante,
'F' as TipoRepresentante,
'Origem Representante' as NomeOrigemRepresentante,
'0' as TipoPagamento,
'CDGoriginal' as CodigoOriginal,
'CDGsg000' as CodigoPedido,
'01/03/2017' as DataEmissao,
'01/04/2017' as DataFaturamento,
'01/05/2017' as DataPrimeiroVencimento,
'30' as DiasEntreParcelas,
'30/60/90/120' as Prazo,
'4' as QuantidadeParcelas,
'103,17' as ValorBruto,
'0,00' as ValorEntrada,
'103,17' as ValorLiquido,
'103,17' as ValorSaldo,
'Identificador Interno' as IdentificadorInterno,
'03/03/2017' as DataAtualizaSituacao,
'NomeSolicitante' as Solicitante 

Associar Pedido Situação

Campo	Descrição	Tipo	Tam.	Informações	Obrigatório
CodigoPedido	Código do pedido	String	30		Sim
NomeSituacao	Nome da situação	String	50		Nome ou código sistema de gestão deve ser obrigatório
CSGSituacao	Código sistema de gestão da situaçã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

Exemplo layout ODBC

select	
'CODGPEDIDO001' as CodigoPedido,
'BLOQUEADO' as NomeSituacao,
'CODGsg555' as CSGSituacao,
'Identificador Interno' as IdentificadorInterno

Associar Pedido Parametrização Categoria

Campo	Descrição	Tipo	Tam.	Informações	Obrigatório
CodigoPedido	Código do pedido	String	30		Sim
NomeParametrizacaoCategoria	Nome da parametrização de categoria	String	100		Não
CodSGParamCategoria	Código sistema de gestão da parametrização de categoria	String	50		Não
NomeCategoria	Nome da categoria 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

Os campos NomeParametrizacaoCategoria e CodSGParamCategoria são obrigatórios somente na associação de pedido com parametrização categoria. Para desassociar todas as parametrizações de categoria do pedido não deve ser informado esses campos.

Exemplo layout ODBC

select	
'CODGPedido0202' as CodigoPedido,
'Parametrizacao' as NomeParametrizacaoCategoria,
'CDGsgPRM001' as CodSGParamCategoria,
'NomeCategoria' as NomeCategoria,
'Identificador Interno' as IdentificadorInterno

Associar Pedido Divisor Limite

Campo	Descrição	Tipo	Tam.	Informações	Obrigatório
CodigoPedido	Código do pedido	String	30		Sim
CSGDivisorLimite	Código sistema de gestão do divisor limite	String	50		Não
ValorDivisorLimite	Valor do divisor de limite	Decimal			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 pedido	Não
IdentificadorInterno	Identificador interno	String		Identificador enviado pelo cliente para ser utilizado no retorno de integrações	Não

Atenção

Os campos CSGDivisorLimite e ValorDivisorLimite são obrigatórios somente na associação de divisor de limite, onde o campo Desassociar deve estar preenchido com a flag "S".

Para a associação do divisor de limite com o pedido, o divisor deve estar parametrizado para a origem do pedido.

Exemplo layout ODBC

select	!!novo
'CODGPedido0202' as CodigoPedido,
'CDGsgDIVL02021' as CSGDivisorLimite,
'10' as ValorDivisorLimite,
'S' as Desassociar,
'Identificador Interno' as IdentificadorInterno

Desassociar Parametrização Categoria Pedido

Campo	Descrição	Tipo	Tam.	Informações	Obrigatório
CodigoPedido	Código do pedido	String	30		Sim
CsgParamCategoria	Código do 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	50	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

Exemplo layout ODBC

select	
'CODG55455' as CodigoPedido,
'CDG44545' as CsgParamCategoria,
'Categoria de Parametrização de categoria' as NomeCategoria,
'Identificador Interno' as IdentificadorInterno

Associar Pedido Motivo

Campo	Descrição	Tipo	Tam.	Informações	Obrigatório
CodigoPedido	Código do pedido	String	30		Sim
NomeMotivo	Nome do motivo	String	50		Nome ou código sistema de gestão deve ser obrigatório
CodigoSistemaGestaoMotivo	Código do sistema de gestão do motivo	Int			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

Exemplo layout ODBC

select	
'Codg001010' as CodigoPedido,
'Motivo' as NomeMotivo,
'CDGSG0001' as CodigoSistemaGestaoMotivo,
'Identificador Interno' as IdentificadorInterno

Desassociar Motivo Pedido

Campo	Descrição	Tipo	Tam.	Informações	Obrigatório
CodigoPedido	Código do pedido	String	30		Sim
CsgMotivo	Código do sistema de gestão motivo	String	15	Código de sistema de gestão. Caso seja informado, remove apenas os motivos dos pedidos informados	Não
IdentificadorInterno	Identificador interno	String		Identificador enviado pelo cliente para ser utilizado no retorno de integrações	Não

Exemplo layout ODBC

select	
'CDGP77777' as CodigoPedido,
'CDGsg6565' as CsgMotivo,
'Identificador Interno' as IdentificadorInterno

Associar Pedido Item Produto

Campo	Descrição	Tipo	Tam.	Informações	Obrigatório
CodigoPedido	Código do pedido	String	30	Código do pedido	Sim
NomeItemProduto	Nome do item de produto	String	100	Nome do item de produto	Não
Quantidade	Quantidade do item do produto	String	30	Quantidade do item do produto	Não
IdentificadorInterno	Identificador interno	String		Identificador enviado pelo cliente para ser utilizado no retorno de integrações	Não
CodigoSGItemProduto	Código do sistema de gestão do item de produto	String	50	Código do sistema de gestão do item de produto	Sim
CodigoSGGrupoProduto	Código do sistema de gestão do grupo de produto	String	50	Código do sistema de gestão do grupo de produto	Sim

Exemplo layout ODBC

select	
'CDG44141' as CodigoPedido,
'ITEM PRODUTO' as NomeItemProduto,
'2' as Quantidade,
'Identificador Interno' as IdentificadorInterno,
'CDGsgITEM999' as CodigoSGItemProduto,
'CSGgp' as CodigoSGGrupoProduto

Associar Pedido Endereço

Campo	Descrição	Tipo	Tam.	Informações	Obrigatório
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
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.	Não
Apelido	Nome ou descrição associada a endereço de entrega	String	200		Sim
IdentificadorInterno	Identificador interno	String		Identificador enviado pelo cliente para ser utilizado no retorno de integrações	Não

Exemplo layout ODBC

SELECT 
'Codigo do pedido' as CodigoPedido,
'Criciuma' as NomeCidade,
'SC' as UF,
'Alvaro Luiz' as Rua,
'Centro' as Bairro,
'88888888' as CEP,
'10' as Numero,
'Complemente do endereco' as Complemento,
'Nome endereco de pedido' as Apelido,
'Identificador Interno' as IdentificadorInterno

Desassociar Pedido Endereço

Campo	Descrição	Tipo	Tam.	Informações	Obrigatório
CodigoPedido	Código interno do pedido no DepsNet	String	30		Sim
Apelido	Nome ou descrição associada a endereço de entrega	String	200		Sim
IdentificadorInterno	Identificador interno	String		Identificador enviado pelo cliente para ser utilizado no retorno de integrações	Não

Exemplo layout ODBC

SELECT 
'Codigo do pedido' as CodigoPedido,
'Nome endereco de pedido' as Apelido,
'Identificador Interno' as IdentificadorInterno

Associar Pedido Cliente Relacionado

Campo	Descrição	Tipo	Tam.	Informações	Obrigatório
CodigoPedido	Código interno do pedido no DepsNet	String	30		Sim
Desassociar	Flag "S" ou vazio.	String	1	Para desassociar o cliente relacionado do pedido 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
Documento	Documento do cliente	String	15	CNPJ, CPF ou Código identificador exportação	Sim
Origem	Nome da origem do cliente	String	40		Sim
TipoCliente	Tipo pessoa do cliente.	String	1	J - Jurídica F - Física E - Exportação	Sim
TipoRelacao	Tipo da relação entre cliente e pedido.	String	1	COB - Cobrança AVA - Avalista	Sim
IdentificadorInterno	Identificador interno	String		Identificador enviado pelo cliente para ser utilizado no retorno de integrações	Não

Exemplo layout ODBC

SELECT 
'PED_ORDER_01' AS codigoPedido, 
'' AS desassociar,
'00011100095' AS documento,
'Sistema de gestão' AS origem,
'J' AS tipoCliente,
'AVA' AS tipoRelacao,
'Identificador Interno' as IdentificadorInterno

Cadastrar Informação Complementar Pedido

Campo	Descrição	Tipo	Tam.	Informações	Obrigatório
CodigoPedido	Código interno do pedido no DepsNet	String	30		Sim
DataCadastro	Data de cadastro da informação complementar	DateTime	Formato: dd/MM/yyyy		Sim
Complemento	Informação complementar a ser associada com o pedido	String	8000		Sim
IdentificadorInterno	Identificador interno	String		Identificador enviado pelo cliente para ser utilizado no retorno de integrações	Não

Exemplo layout ODBC

select
'CDGPedido001222' as CodigoPedido,
'20/04/2017' as DataCadastro,
'Informação complementar de pedido' as Complemento
'Identificador Interno' as IdentificadorInterno

Associar Pedido Forma Pagamento

Campo	Descrição	Tipo	Tam.	Informações	Obrigatório
Desassociar	Flag "S" ou vazio.	String	1	Para desassociar uma condição de pagamento do pedido deve ser enviado “S”. Se enviado o campo “documento” e o campo “formaPagamento” em branco, serão desassociadas todas as condições de pagamento do pedido. Se enviado o campo “documento” em branco, mas o campo “formaPagamento” preenchido, serão desassociadas todas as condições de pagamento da forma enviada. Caso contrário esse campo deve ser enviado em branco. Obs.: Qualquer informação diferente de “S” para esse campo, o mesmo será considerado como um cadastro no DepsNet. Obs.: Ao desassociar, as parcelas relacionadas a forma de pagamento serão excluídas.	Não
CodigoPedido	Código interno do pedido no DepsNet	String	30		Sim
FormaPagamento	Código sistema de gestão da forma de pagamento	String	50	Caso seja informada uma forma desconhecida durante a associação no sistema, será cadastrada automaticamente uma nova forma de pagamento.	Sim
Documento	Identificador da forma de pagamento	String	50	Campo responsável por identificar pagamentos. Ex: Pedido pode ser pago com dois cartões de crédito, ou seja, duas condições de pagamento com a forma de pagamento ‘CRED’, porém com documento distintos, podendo ser o número do cartão usado como documento. Essa informação juntamente com o código do pedido compõem a chave de identificação no DepsNet.	Sim
StatusOperacao	Status da operação de pagamento	Int		0 - Não realizado 1 - Realizado	Sim
Observacao	Observação sobre a forma de pagamento	String	300		Não
IdentificadorInterno	Identificador interno	String		Identificador enviado pelo cliente para ser utilizado no retorno de integrações	Não

Exemplo layout ODBC

SELECT 
'' AS Desassociar,
'CODIGO_PED' AS CodigoPedido,
'PIX' AS FormaPagamento,
'Telefone 999555999' AS Documento,
'0' AS StatusOperacao,
'Comentario sobre a operacao' AS Observacao,
'Identificador Interno' AS IdentificadorInterno

Associar Pedido Parcela Forma Pagamento

Campo	Descrição	Tipo	Tam.	Informações	Obrigatório
Desassociar	Flag "S" ou vazio.	String	1	Para desassociar a parcela da forma de pagamento do pedido 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
CodigoPedido	Código interno do pedido no DepsNet	String	30		Sim
DocumentoFormaPagamento	Identificador da forma de pagamento	String	50	Campo responsável por identificar pagamentos, necessário para quando for utilizada a mesma forma de pagamento mais de uma vez em um único pedido.	Sim
IdentificadorParcela	Identificador da parcela da forma de pagamento	String	30	Campo responsável por identificar parcelas, necessário para alteração e desassociação de parcelas. Caso não informado durante uma desassociação, serão desassociados todas as parcelas da forma de pagamento selecionada.	Sim*
DataVencimento	Data de vencimento da parcela	DateTime	Formato: dd/MM/yyyy		Sim
Valor	Valor da parcela	Decimal			Sim
Observacao	Observação sobre a parcela	String	300		Não
IdentificadorInterno	Identificador interno	String		Identificador enviado pelo cliente para ser utilizado no retorno de integrações	Não

Exemplo layout ODBC

SELECT 
'CODIGO_PED' AS CodigoPedido,
'' AS Desassociar,
'Telefone 999555999' AS DocumentoFormaPagamento,
'P1' AS IdentificadorParcela,
'04/10/2021' AS DataVencimento,
'300,00' AS Valor,
'Parcela unica' AS Observacao,
'Identificador Interno' AS IdentificadorInterno