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.

...

Expandir
titleParâmetros da Customização

A parametrização da customização da API 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, .

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


Image Added


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 RemovedImage Added


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

ou canceladas.  Os dados de Pedidos VTEX, enviados para o PROTHEUS, 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.
Expandir
titleConsulta de Pedidos VTEX
A consulta das API'S

O processo de consulta de pagamentos

provenientes da plataforma

VTEX

identifica as informações referentes às inscrições associadas a

, identifica os dados associados aos pagamentos das vendas realizadas e/

canceladas (Escopo Informações Financeiras do VTEX - FS008537) para envio ao PROTHEUS SENAI DN.
Nota
titleImportante:
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 Após consulta dos Pedidos (conforme citado no item anterior), a realizada a exportação de para o PROTHEUS. Esse processo exporta todos os dados consultados, realizando primeiramente uma identificação de cadastro de 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

  • 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.


Image Modified


As 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/Telefone: 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 no 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:

Nome do Seller no cadastro do Item do pedido no Monitor de Vendas.

  • Cliente Não Seller:
Campo items preenchido valor: 1, corresponde
  • Corresponde a Loja Principal DN.
  • Cliente Seller:
Campo items preenchido valor diferente de: 1, corresponde às Lojas DR
  • Corresponde às Lojas DR's e Parceiros.
Tela VTEX com destaque do campo ITEMS
Assim, para

Image Added

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


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;
  • Venda realizada na Loja dos Sellers
  • 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.Observação:
    • .


    Informações
    Aviso
    title

    A customização

    irá verificar

    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.

    Expandir
    titleExportação de Contas a Receber para PROTHEUS

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

    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.


    Image Added


    Neste processo A 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

    A identificação de contas a receber provenientes de vendas/pedidos de clientes tipo Seller, um cliente Seller (Pessoa jurídica) é 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

    campo: Nome do Seller no cadastro do Item do pedido no Monitor de Vendas, conforme citado anteriormente.

    Estado
    colourGreen
    titleExemplo


    Pedido Id: 122550
    Valor Total do Pedido: R$ 300Exemplo 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 DB: Valor R$ 100,00 - Comissão: R$ 10,00 - Seller : SENAI AcreLoja Principal DN
    • Curso C: Valor R$ 100,00 - Seller: SENAI Bahia - Comissão: R$ 10,00 - Seller: SENAI Bahia

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

    • Conta a receber 01: Correspondente Com ao cliente SENAI Bahia - Valor : R$ 20,00
    • Conta a receber 02: Correspondente ao cliente SENAI Acre - Valor: R$ 10,00Conta a receber 03: Correspondente ao cliente Com cliente que realizou a compra na Loja Principal DN - Valor : R$ 100,00
    Contas a Receber Seller - Cálculo da
    • 00


     
    Estado
    colourYellow
    title*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: 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.

    Image Added 

    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. ,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).


    Expandir
    titleMovimentação do Pedido VTEX

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

    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.



    Expandir
    titleMonitor de Log

    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.



    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.



    • 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.



    Aviso
    titleObservaçã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.


    ...