Páginas filhas
  • Manual Operacional da Customização - Integração VTEX Orquestrador DN

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Nome do Cliente: Confederação Nacional da Indústria - SENAI/SESI


Objetivo
Este documento foi elaborado para orientar aos usuários - chave do SENAI DN sobre os requisitos e funcionalidades do Orquestrador, customização aplicada ao TOTVS Educacional (SGE) que atua na integração entre o PROTHEUS a API do Protheus (que é de gestão do SENAI DN) e a Plataforma VTEX. A partir da leitura dos dados das vendas/pedidos realizados pela plataforma VTEX, o Orquestrador envia as informações para as API 's do PROTHEUS SENAI DN retornando o status da integração à plataforma VTEX.


Público Alvo
Este manual é destinado aos colaboradores selecionados como usuários - chave para o Template Digital, SENAI DN.


Metodologia
Este material tem como base a visão prática e completa do Processo Customizado, da área Educacional através da Customização existente - FS008696 - Integração VTEX - Orquestrador.
A metodologia utilizada tem como ponto de partida o mapeamento completo do respectivo processo, relacionado com as interfaces no Sistema TOTVS Educacional (SGE). Sempre que houver alguma atividade a ser realizada no Sistema, as suas funcionalidades e rotinas serão explicadas com detalhe.

Aviso

Esse projeto não trata exportações para o PROTHEUS (integração nativa), mas sim, para uma API do PROTHEUS que é exclusiva e de gestão do SENAI DN.

Premissas
Informações
iconfalse

Toggle Cloak
Premissas

Cloak
Expandir
title

Liberação dos anexos customizados na árvore de perfil:

Os anexos da customização - Integração VTEX devem ser liberados nas permissões de perfil dos usuários para aparecerem nos seus respectivos lugares. Para mais detalhes de como liberar no perfil dos usuários acesse

o Manual

o Manual de Instalação de

Customizações na

Customizações na seção: Liberando Acesso aos Menus.

Image Removedexpand
Informações
icon
title
false

Toggle Cloak
Parâmetros da Customização

Cloak

A parametrização da customização da API

PROTHEUS

do PROTHEUS  deverá ser realizada de modo que sejam configurados

os parâmetros customizados para informação

as informações do endereço e dados de acesso para as API's do PROTHEUS

,

(SENAI DN).

Essa parametrização está disponível em: TOTVS Educacional | Customização l Orquestrador VTEX l Parâmetros.


Image Removed

Na interface, os parâmetros processam a autenticação BASIC nas API's de exportação do PROTHEUS, para os quais o usuário deverá efetuar as seguintes parametrizações:

  • Endereço Webservice PROTHEUS: Endereço do webservice utilizado para exportação de clientes, contas a receber e cancelamentos do PROTHEUS;
  • Token: Token de autenticação do webservice PROTHEUS;
  • Número máximo de tentativas de reenvio: Quantidade de vezes que um registro deve ser reenviado, em caso de erro.

Image Removedexpand

A consulta das API'S de pagamentos provenientes da plataforma VTEX identifica as informações referentes às inscrições associadas a vendas realizadas/canceladas (Escopo Informações Financeiras do VTEX - FS008537) para envio ao PROTHEUS SENAI DN.

Informações
icon
false
titleConsulta de Pedidos VTEX
Nota
titleImportante:

A tabela deverá também considerar os seguintes dados já existentes na plataforma VTEX:

  • CNAE;
  • Inscrição Municipal;
  • Aderiu ao Simples;
  • Inscrição Estadual.
Expandir
titleExportação de Clientes para PROTHEUS

A exportação de clientes que realizaram compras/pedidos através da plataforma VTEX para o PROTHEUS, é realizada a partir da interface customizada, que realiza a verificação de um cadastro do cliente pré-existente no PROTHEUS.
Identificado o cadastro de cliente, será aplicada a atualização a partir da mesma API (PUT). Já para um novo cliente, será criado um novo cadastro no PROTHEUS (POST).
A interface está disponível em: TOTVS Educacional l Customização l Orquestrador VTEX l Exportação de Dados para o PROTHEUS.

Image RemovedAs informações associadas ao cadastro de cliente enviadas ao PROTHEUS são:
  • Empresa: Código da empresa PROTHEUS - Valor fixo 01;
  • Filial: Código da filial - Valor fixo: 03DN0001;
  • CPF/CNPJ;
  • Tipo Pessoa: F - Pessoa física / J: Pessoa jurídica;
  • Nome Pessoa: Nome do responsável financeiro;
  • Inscrição Estadual: Pessoa física: Isento / Pessoa jurídica: Código de cadastro informado pelo cliente. Quando não preenchido: Isento;
  • Inscrição Municipal: Pessoa física: Isento / Pessoa jurídica: Código de cadastro informado pelo cliente. Quando não preenchido: Isento;
  • Endereço: Inclui Logradouro, complemento, CEP, bairro, estado, código e nome da cidade, DDI/DDD, telefone;
  • País: Valor fixo 105;
  • E-mail;
  • Simples Nacional: Pessoa física: Valor fixo 2 / Pessoa jurídica: 1 para optante e 2 para não optante;
  • Contribuinte ICMS: Pessoa física: Valor fixo 2 / Pessoa jurídica: Se possuir inscrição estadual - valor fixo 2, se não possuir inscrição estadual - envia vazio;
  • País: Valor fixo 01058;
  • Código CNAE: Quando informado pelo cliente, enviado conforme a máscara/formato: 9999-9/99. Quando não localizado na API PROTHEUS, será apresentado erro, registrado no monitor de LOG da integração.
Expandir
titleCliente Seller

