# Integração de pedidos
# Cadastrar motivo
Esse serviço tem objetivo de cadastrar os motivos, para posteriormente serem associada a situações de pedidos.
A interface do WebService pode ser consultada em: http://localhost:71/CadastroMotivo.svc (opens new window)
Método relacionado a este serviço: CadastrarMotivo DcMotivo
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
CodigoSistemaGestao | Código interno do sistema de gestão, mesmo código de onde o WebService é invocado. | String | 50 | Não |
Nome | Nome do motivo | String | 50 | Sim |
# Cadastrar situação
Esse serviço tem o objetivo de cadastrar as situações que serão associadas a pedidos. Além do cadastro, também existem o serviço para associação de motivos a situações.
A interface do WebService pode ser consultada em: http://localhost:71/CadastroSituacao.svc (opens new window)
Esse serviço está relacionado aos seguintes métodos:
- CadastrarSituacao (DcSituacao).
- AssociarSituacaoMotivo (DcSituacaoMotivo).
# Cadastrar situação
Método relacionado a este serviço: DcSituacao
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
Nome | Nome da situação de pedidos. Nome da situação não é obrigatório, mas é aconselhável que seja enviado. Caso não seja enviado, a visualização da situação será afetada, prejudicando a análise dos usuários. Sendo assim, sugerimos que não deixe de enviar esta informação, mesmo que seja igual ao campo CodigoSistemaGestao. | String | 50 | Sim* |
CodigoSistemaGestao | Código do sistema de gestão da situação do pedido. 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. | String | 50 | Sim* |
Condicao | Condição da situação: 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. | Int | 1 | Não |
Tipo | Tipo da situação: 1 - Aprovado 2 - Bloqueado 3 - Faturado 0 - Nenhum | Int | 1 | Não |
ContaAutomacao | 1 - Sim 0 - Não | Int | 1 | Não |
UtilizaAlcadaReanalise | 1 - Sim 0 - Não | Int | 1 | Não |
PermiteMultiplosMotivos | Permitir mais de um motivo, sendo: 0 - Não 1 - Sim | Int | 1 | Não |
ObrigatoriedadeMotivo | Obrigatoriedade de informar motivo, sendo: 0 - Sem obrigação 1 - Apenas motivo obrigatório 2 - Apenas informação complementar obrigatório 3 - Motivo ou informação complementar obrigatório | Int | 1 | Não |
# Associar situação motivo
Método relacionado a este serviço: DcSituacaoMotivo
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
NomeSituacao | Nome da situação | String | 50 | Sim |
NomeMotivo | Nome do motivo | String | 50 | Sim |
# Cadastrar categoria de pedido
Esse serviço tem o objetivo de cadastro de categorias de pedidos, que são dados associados a pedidos e que tem parametrizações.
A interface do WebService pode ser consultada em: http://localhost:71/CadastroCategoriaPedido.svc (opens new window)
Método relacionado a este serviço: CadastrarCategoriaPedido DcCategoriaPedido
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
NomeCategoriaPedido | Nome da categoria de pedido. | String | 50 | Sim |
# Cadastrar parametrização categoria de pedido
Esse serviço tem o objetivo de cadastrar as parametrizações das categorias.
A interface do WebService pode ser consultada em: http://localhost:71/CadastroParametrizacaoCategoriaPedido.svc (opens new window)
Método relacionado a este serviço: CadastrarParametrizacaoCategoriaPedido DcParametrizacaoCategoriaPedido
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
NomeCategoriaPedido | Nome da categoria de pedido. | String | 50 | Sim |
NomeParametrizacaoCategoriaPedido | Nome da parametrização da categoria de pedido | String | 50 | Sim |
CodigoSistemaGestao | Código interno do sistema de gestão da parametrização de categoria. Mesmo código de onde o WebService é invocado. | String | 50 | Não |
AprovadoAutomacao | Parametrização para definir se o pedido associado a parametrização pode ou não aprovar. 1 - Aprovado 0 - Não aprovado | Int | 1 | Não |
BloqueadoAutomacao | Parametrização para definir se o pedido associado a parametrização pode ou não bloquear. 1 - Bloqueia 0 - Não bloqueia | Int | 1 | Não |
Observação
As informações referentes aos campos: AprovadoAutomacao e 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.
# Cadastrar segmento produto
Esse serviço tem o objetivo de cadastrar o segmento de produto, está informação é associada a uma origem de informação cadastral.
A interface do WebService pode ser consultada em: http://localhost:71/CadastroSegmentoProduto.svc (opens new window)
Método relacionado a este serviço: CadastrarSegmentoProduto DcSegmentoProduto
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
NomeOrigem | Nome da origem deve ser o mesmo cadastrado no Sistema DepsNet. A origem é o nome do sistema de gestão de onde o WebService é invocado. | String | 40 | Sim |
CodigoSistemaGestao | Código interno do sistema de gestão do segmento, mesmo código de onde o WebService é invocado. | String | 15 | Não |
Nome | Nome do segmento de produto. | String | 50 | Sim |
# Cadastrar grupo produto
Esse serviço tem o objetivo de cadastrar o grupo de produto, está informação é associada a um segmento de produto.
A interface do WebService pode ser consultada em: http://localhost:71/CadastroGrupoProduto.svc (opens new window)
Método relacionado a este serviço: CadastrarGrupoProduto DcGrupoProduto
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
NomeSegmentoProduto | Nome do segmento de produto | String | 50 | Sim |
CodigoSistemaGestao | Código interno do sistema de gestão, mesmo código de onde o WebService é invocado. | String | 50 | Não |
Nome | Nome do grupo de produto | String | 50 | Sim |
# Cadastrar item produto
Esse serviço tem objetivo de cadastrar o item de produto, está informação é associada a um grupo de produto.
A interface do WebService pode ser consultada em: http://localhost:71/CadastroItemProduto.svc (opens new window)
Método relacionado a este serviço: CadastrarItemProduto DcItemProduto
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
CodigoSistemaGestaoGrupoProduto | Código interno do sistema de gestão do grupo produto, mesmo código de onde o WebService é invocado. | String | 50 | Sim |
CodigoSistemaGestao | Código interno do sistema de gestão, mesmo código de onde o WebService é invocado. | String | 50 | Sim |
Nome | Nome do item de produto. | String | 100 | Não |
# Cadastro de pedido
Esse serviço tem o objetivo de cadastro de pedidos no sistema, onde pedidos podem ter ou não a criação de dados associados que são chamados de parametrização categoria de pedidos. Pode ser feita a associação de uma nova situação de um pedido, além de atribuir um ou mais motivos para esta associação. Ainda é possível a associação de itens de produto no pedido.
A interface do WebService pode ser consultada em: http://localhost:71/CadastroPedido.svc (opens new window)
Os métodos relacionados a este serviço são:
- CadastrarPedido (DcPedido).
- AssociarSituacaoPedido (DcPedidoSituacao)
- AssociarPedidoParametrizacaoCategoriaPedido (DcParametrizacaoCategoriaPedido)
- DesassociarParametrizacaoCategoriaPedido (DcDesassociarParamCategoriaPedido).
- AssociarMotivoSituacaoPedido (DcPedidoMotivoSituacao).
- DesassociarMotivoSituacaoPedido (DcDesassociarMotivoPedido).
- AssociarItemProdutoPedido (DcPedidoItemProduto).
# Cadastrar pedido
Método relacionado a este serviço: DcPedido
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
TipoCliente | Tipo do cliente: J - Jurídica F - Física E - Exportação | String | 1 | Sim |
DocumentoCliente | - Se o tipo do cliente for "J" então documento é CNPJ - Se o tipo do cliente for "F" então documento é CPF - Se o tipo da pessoa for "E" então documento é o que representa o cliente do tipo exportação | String | 15 | Sim |
NomeOrigemCliente | Nome da origem deve ser o mesmo cadastrado no Sistema DepsNet. A origem é o nome do sistema de gestão de onde o WebService é invocado. | String | 40 | Sim |
TipoRepresentante | Tipo do representante: J - Jurídica F - Física E - Exportação | String | 1 | Não |
DocumentoRepresentante | - Se o tipo do representante for "J" então documento é CNPJ - Se o tipo do representante for "F" então documento é CPF - Se o tipo do representante é "E" então documento é o que representa o cliente do tipo exportação | String | 15 | Não |
Codigo | Código do pedido para identificação no Sistema DepsNet. Código único, não podendo ser repetido. | String | 30 | Sim |
TipoPagamento | Campo que define a forma de como será pago o pedido. 0 - A prazo 1 - À vista 2 - Antecipado | Int | 1 | Não |
CodigoOriginal | Código ou número original do pedido. Pode ser entendido como código de prospecção do pedido ou número da ordem de pedido. | String | 30 | Sim |
CodigoPedido | Código ou número do pedido de identificação do pedido no Sistema de Gestão da organização. | String | 30 | Sim |
DataAtualizaSituacao | Data para definir a partir de que dia o pedido poderá ser analisado. | DateTime | Formato: dd/mm/aaaa | Não |
DataEmissao | Data de emissão do pedido | DateTime | Formato: dd/mm/aaaa | Sim |
DataFaturamento | Data prevista para o faturamento | DateTime | Formato: dd/mm/aaaa | Não |
DataPrimeiroVencimento | Data do primeiro vencimento do pedido ou data de Vencimento da primeira parcela do pedido. | DateTime | Formato: dd/mm/aaaa | Sim |
DiasEntreParcelas | Quantidade de dias entre as parcelas do pedido | Int | Não | |
Prazo | Faixas de prazo, que devem ser separadas por "/". Exemplo: 30/60/90. Quando não houver prazo ou pedido for avista, informar 000. | String | 150 | Não |
QuantidadeParcelas | Quantidade de parcelas do pedido | Int | Não | |
ValorBruto | Valor do pedido (bruto), considerando impostos, descontos, permitindo realizar projeção do faturamento. | Decimal | 18,2 | Não |
ValorEntrada | Valor já pago do pedido ou valor pago parcial, como uma entrada por exemplo. Esse dado deve ser enviado via integração de dados. | Decimal | 18,2 | Não |
ValorLiquido | Valor do pedido, considerando apenas os itens, sem impostos. | Decimal | 18,2 | Não |
ValorSaldo | Valor total dos itens não faturados e que demandam crédito. Valor que deve ser considerado para tomar limite de crédito. | Decimal | 18,2 | Não |
DataUltimaAnalise | Informação interna do DepsNet. Desconsiderar! | DateTime | Formato: dd/mm/aaaa | Não |
Solicitante | Solicitante do pedido | String | 90 | Não |
# Associar pedido situação
Método relacionado a este serviço: DcPedidoSituacao
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
CodigoPedido | Código do pedido. Informação referente ao campo: "Codigo" da integração de Pedidos. | String | 30 | Sim |
NomeSituacao | Nome da situação. | String | 50 | Não* |
CSGSituacao | Código sistema de gestão da situação. | String | 50 | Não* |
DataHoraInicioIntegracao | Data e hora de início da integração | DateTime | Não |
Observação
Para a associação de pedido com situação pode ser informado somente o código do sistema de gestão (CSGSituacao) ou o nome da situação (NomeSituacao). Anteriormente o nome da situação era utilizado como chave, mas após ajustes recentes passamos a utilizar o código sistema de gestão. Os clientes que já enviavam apenas o nome, não deverão ser afetados. Já os clientes novos, estes deverão enviar o código sistema de gestão, não sendo obrigatório enviar o nome.
# Associar pedido parametrização categoria
Método relacionado a este serviço: DcPedidoParametrizacaoCategoriaPedido
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
CodigoPedido | Código do pedido.Informação referente ao campo: "Codigo" da integração de Pedidos. | String | 30 | Sim |
NomeParametrizacaoCategoria | Nome da parametrização da categoria de pedido. | String | 100 | Não* |
CodigoSistemaGestaoParametriazacaoCategoriaPedido | Código do sistema de gestão da parametrização da categoria de pedido cadastrado no DepsNet. | String | 50 | Não* |
NomeCategoria | Nome da categoria do pedido. | String | 50 | Não |
Observação
Para a associação de um pedido com uma parametrização de categoria pode ser informado somente o código do sistema de gestão (CodSGParamCategoria) ou o nome da parametrização da categoria (NomeParametrizacaoCategoria).
Para desassociar todas as parametrizações de categoria do título não deve ser informado os campos NomeParametrizacaoCategoria e CodSGParamCategoria.
# Desassociar pedido parametrização categoria
Método relacionado a este serviço: DcDesassociarParamCategoriaPedidoCliente
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
CodigoPedido | Código do pedido.Informação referente ao campo: "Codigo" da integração de Pedidos. | String | 30 | Sim |
CodigoSistemaGestaoParamCategoria | Código de sistema de gestão. Caso seja informado, remove apenas a parametrização categoria informada. | String | 50 | Não |
NomeCategoria | Nome da Categoria. Caso seja informado, irá remover apenas as parametrizações de categoria da categoria informada. | String | 50 | Não |
# Associar pedido motivo
Método relacionado a este serviço: DcPedidoMotivoSituacao
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
CodigoPedido | Código do pedido.Informação referente ao campo: "Codigo" da integração de Pedidos. | String | 30 | Sim |
NomeMotivo | Nome do motivo. | String | 50 | Não* |
CodigoSistemaGestaoMotivo | Código do sistema de gestão do motivo. | String | 50 | Não* |
Observação
Para a associação de um pedido com motivo pode ser informado somente o código do sistema de gestão (CodigoSistemaGestaoMotivo) ou o nome do motivo (NomeMotivo).
# Desassiciar pedido motivo
Método relacionado a este serviço: DcDesassociarMotivoPedido
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
CodigoPedido | Código do pedido. Informação referente ao campo: "Codigo" da integração de Pedidos. | String | 30 | Sim |
codigoSistemaGestaoMotivo | Código de sistema de gestão do motivo. Caso não informado será removido todos os motivos associados ao pedido. | String | 50 | Não |
# Associar pedido item produto
Método relacionado a este serviço: DcPedidoItemProduto
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
CodigoPedido | Código do pedido. | String | 30 | Sim |
CodigoSistemaGestaoItemProduto | Código do sistema de gestão do item de produto. | String | 50 | Sim |
Quantidade | Quantidade do item do produto. | String | 30 | Não |
CodigoSistemaGestaoGrupoProduto | Código do sistema de gestão do grupo de produto. | String | 50 | Sim |
Para retorno dos dados: DataContractRetornoProcessamento
# Desassociar pedido item produto
Método relacionado a este serviço: DcDesassociarPedidoItemProduto
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
CodigoPedido | Código do pedido. | String | 30 | Sim |
CodigoSistemaGestaoItemProduto | Código do sistema de gestão do item de produto. | String | 50 | Sim |
CodigoSistemaGestaoGrupoProduto | Código do sistema de gestão do grupo de produto. | String | 50 | Sim |
Para retorno dos dados: DataContractRetornoProcessamento
# Associar pedido endereço
Método relacionado a este serviço: DcPedidoEndereco
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
CodigoPedido | Código do pedido. | String | 30 | Sim |
UF | Unidade Federativa - Se o tipo de cliente é "E" deve ser informado a sigla "EX". | String | 2 | Sim |
Cidade | Nome da Cidade. | String | 50 | Sim |
Rua | Nome da rua. | String | 200 | Não |
Bairro | Nome do bairro. | String | 100 | Não |
Cep | CEP da localidade. | String | 10 | Não |
Numero | Número. | String | 15 | Não |
Complemento | Complemento. | String | 80 | Não |
Confirmado | Confirmação de endereço de entrega. 0 – Não confirmado. 1 - Confirmado Obs.: Caso não seja informado ao adicionar um endereço, será considerado não confirmado. Caso o endereço já estiver cadastrado pro cliente e confirmado, o confirmado enviado na integração será desconsiderado. | String | 1 | Não* |
Apelido | Nome ou descrição associada a endereço de entrega. | String | 200 | Sim |
Para retorno dos dados: DataContractRetornoProcessamento
# Desassociar pedido endereço
Método relacionado a este serviço: DcDesassociarPedidoEndereco
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
CodigoPedido | Código do pedido. | String | 30 | Sim |
Apelido | Nome ou descrição associada a endereço de entrega. | String | 200 | Sim |
Para retorno dos dados: DataContractRetornoProcessamento
# Cadastro de informação complementar de pedido
Esse serviço tem o objetivo de cadastrar as informações complementares de pedido.
A interface do WebService pode ser consultada em: http://localhost:71/CadastroInformacaoComplementarPedido.svc (opens new window)
Método relacionado a este serviço: DcInformacaoComplementarPedido
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
CodigoPedido | Código interno do pedido no DepsNet | String | 30 | Sim |
DataCadastro | Data de cadastro da informação complementar do pedido | DateTime | Formato: dd/mm/aaaa | Sim |
Complemento | Informação complementar a ser associada ao pedido | String | 8000 | Sim |
Para retorno dos dados: DataContractRetornoProcessamento
# Associar Pedido Forma Pagamento
Método relacionado a este serviço: DcAssociarPedidoFormaPagamento
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
CodigoPedido | Código interno do pedido no DepsNet | String | 30 | Sim |
FormaPagamento | Código da forma de pagamento que será usada no pagamento. Caso seja informada uma forma desconhecida durante a associação no sistema, será cadastrada automaticamente uma nova forma de pagamento. | String | 50 | Sim |
Documento | Campo de identificação da forma de pagamento. 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 da condição no DepsNet. | String | 50 | Sim |
StatusOperacao | Status da operação de pagamento. 0 - Não realizado 1 - Realizado | Int | Sim | |
Observacao | Observação sobre a forma de pagamento | String | 300 | Não |
Para retorno dos dados: DataContractRetornoProcessamento
# Desassociar Pedido Forma Pagamento
Método relacionado a este serviço: DcDesassociarPedidoFormaPagamento
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
CodigoPedido | Código interno do pedido no DepsNet. | String | 30 | Sim |
FormaPagamento | Código sistema de gestão da forma de pagamento. Caso não informado a forma de pagamento, nem o campo documento, serão desassociadas todas as formas de pagamento do pedido. | String | 50 | Não |
Documento | Identificador da forma de pagamento. 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. Caso não informado, serão desassociadas todas as formas de pagamento do pedido que utilizam a forma de pagamento enviada. | String | 50 | Não |
Para retorno dos dados: DataContractRetornoProcessamento
Observação
Ao desassociar, as parcelas relacionadas a forma de pagamento serão excluídas.
# Associar Pedido Parcela Forma Pagamento
Método relacionado a este serviço: DcAssociarPedidoParcelaFormaPagamento
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
CodigoPedido | Código interno do pedido no DepsNet | String | 30 | Sim |
DocumentoFormaPagamento | Identificador da forma de pagamento. 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. | String | 50 | Sim |
IdentificadorParcela | Identificador da parcela da forma de pagamento. Campo responsável por identificar parcelas, necessário para alteração e desassociação de parcelas. | String | 30 | Sim |
DataVencimento | Data de vencimento da parcela | DateTime | Formato: yyyy-MM-ddThh:mm:ss | Sim |
Valor | Valor da parcela | Decimal | Sim | |
Observacao | Observação sobre a parcela | String | 300 | Não |
Para retorno dos dados: DataContractRetornoProcessamento
# Desassociar Pedido Parcela Forma Pagamento
Método relacionado a este serviço: DcDesassociarPedidoParcelaFormaPagamento
Campo | Descrição | Tipo | Tam. | Obr. |
---|---|---|---|---|
CodigoPedido | Código interno do pedido no DepsNet | String | 30 | Sim |
DocumentoFormaPagamento | Identificador da forma de pagamento. 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. | String | 50 | Sim |
IdentificadorParcela | Identificador da parcela da forma de pagamento. Campo responsável por identificar parcelas, necessário para alteração e desassociação de parcelas. Caso não informado, serão desassociadas todas as parcelas da forma de pagamento enviada. | String | 30 | Não |
Para retorno dos dados: DataContractRetornoProcessamento