A identificação de um cliente Seller (Pessoa jurídica) é realizada a partir da verificação do campo: Items->Seller no método de consulta pedido VTEX, considerando os tipos:

  • Cliente Não Seller: Campo items preenchido valor: 1, corresponde a Loja DN.
  • Cliente Seller: Campo items preenchido valor diferente de: 1, corresponde às Lojas DR's e Parceiros.

Tela VTEX com destaque do campo ITEMS
Assim, para cliente do tipo: Seller cujo CNPJ já se encontra cadastrado no PROTHEUS, não será aplicada nenhuma atualização ao PROTHEUS. Já para um cliente do tipo: Seller que não tenha o CNPJ localizado/cadastrado no PROTHEUS, será apresentada uma mensagem de erro, gravado no monitor de LOG da integração.
No entanto, quando identificado mais de um cadastro de cliente associado a um mesmo CPF/CNPJ o processos executará as validações:

  • Identificação do código de cliente: Será utilizado para consulta o método Clientes, com o verbo HTTP GET, e considerado o campo A1_CGC para análise do código do cliente (conforme documentação de API disponibilizada pelo SENAI DN);
  • Venda realizada na Loja DN: Será considerado o cadastro que NÃO contém letras no seu código de cliente;
  • Venda realizada na Loja dos Sellers (DR's/Parceiros): Será considerado o cadastro que contém letras no seu código de cliente.
Aviso
titleObservação:

A customização irá verificar os itens do pedido, visto que, podem existir clientes diferentes para cada item de um mesmo pedido. O item do pedido não tem relação somente com o produto comprado, mas também com o cliente tipo: Seller.

Toggle Cloak
Anexo Dados Bancários - Monitor de Vendas [Novo!]

Cloak

Foi disponibilizado um novo anexo para informar os dados bancários do cliente, a fim de facilitar o cadastramento deste como fornecedor no Protheus para a realização do estorno.

A Interface está disponível no menu: TOTVS Educacional | Sistema Indústria | Integração VTEX | Monitor de Vendas  | Anexo  | Dados bancários


Ao acessar a interface, será possível inserir os Dados Bancários do Fornecedor.

Os campos não serão de preenchimento obrigatório, porém, a partir do momento em que o usuário preencher um dos campos, eles se tornam de preenchimento obrigatório, exceto o Dígito da Agência.


Ao clicar no botão Salvar, uma mensagem aparecerá informando que o envio do Fornecedor ao Protheus foi iniciado.

Informações
iconfalse

Toggle Cloak
Consulta de Pedidos VTEX

Cloak

O processo de consulta de pagamentos VTEX, identifica os dados associados aos pagamentos das vendas realizadas e/ou canceladas.  Os dados de Pedidos VTEX, enviados para a API PROTHEUS DN, serão consultados por este processo (Maiores detalhes sobre o processo, cliquei aqui), mas será acrescentados a consulta dos campos abaixo:

  • CNAE;
  • Inscrição Municipal;
  • Aderiu ao Simples;
  • Inscrição Estadual.
Informações
iconfalse

Toggle Cloak
Exportação de Clientes

Cloak

Após consulta dos Pedidos (conforme citado no item anterior), é realizada a exportação para a API PROTHEUS DN. Esse processo exporta todos os dados consultados, realizando primeiramente uma identificação de cadastro de cliente pré-existente no PROTHEUS.

  • Para clientes que já possuem cadastro no PROTHEUS, seu cadastro será atualizada caso necessário.
  • Para clientes que ainda não possuem cadastro, seu cadastro será criado no PROTHEUS.

Esse processo pode ser agendado ou executado de forma manual através do Menu: TOTVS Educacional l Customização l Orquestrador VTEX l Exportação de Dados para o PROTHEUS.

As informações associadas ao cadastro de cliente enviadas ao PROTHEUS são:

Campo Protheus CampoObservações
EmpresaEmpresaCódigo da empresa PROTHEUS - Valor fixo 01
FilialFilialCódigo da filial - Valor fixo: 03DN0001
CPFCNPJCPF/CNPJCPF/CNPJ do cliente
A1_PESSOATipo PessoaF - Pessoa física / J: Pessoa jurídica
A1_NOMENome PessoaNome do responsável financeiro
A1_INSCRInscrição EstadualPessoa física: Isento / Pessoa jurídica: Código de cadastro informado pelo cliente. Quando não preenchido: Isento
A1_INSCRMInscrição MunicipalPessoa física: Isento / Pessoa jurídica: Código de cadastro informado pelo cliente. Quando não preenchido: Isento;
A1_ENDEndereçoLogradouro do residência do cliente
A1_COMPLEMComplementoComplemento do residência do cliente
A1_CEPCEPCEP do cliente
A1_BAIRROBairroBairro do cliente
A1_ESTEstadoEstado do cliente
A1_COD_MUNCódigo do MunicípioCódigo do Município do cliente 
A1_MUNMunicípioMunicípio do cliente
A1_DDIDDIDDI do cliente
A1_DDDDDDDDD do cliente
A1_TELTelefoneTelefone do cliente
A1_PAISCódigo do PaísCódigo do país do cliente - Valor fixo 105
A1_EMAILE-mailE-mail do cliente
A1_SIMPNACSimples NacionalPessoa física: Valor fixo 2 / Pessoa jurídica: 1 para optante e 2 para não optante;
A1_CONTRIBContribuinte ICMSPessoa física: Valor fixo 2 / Pessoa jurídica: Se possuir inscrição estadual - valor fixo 2, se não possuir inscrição estadual - envia vazio;
A1_CNAECódigo CNAEQuando informado pelo cliente, enviado conforme a máscara/formato: 9999-9/99. Quando não localizado no PROTHEUS, será apresentado erro, registrado no monitor de LOG da integração.
Cliente Seller

A identificação de um cliente Seller (Pessoa jurídica) é realizada a partir da verificação do campo: Nome do Seller no cadastro do Item do pedido no Monitor de Vendas.

  • Cliente Não Seller: Corresponde a Loja Principal DN.
  • Cliente Seller: Corresponde às Lojas DR's e Parceiros.

Para cliente do tipo: Seller cujo CNPJ já se encontra cadastrado no PROTHEUS, não será aplicada nenhuma atualização ao PROTHEUS.  Já para um cliente do tipo: Seller que não tenha o CNPJ localizado/cadastrado no PROTHEUS, será apresentada uma mensagem de erro, gravado no monitor de LOG da integração.


Quando identificado mais de um cadastro de cliente associado a um mesmo CPF/CNPJ o processos executará as validações:

  • Identificação do código de cliente;
  • Venda realizada na Loja DN;
  • Venda realizada na Loja dos Sellers (DR's/Parceiros).


A customização verifica os itens do pedido, visto que, podem existir clientes diferentes para cada item de um mesmo pedido. O item do pedido não tem relação somente com o produto comprado, mas também com o cliente tipo: Seller.

A identificação de contas a receber provenientes de vendas/pedidos de clientes tipo Seller, é realizada a partir da verificação do código apropriado no campo Items, no método de consulta pedido VTEX.

  • Cliente Seller: Campo items preenchido valor diferente de: 1, corresponde às Lojas DR's e Parceiros.

Observação: Clientes do tipo Não Seller terão o campo items preenchido valor: 1, correspondente a Loja DN, não sendo portanto considerados na relação de conta a receber seller.
Desta forma, quando identificado um pedido/venda associada a um cliente do tipo seller, os mesmos serão agrupados por cliente e será verificado o código do cliente (A1_COD) registrado na API do PROTHEUS a partir do envio do CNPJ registrado no campo: CSCIdentification da plataforma VTEX e consultado através da API Get Seller by ID.
A seguir, apresentamos os exemplos:
Exemplo 1:
Pedido Id: 122550
Valor: R$ 300,00
Itens do Pedido:

  • Curso A: Valor R$ 100,00 - Comissão: R$ 10,00 - Seller: SENAI Bahia
  • Curso B: Valor R$ 100,00 - Loja Principal DN
  • Curso C: Valor R$ 100,00 - Comissão: R$ 10,00 - Seller: SENAI Bahia

Verificados os itens do pedido, serão enviadas ao PROTHEUS duas contas a receber, conforme:

  • Conta a receber 01: Correspondente ao cliente SENAI Bahia - Valor R$ 20,00
  • Conta a receber 02: Com cliente Loja Principal DN - Valor R$ 100,00
Exemplo 2:
Pedido Id: 122551
Valor: R$ 400,00
Itens do Pedido:
  • Curso A: Valor R$ 100,00 - Comissão: R$ 10,00 - Seller: SENAI Bahia
  • Curso B: Valor R$ 100,00 - Loja Principal DN
  • Curso C: Valor R$ 100,00 - Comissão: R$ 10,00 - Seller: SENAI Bahia
  • Curso D: Valor R$ 100,00 - Comissão: R$ 10,00 - Seller : SENAI Acre
  • Curso C: Valor R$ 100,00 - Comissão: R$ 10,00 - Seller: SENAI Bahia

Verificados os itens do pedido, serão enviadas ao PROTHEUS três contas a receber, conforme:

  • Conta a receber 01: Correspondente ao cliente SENAI Bahia - Valor: R$ 20,00
  • Conta a receber 02: Correspondente ao cliente SENAI Acre - Valor: R$ 10,00
  • Conta a receber 03: Correspondente ao cliente Loja Principal DN - Valor: R$ 100,00
Contas a Receber Seller - Cálculo da Comissão
O cálculo do valor correspondente a comissão a partir das vendas/pedidos de clientes do tipo Seller, é realizado considerando:
Valor do percentual da comissão (Campo items: Commission) x o Valor do Item (Campo items: sellingPrice).
Assim, conforme o exemplo, temos:
Pedido Id: 122552
Valor: R$ 100,00
Comissão: 10%
Itens do Pedido:
  • Curso A: Valor R$ 100,00

Total Comissão Seller SENAI Bahia: R$ 10,00
Importante: Este será o valor enviado apenas para itens vendidos por Seller no campo: E1_VALOR dividido pelo número de parcelas.
Caso o pagamento tenha sido parcelado, os valores serão enviados divididos pelo número de parcelas do pagamento do Pedido.
Pedido Id: 122552
Valor: R$ 300,00
Parcelamento: 02 Parcelas
Itens do Pedido:

Informações
iconfalse

Toggle Cloak
Exportação de Contas a Receber

Cloak

O processo de exportação de contas a receber envia os valores pagos no VTEX para API do PROTHEUS (SENAI DN).  Enviando as informações financeiras associadas aos pedidos realizados na plataforma VTEX, que estejam com status: Pronto para manuseio.

O usuário deve utilizar o mesmo processo de exportação de cliente, uma vez que não será possível enviar clientes e contas a receber separadamente.


Neste processo serão enviados os dados da transação, valores e parcelas que compõem o pedido de acordo com a forma de pagamento:

  • Número do Cartão: Quando utilizado os métodos de pagamento CC - Cartão de Crédito ou CD - Cartão de Débito;
  • Código da Autorização: Quando utilizado os métodos de pagamento CC - Cartão de Crédito ou CD - Cartão de Débito;
  • NSU: Quando utilizado os métodos de pagamento CC - Cartão de Crédito ou CD - Cartão de Débito;
  • Nosso Número: Quando utilizado o método de pagamento
Expandir
titleExportação de Contas a Receber para PROTHEUS

O processo de exportação de contas a receber para o PROTHEUS envia as informações financeiras associadas aos pedidos realizados na plataforma VTEX, com status: "ready-for-handling (Pronto para manuseio)".

Image RemovedA partir da verificação do Item de Pedido, a customização irá identificar os itens pagos no mesmo para envio a API, através do método de recebimentos (HTTP POST), onde serão enviados os dados da transação, valores e parcelas que compõem o pedido, tais como:
  • Empresa: Código da empresa PROTHEUS - Valor fixo 01;
  • Filial: Código da filial - Valor fixo: 03DN0001;
  • Data da Venda do Pedido;
  • Forma de Pagamento: CC - Cartão de Crédito / CD - Cartão de Débito / BOL - Boleto / PIX - Pagamento via PIX;
  • ID VTEX: Código OrderID do pedido;
  • Código do Cliente;
  • Loja do Cliente;
  • Pedido de Venda: Vazio;
  • Número do Cartão: Quando utilizado os métodos de pagamento CC - Cartão de Crédito ou CD - Cartão de Débito;
  • Código da Autorização: Quando utilizado os métodos de pagamento CC - Cartão de Crédito ou CD - Cartão de Débito;
  • NSU: Quando utilizado os métodos de pagamento CC - Cartão de Crédito ou CD - Cartão de Débito;
  • Nosso Número: Quando utilizado o método de pagamento
    • BOL - Boleto Bancário;
    • Código da Linha Digitável do Boleto Gerado: Quando utilizado o método de pagamento BOL - Boleto Bancário;
    • Código TXID Transação PIX: Quando utilizado o método de pagamento PIX - Pagamento via PIX;
    • Valor: Valor de cada parcela do pedido.
    Expandir
    titleContas a Receber Seller


    contasReceberdebitoCartão de Débito

    Dados utilizados pela integração quando a forma de pagamento é por cartão de débito:

    Campo ProtheusO que envia?Observações
    EmpresaEmpresaCódigo da empresa PROTHEUS - Valor fixo 01
    FilialFilialCódigo da filial - Valor fixo: 03DN0001
    Data_VendaData da Venda do PedidoData da Venda do Pedido
    E1_XFORMPGForma de PagamentoCC - Cartão de Crédito / CD - Cartão de Débito / BOL - Boleto / PIX - Pagamento via PIX
    E1_XIDVTEXOrderID VTEXCódigo do pedido no VTEX
    E1_CLIENTECódigo do ClienteCódigo do Cliente
    E1_LOJALoja do ClienteLoja do Cliente
    E1_XCLIORICódigo do Seller no ProtheusCódigo cliente DR ou Parceiro - Para DN envia vazio
    E1_XLJORIGLoja do Seller no ProtheusLoja DR ou Parceiro - Para DN envia vazio
    E1_XCOMISValor da Comissão (repasse)Valor da Comissão (repasse) - Para DN envia 0.00
    E1_PEDIDOPedido de VendaPedido de Venda
    E1_CARTAONúmero do CartãoNumero do cartão de crédito ou cartão de débito
    E1_CARTAUTCódigo da AutorizaçãoCódigo de autorização do cartão 
    E1_NSUETFNSUNSU do cartão
    E1_XVLRDRValor total da Venda SellerValor total da Venda Seller - Caso seja DN envia 0.00
    E1_XQPARDRQuantidade de Parcelas Venda DRQuantidade de Parcelas Venda DR - Caso seja DN envia 0
    parcelas (E1_VALOR)ParcelasValor de cada parcela do pedido
    creditoCartão de Crédito

    Dados utilizados pela integração quando a forma de pagamento é por cartão de crédito:

    Campo ProtheusO que envia?Observações
    EmpresaEmpresaCódigo da empresa PROTHEUS - Valor fixo 01
    FilialFilialCódigo da filial - Valor fixo: 03DN0001
    Data_VendaData da Venda do PedidoData da Venda do Pedido
    E1_XFORMPGForma de PagamentoCC - Cartão de Crédito / CD - Cartão de Débito / BOL - Boleto / PIX - Pagamento via PIX
    E1_XIDVTEXOrderID VTEXCódigo do pedido no VTEX
    E1_CLIENTECódigo do ClienteCódigo do Cliente
    E1_LOJALoja do ClienteLoja do Cliente
    E1_XCLIORICódigo do Seller no ProtheusCódigo cliente DR ou Parceiro - Para DN envia vazio
    E1_XLJORIGLoja do Seller no ProtheusLoja DR ou Parceiro - Para DN envia vazio
    E1_XCOMISValor da Comissão (repasse)Valor da Comissão (repasse) - Para DN envia 0.00
    E1_PEDIDOPedido de VendaPedido de Venda
    E1_CARTAONúmero do CartãoNumero do cartão de crédito ou cartão de débito
    E1_XVLRDRValor total da Venda SellerValor total da Venda Seller - Caso seja DN envia 0.00
    E1_XQPARDRQuantidade de Parcelas Venda DRQuantidade de Parcelas Venda DR - Caso seja DN envia 0
    parcelas (E1_VALOR)ParcelasValor de cada parcela do pedido
    boletoBoleto

    Dados utilizados pela integração quando a forma de pagamento é por boleto:

    Campo ProtheusO que envia?Observações
    EmpresaEmpresaCódigo da empresa PROTHEUS - Valor fixo 01
    FilialFilialCódigo da filial - Valor fixo: 03DN0001
    Data_VendaData da Venda do PedidoData da Venda do Pedido
    E1_XFORMPGForma de PagamentoCC - Cartão de Crédito / CD - Cartão de Débito / BOL - Boleto / PIX - Pagamento via PIX
    E1_XIDVTEXOrderID VTEXCódigo do pedido no VTEX
    E1_CLIENTECódigo do ClienteCódigo do Cliente
    E1_LOJALoja do ClienteLoja do Cliente
    E1_XCLIORICódigo do Seller no ProtheusCódigo cliente DR ou Parceiro - Para DN envia vazio
    E1_XLJORIGLoja do Seller no ProtheusLoja DR ou Parceiro - Para DN envia vazio
    E1_XCOMISValor da Comissão (repasse)Valor da Comissão (repasse) - Para DN envia 0.00
    E1_PEDIDOPedido de VendaPedido de Venda
    E1_XIDTRANCódigo da TransaçãoCódigo da Transação
    E1_NUMBCO Nosso Número BoletoNosso Número Boleto
    E1_CODDIGCódigo da Linha Digitável do Boleto GeradoCódigo da Linha Digitável do Boleto Gerado
    E1_XVLRDRValor total da Venda SellerValor total da Venda Seller - Caso seja DN envia 0.00
    E1_XQPARDRQuantidade de Parcelas Venda DRQuantidade de Parcelas Venda DR - Caso seja DN envia 0
    parcelas (E1_VALOR)ParcelasValor de cada parcela do pedido
    pixPix

    Dados utilizados pela integração quando a forma de pagamento é por PIX:

    Campo ProtheusO que envia?Observações
    EmpresaEmpresaCódigo da empresa PROTHEUS - Valor fixo 01
    FilialFilialCódigo da filial - Valor fixo: 03DN0001
    Data_VendaData da Venda do PedidoData da Venda do Pedido
    E1_XFORMPGForma de PagamentoCC - Cartão de Crédito / CD - Cartão de Débito / BOL - Boleto / PIX - Pagamento via PIX
    E1_XIDVTEXOrderID VTEXCódigo do pedido no VTEX
    E1_CLIENTECódigo do ClienteCódigo do Cliente
    E1_LOJALoja do ClienteLoja do Cliente
    E1_XCLIORICódigo do Seller no ProtheusCódigo cliente DR ou Parceiro - Para DN envia vazio
    E1_XLJORIGLoja do Seller no ProtheusLoja DR ou Parceiro - Para DN envia vazio
    E1_XCOMISValor da Comissão (repasse)Valor da Comissão (repasse) - Para DN envia 0.00
    E1_PEDIDOPedido de VendaPedido de Venda
    E1_XIDTRANCódigo da TransaçãoCódigo da Transação
    E1_XTXIDCódigo TXID Transação PIXCódigo TXID Transação PIX
    E1_XDTHRPXData VendaData Hora do Pix
    E1_XVLRDRValor total da Venda SellerValor total da Venda Seller - Caso seja DN envia 0.00
    E1_XQPARDRQuantidade de Parcelas Venda DRQuantidade de Parcelas Venda DR - Caso seja DN envia 0
    parcelas (E1_VALOR)ParcelasValor de cada parcela do pedido
    Informações
    iconfalse

    Toggle Cloak
    Exportação de Contas a Receber Seller

    Cloak

    A identificação de um cliente Seller (Pessoa jurídica) é realizada a partir da verificação do campo: Nome do Seller no cadastro do Item do pedido no Monitor de Vendas, conforme citado anteriormente.

    GreenExemplo

    Pedido Id: 122550
    Valor Total do Pedido: R$ 300,00
    Itens do Pedido:

    • Curso A: Valor R$ 100,00 - Seller: SENAI Bahia - Comissão*: R$ 10,00
    • Curso B: Valor R$ 100,00 - Loja Principal DN
    • Curso C: Valor R$ 100,00 - Seller: SENAI Bahia - Comissão: R$ 10,00

    Verificados os itens do pedido, serão enviadas ao PROTHEUS duas contas a receber, conforme:

    • Conta a receber 01: Com ao cliente SENAI Bahia - Valor R$ 20,00
    • Conta a receber 02: Com cliente que realizou a compra na Loja Principal DN - Valor R$ 100,00


     Yellow*Comissão

    O cálculo do valor correspondente a comissão a partir das vendas/pedidos de clientes do tipo Seller, é realizado considerando:
    Valor do percentual da comissão x o Valor do Item .

    Este será o valor enviado apenas para itens vendidos por Seller, dividido pelo número de parcelas. Caso o pagamento tenha sido parcelado, os valores serão enviados divididos pelo número de parcelas do pagamento do Pedido.

     

    Pedido Id: 122552
    Valor: R$ 100,00
    Comissão: 10%
    Itens do Pedido:

    • Curso A: Valor R$ 100,00

    Total Comissão Seller SENAI Bahia: R$ 10,00
    Pedido Id: 122552
    Valor: R$ 300,00
    Parcelamento: 02 Parcelas
    Itens do Pedido:

    • Curso A: Valor R$ 100,00 - Comissão: R$ 10,00 - Seller: SENAI Bahia
    • Curso B: Valor R$ 100,00 - Loja Principal DN
    • Curso C: Valor R$ 100,00 - Comissão: R$ 10,00 - Seller: SENAI Bahia

    Verificados os itens do pedido dividido em 2X, serão enviadas ao PROTHEUS duas contas a receber, conforme:

    • Conta a receber 01: Correspondente ao cliente SENAI Bahia - Valor R$ 20,00

    02 parcelas de R$10,00 (cada).

    • Conta a receber 02: Correspondente ao cliente Loja Principal DN - Valor R$ 100,00

    02 parcelas de R$50,00 (cada).

    Pagamentos por PIX ou Boleto

    Durante o processo de envio de Contas a receber, quando identificado que um pedido é da modalidade de pagamento pix ou boleto,  a customização consultará o valor do repasse do Monitor de Vendas. Não será realizada a soma do repasse de cada item

    Informações
    iconfalse

    Toggle Cloak
    Exportação de Fornecedor [Novo!]

    Cloak

    O processo de Exportação ao Protheus 

    Após salvar os dados do anexo Dados Bancários, é realizada a exportação do Fornecedor para a API PROTHEUS DN. Esse processo exporta todos os dados consultados, realizando primeiramente uma identificação de cadastro de fornecedor pré-existente no PROTHEUS.

    • Para fornecedores que já possuem cadastro no PROTHEUS, seu cadastro será atualizada caso necessário.
    • Para fornecedores que ainda não possuem cadastro, seu cadastro será criado no PROTHEUS.

    Esse processo pode ser executado de forma manual através do Menu: TOTVS Educacional | Sistema Indústria | Integração VTEX | Monitor de Vendas  | Anexo  | Dados bancários

    Assim que os dados forem salvos, será gerado um Job para realizar a exportação para a API PROTHEUS DN.

    As informações associadas ao cadastro de fornecedor enviadas ao PROTHEUS são:

    Campo Protheus CampoObservações
    EmpresaEmpresaCódigo da empresa PROTHEUS - Valor fixo 01
    FilialFilialCódigo da filial - Valor fixo: 03DN0001
    CPFCNPJCPF/CNPJCPF/CNPJ do Fornecedor
    A2_TIPOTipo PessoaF - Pessoa física / J: Pessoa jurídica
    A2_NOMENome PessoaNome do Fornecedor
    A2_INSCRInscrição EstadualPessoa física: Isento / Pessoa jurídica: Código de cadastro informado pelo fornecedor. Quando não preenchido: Isento
    A2_INSCRMInscrição MunicipalPessoa física: vazio / Pessoa jurídica: Código de cadastro informado pelo fornecedor.
    A2_ENDEndereçoLogradouro do residência do fornecedor
    A2_COMPComplementoComplemento do residência do fornecedor
    A2_CEPCEPCEP do fornecedor
    A2_BAIRROBairroBairro do fornecedor
    A2_ESTEstadoEstado do fornecedor
    A2_COD_MUNCódigo do MunicípioCódigo do Município do fornecedor
    A2_MUNMunicípioMunicípio do fornecedor
    A2_DDIDDIDDI do fornecedor
    A2_DDDDDDDDD do fornecedor
    A2_TELTelefoneTelefone do fornecedor
    A2_PAISCódigo do PaísCódigo do país do fornecedor - Valor fixo 105
    A2_EMAILE-mailE-mail do cliente
    A2_BANCOBancoBanco informado nos Dados Bancários
    A2_AGENCIAAgênciaAgencia informada nos Dados Bancários
    A2_XDVAGEDígito da AgenciaDígito da Agencia informado nos Dados Bancários
    A2_NUMCONContaConta informada nos Dados Bancários
    A2_XDVCTADígito da ContaDígito da Conta informado nos Dados Bancários
    A2_CNAECódigo CNAEQuando informado pelo fornecedor, enviado conforme a máscara/formato: 9999-9/99. Quando não localizado no PROTHEUS, será apresentado erro, registrado no monitor de LOG da integração.
    Informações
    iconfalse

    Toggle Cloak
    Exportação de Contas a Pagar

    Cloak

    O processo de consulta de pagamentos VTEX, identifica os dados associados aos pagamentos das vendas realizadas e/ou canceladas.  Os dados de Pedidos VTEX, enviados para o PROTHEUS, serão consultados por este processo (Maiores detalhes sobre o processo, cliquei aqui). 

    Sempre que o processo de consulta de pagamentos VTEX, identificar vendas com status cancelado é gerado um 'contas a pagar', conforme detalhado abaixo:

    Para pedidos Cancelados na VTEX:

    • Caso o pedido com status cancelado na VTEX, já possuir registro no Monitor de Vendas (já exportado para o PROTHEUS) será enviado os dados para inclusão de Pagamento no PROTHEUS.
    • Caso o pedido cancelado ainda não possua registro no Monitor de Vendas, primeiramente será feito a Exportação de Cliente para o PROTHEUS (descrito no menu acima) e posteriormente o envio dos dados para inclusão de Pagamento no Protheus.


    PIX e Boleto

    Para pedidos cancelados e que a forma de pagamento seja PIX ou Boleto, caso os dados bancários do Cliente não estejam preenchidos, não ocorrerá a exportação de contas a pagar.

    • A exportação de contas a pagar, considera a devolução total do valor do cancelamento.
    • Serão considerados tanto cancelamento feito diretamente na VTEX, quanto os realizados via SGE.
    • As regras de cancelamento, também se aplicam para os pedidos identificados como Cancelado Chargeback. (Para maiores informações Clique aqui).
    Informações
    iconfalse

    Toggle Cloak
    Movimentação do Pedido VTEX

    Cloak

    Sempre  que a exportação de contas a receber é enviada com Sucesso para a API PROTHEUS; é enviado automaticamente para plataforma VTEX, uma atualização para que o Pedido passe do status: Pronto para manuseio para Faturado.

    Essa atualização pode ser visualizada na tela do Monitor de Vendas, no campo Status Pedido:

    O campo Status Protheus, também exibido na tela do Monitor de Vendas, a cada tentativa de Integração do Pedido com o PROTHEUS, terá seu valor atualizando, considerando:

    • Não Integrado - indicando que o Pedido será exportando na próxima execução do processo de Integração
    • Integrado com Sucesso: Indicando que o pedido foi exportado com Sucesso para o PROTHEUS.
    • Integração com erro - Indicando que o podido não foi exportado, por algum erro/validação.

    Caso ocorra algum erro durante esse envio para plataforma VTEX, o usuário poderá consultar para que os ajustes necessários sejam providenciados.



    Informações
    iconfalse

    Toggle Cloak
    Monitor de Log

    Cloak

    O Monitor de Log, disponível em: TOTVS Educacional | Sistema Indústria | Orquestrador VTEX | Monitor de Log, armazena os dados exportados dos registros relacionados à Integração VTEX, possibilitando o acompanhamento e identificação dos registros exportados e importados com sucesso ou que necessitam ser reenviados.

    A funcionalidade é baseada em duas visões, sendo a primeira o valor de registro principal e a segunda (Item Log) representando os detalhes de cada situação do registro principal.

    Ao clicar sobre um registro de log, o usuário poderá consultar as demais informações complementares associadas ao registro, tais como:

    • Id Log: Identificador sequencial de Log;
    • Campos Chave: Descrição dos campos utilizados para gerar o registro integrado;
    • Valores Chave: Chave primária do registro integrado;
    • Status: Situação da Integração (Sucesso ou Erro);
    • Funcionalidade: Tipo de Processo que está sendo feito (Por exemplo: Exportação de Dados);
    • Data de Criação: Data de Criação do registro;
    • Data da última alteração: Data da última alteração do registro;
    • Número de tentativas de Reenvio: Quantidade de vezes que um registro já foi reenviado;
    • Criador por: Usuário responsável pela inclusão do registro;
    • Alterado Por: Usuário responsável pela alteração do registro;
    • Módulo: Orquestrador VTEX.

    No item de log terá disponível para consulta os seguintes campos:

    • Id. Item Log: Identificador sequencial de log.;
    • Id. Log: Identificador sequencial de log;
    • Mensagem: Mensagem com o status da integração do item;
    • Status: Situação da integração do item selecionado;
    • Dados Enviados: Relação dos dados enviados para integração;
    • Dados Recebidos: Relação dos dados recebidos;
    • Data de Criação: Data de criação do registro;
    • Data da Última Alteração: Data da última alteração do registro.


    Observação:

    Os registros apresentados no monitor de log leitura não poderão ser manipulados, ou seja, não será permitido ao usuário realizar alterações como inclusão, edição e exclusão.

    Para informações sobre Alteração Status Logs com Erro e o processo de Exclusão de Logs no monitor, acesse o Manual Operacional da Customização - LIB DN

    • Curso A: Valor R$ 100,00 - Comissão: R$ 10,00 - Seller: SENAI Bahia
    • Curso B: Valor R$ 100,00 - Loja Principal DN
    • Curso C: Valor R$ 100,00 - Comissão: R$ 10,00 - Seller: SENAI Bahia

    Verificados os itens do pedido dividido em 2X, serão enviadas ao PROTHEUS duas contas a receber, conforme:

    • Conta a receber 01: Correspondente ao cliente SENAI Bahia - Valor R$ 20,00

    02 parcelas de R$10,00 (cada).

    • Conta a receber 02: Correspondente ao cliente Loja Principal DN - Valor R$ 100,00

    02 parcelas de R$50,00 (cada).

    Através da consulta ao Monitor de Log, será possível consultar o status da movimentação do pedido.
    Verificado o envio com sucesso de contas a receber dos pedidos/vendas realizados na plataforma VTEX à API PROTHEUS, a customização retornará uma atualização à plataforma VTEX para que o pedido seja movimentado. A partir desta atualização, o pedido terá o status: Pronto para Manuseio alterado para: Faturado.

    Image Removed

    O Monitor de Log, disponível em: TOTVS Educacional | Sistema Indústria | Orquestrador VTEX | Monitor de Log, armazena os dados exportados dos registros relacionados à Integração VTEX, possibilitando o acompanhamento e identificação dos registros exportados e importados com sucesso ou que necessitam ser reenviados.

    Image RemovedAo clicar sobre um registro de log, o usuário poderá consultar as demais informações complementares associadas ao registro, tais como:
    • Id Log: Identificador sequencial de Log;
    • Campos Chave: Descrição dos campos utilizados para gerar o registro integrado;
    • Valores Chave: Chave primária do registro integrado;
    • Status: Situação da Integração (Sucesso ou Erro);
    • Funcionalidade: Tipo de Processo que está sendo feito (Por exemplo: Exportação de Dados);
    • Data de Criação: Data de Criação do registro;
    • Data da última alteração: Data da última alteração do registro;
    • Número de tentativas de Reenvio: Quantidade de vezes que um registro já foi reenviado;
    • Criador por: Usuário responsável pela inclusão do registro;
    • Alterado Por: Usuário responsável pela alteração do registro;
    • Módulo: Orquestrador VTEX.

    Image Removed

    • Id. Item Log: Identificador sequencial de log.;
    • Id. Log: Identificador sequencial de log;
    • Mensagem: Mensagem com o status da integração do item;
    • Status: Situação da integração do item selecionado;
    • Dados Enviados: Relação dos dados enviados para integração;
    • Dados Recebidos: Relação dos dados recebidos;
    • Data de Criação: Data de criação do registro;
    • Data da Última Alteração: Data da última alteração do registro.
    Image Removed

    Os registros apresentados no monitor de log leitura não poderão ser manipulados, ou seja, não será permitido ao usuário realizar alterações como inclusão, edição e exclusão.

    Através do Monitor de Log, o usuário poderá processar o reenvio ao PROTHEUS dos registros que apresentam status de erro ou pendente, ou seja, que não foram exportados corretamente.
    O processo de reenvio está disponível para execução em: TOTVS Educacional | Sistema Indústria | Orquestrador VTEX | Monitor de Log | Processos | Reenvio de Dados.

    Image RemovedO reenvio poderá ser executado de duas formas, a saber:
    • Manualmente: Quando executado de forma manual, ao acessar o monitor de log, será permitido o usuário selecionar apenas um único registro com o status de erro ou pendente por vez. Após selecionar o registro a ser reenviado, o usuário deverá clicar em: Processos l Reenvio de Log.
    • Automático: O envio automático, ou seja, via agendamento, se aplica a todos os registros gravados no monitor de log que apresentem status de erro ou pendente, conforme o número máximo de tentativas parametrizadas.

    Ao processar o reenvio de log, a customização tentará realizar novamente o envio das informações ao PROTHEUS. Uma vez reenviado, o registro terá o seu status alterado para: Sucesso.

    • Caso o parâmetro esteja vazio a customização não realizará nenhuma tentativa de reenvio automaticamente;
    • Quando o número máximo de tentativas de reenvio for atingido e em nenhuma das tentativas tenha retornado sucesso, a customização passará o status do registro para Cancelado e, desta forma, não integrado ao PROTHEUS. Dependendo do erro ocorrido, o usuário precisará acessar o Monitor de log e analisar os logs, corrigir os registros (caso necessário) e então acionar o processo de reenvio.
    Informações
    iconfalse

    Toggle Cloak
    Monitor de Log - Processo de Reenvio de Dados

    Cloak

    Através do Monitor de Log, o usuário poderá processar o reenvio a API PROTHEUS dos registros que apresentam status de erro ou pendente, ou seja, que não foram exportados corretamente.
    O processo de reenvio está disponível para execução em: TOTVS Educacional | Sistema Indústria | Orquestrador VTEX | Monitor de Log | Processos | Reenvio de Log.


    O reenvio poderá ser executado de duas formas, a saber:

    • Manualmente: Quando executado de forma manual, ao acessar o monitor de log, será permitido o usuário selecionar apenas um único registro com o status de erro ou pendente por vez. Após selecionar o registro a ser reenviado, o usuário deverá clicar em: Processos l Reenvio de Log.
    • Automático: O envio automático, ou seja, via agendamento, se aplica a todos os registros gravados no monitor de log que apresentem status de erro ou pendente, conforme o número máximo de tentativas parametrizadas.

    Ao processar o reenvio de log, a customização tentará realizar novamente o envio das informações ao PROTHEUS. Uma vez reenviado, o registro terá o seu status alterado para: Sucesso.

    Observações:
    • Caso o parâmetro (Número Máximo de tentativas) esteja vazio, a customização não realizará nenhuma tentativa de reenvio automaticamente;
    • Quando o número máximo de tentativas de reenvio for atingido e em nenhuma das tentativas tenha retornado sucesso, a customização passará o status do registro para Cancelado e, desta forma, não integrado ao PROTHEUS (SENAI DN). Dependendo do erro ocorrido, o usuário precisará acessar o Monitor de log e analisar os logs, corrigir os registros (caso necessário) e então acionar o processo de reenvio
    Expandir
    titleMovimentação do Pedido VTEX
    Expandir
    titleMonitor de Log
    Aviso
    titleObservação:
    Expandir
    titleMonitor de Log - Processo de Reenvio de Dados
    Aviso
    titleObservações:
    Expandir
    titleAtualização do Processo para Consulta de Pagamentos VTEX

    A partir da necessidade de atualização do processo de consulta de pagamentos VTEX é possível identificar pedidos com status: Cancelado.

    Image RemovedUma vez identificado, será verificado se este pedido foi exportado ao PROTHEUS em algum momento com status: Integrado com sucesso.
    Para registros que já tenham sido exportados com status: Integrado com sucesso, a API Pagamentos Incluir PROTHEUS será acionada, enviando as seguintes informações:
    • Empresa: Código da empresa PROTHEUS - Valor fixo 01;
    • Filial: Código da filial - Valor fixo: 03DN0001;
    • Data de Cancelamento do Pedido VTEX: A data de cancelamento será enviada no formato AAAAMMDD;
    • Forma de Pagamento: CC - Cartão de Crédito / CD - Cartão de Débito / BOL - Boleto / PIX - Pagamento via PIX;
    • Código da Ordem: Número do pedido;
    • Código do Fornecedor: CPF/CNPJ vinculado ao pedido;
    • Código do Banco: Banco vinculado a conta bancária do cliente para depósito/devolução;
    • Código do Dígito Verificador da Agência: Agência correspondente à conta bancária do cliente para depósito/devolução;
    • Código da Conta Bancária: Conta bancária correspondente à agência e banco do cliente para depósito/devolução;
    • Código do Dígito Verificador da Conta Bancária: Dígito verificador correspondente à conta bancária do cliente para depósito/devolução;
    • Valor: Valor de cada parcela do pedido.
    Aviso
    titleObservação:
    Para registros não localizados com status: Integrado com sucesso, ou seja, que não foram exportados com status, a API Pagamentos Incluir PROTHEUS será acionada, realizando a exportação do cliente e contas a receber, aplicando um registro ao monitor de vendas e, em seguida, acionando a API para inclusão de pagamento
    • .