Projeto: FS008537 (AACPD0) - Integração VTEX - Informações Financeiras.

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


Objetivo
Este documento foi elaborado para orientar aos usuários-chave SENAI DN sobre os requisitos e funcionalidades da Integração TOTVS Educacional (SGE) e a Plataforma VTEX, que possibilita a integração de vendas das ofertas de cursos, compreendendo o processo de matrícula e a geração da baixa de lançamento financeiro, de acordo com as informações da venda e pagamento.


Público Alvo
Este manual é destinado aos colaboradores selecionados como usuários-chave para o projeto Integração VTEX do 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 - FS008537 (AACPD0) - Integração VTEX - Informações Financeiras.
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.

Permitir a integração das vendas realizadas através da plataforma VTEX com o SGE, considerando as parametrizações existentes no Processo Seletivo. O escopo dispõe das seguintes funcionalidades:

  • Monitor de Vendas

          Refletir no SGE todos os pedidos gerados na plataforma VTEX com todos os seus dados de pagamento.

  • Matrícula

 - Vincular as matrículas realizada aos seus pedidos no Monitor de Vendas;

 - Gravar os dados de Matrículas Pendentes - SGE (caso tenha ocorrido algum erro durante o processo). Possibilitando assim, que a secretaria entre em contanto com o aluno e finalize a  matrícula de forma manual.

 - Vincular o pedido gravado no monitor de vendas ao contrato de matrícula de aluno;

- Controle de Matrícula em Turma com Vagas Esgotadas;

- Envio de E-mail - Turmas com Vagas Esgotadas (envio para o responsável do Curso);

  • Geração de  Dados Financeiros e  Pagamentos 

 - Gerar o Responsável Financeiro e vinculá-lo ao contrato gerado (quando não for o próprio aluno (parâmetro disponível na aba financeiro da área de interesse ofertada do PS);

 - Baixar Lançamentos Financeiros (Baixa automática da 1° parcela);

 - Reprocessamento de Baixa automática (reprocessar a baixa do lançamento financeiro para os casos de erro no processamento da baixa ao finalizar inscrição/matrícula do alun


Importante: Não está previsto neste escopo a adequação das integrações entre SGE e Backoffice (Protheus, Dynamics, etc.). O regional precisará se adequar para que as informações financeiras sejam enviadas aos backoffices correspondentes.


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 de Instalação de Customizações na seção: Liberando Acesso aos Menus.



  • Aba Dados Financeiros

Será disponibilizado nos Parâmetros da Integração VTEX,  a aba Dados Financeiros. O usuário deverá informar nesta aba, as formas de pagamento que serão utilizadas no processo de baixa automática de lançamentos financeiros no TOTVS Educacional. 

A parametrização está disponível em: TOTVS Educacional | Sistema Indústria | Parâmetros Integração VTEX | Dados Financeiros 

Na interface, os parâmetros serão armazenados por contexto (Coligada, Filial e Nível de Ensino), para os quais o usuário deverá efetuar as seguintes parametrizações:


Neste item deverão ser informados os parâmetros correspondentes às formas de pagamento:

  • Boleto: Código da forma de pagamento referente ao Boleto;
  • PIX: Código da forma de pagamento referente ao PIX;
  • Cartão de Débito: Código da forma de pagamento referente ao Cartão de Débito;
  • Cartão de Crédito: Código da forma de pagamento referente ao Cartão de Crédito.




O processo de consulta de pagamentos VTEX, identifica os dados associados aos pagamentos das vendas realizadas e/ou canceladas. 

O processo poderá ser executado manualmente ou agendado. Para acesso manual, o menu está disponível em: TOTVS Educacional | Sistema Indústria | Integração VTEX | Consulta Pagamentos VTEX.

Através desse processo é possível visualizar todos os pedidos existentes na fila, considerando os seguintes status:

  • Pronto para manuseio;
  • Preparando entrega;
  • Pagamento Aprovado (Seller);
  • Faturado;
  • Cancelado.


Após os dados do pedido serem consultado e salvos no Monitor de vendas (detalhado no item abaixo), é enviado uma confirmação do Pedido para que o mesmo seja removido da fila.

No Monitor de vendas, é possível visualizar os dados associados aos pagamentos provenientes de inscrições/vendas efetuadas na plataforma VTEX.

A visualização da relação de pagamentos está disponível em: TOTVS Educacional | Sistema Indústria | Integração VTEX l Monitor de Vendas.



A tela do Monitor de Vendas, reúne as seguintes informações:

  • Aba Identificação: Nesta aba estão relacionados os dados relacionados ao pedido, tais como:

Número do Pedido: Código identificador do pedido gerado no VTEX;

Data da venda: Data de processamento da venda;

Status do Pedido: Pronto para manuseio; Preparando entrega; Pagamento Aprovado; Faturado; Cancelado.

Valor do Pedido: Valor do pagamento efetuado;

Valor Pago: Valor incluindo desconto (caso exista);

Valor do Desconto: Valor do desconto aplicado;


Os campos Status Protheus, Valor do Repasse e Nome do Seller, são exclusivos do SENAI DN e não terá informações aos Regionais.


  • Aba Dados Cliente: Nesta aba estão relacionados os dados relacionados ao responsável financeiro vinculado ao pedido, tais como:

Nome: Nome do responsável financeiro;

Tipo de Documento: CPF/CNPJ;

E-mail: Endereço de e-mail do responsável financeiro;

CPF/CNPJ do Responsável: Inscrição CPF/CNPJ do responsável financeiro;

Endereço completo: Endereço do responsável financeiro, incluindo CEP, Logradouro, Número, Complemento, Bairro, Estado, País, Cidade;

Telefones: Telefones do responsável financeiro, incluindo telefone principal, telefone celular e telefone comercial.


A aba 'Dados do Cliente', poderá ser editada pra atualização do cadastro.

A edição dos dados na aba Dados do Cliente, só poderá ser realizada por um usuário com as devidas permissões. Essa permissão é defina na árvore nativa de Perfis. Conforme exemplo abaixo:


Sempre que houver alteração nos dados do cliente (conforme citado acima), será gravado no Anexo Histórico de Alteração de Dados - Cliente.

O anexo estará disponível no Monitor de Vendas e trará os campos abaixo:

Dado alterado: será exibido o nome do campo que sofreu alteração;

Dado Anterior: será exibido o dado registrado anteriormente (conforme consulta feita na plataforma VTEX);

Dado Atual: será exibido o dado atual (com a modificação realizada pelo usuário);

Usuário: será exibido o usuário que realizou a alteração.

Será apresentado na grid uma linha para cada registro alterado. Abaixo modelo da tela:


Anexo - Pagamentos no cadastro do Monitor de vendas: 

Neste anexo estão relacionados os dados vinculados ao pagamento do pedido, tais como:

Data de Pagamento: Data do pagamento efetuado no VTEX;

Número de Parcelas: Quantidade de parcelas;

Modalidade do pagamento: Boleto, PIX, Cartão de Crédito ou Débito;

Nosso Número: Nosso número do boleto gerado;

Código de barras do Boleto: Código de barras do boleto;

NSU: NSU cartão de crédito utilizado no pagamento;

Final Cartão: Últimos dígitos cartão de crédito utilizado no pagamento;

Código da Transação: Código de autorização da compra gerado pelo gateway;

Id da Transação (TID): ID da transação (Cartão de crédito e PIX);

Valor do Pedido: Valor do pagamento efetuado;

Valor total Venda: Valor incluindo desconto (caso exista);

Valor Desconto: Desconto aplicado.


Cada Pedido pode contar um ou mais itens. A visualização da relação de Itens do Pedido, estará disponível no Anexo do Monitor de vendas:

TOTVS Educacional | Sistema Indústria | Integração VTEX l Monitor de Vendas l Anexos l Itens do Pedido.



Neste anexo estão relacionados os dados vinculados aos itens/produtos do pedido, que podem ser visualizados separadamente, tais como:

Referência da Turma: Código referência SKU;

SKU: SKU da Turma;

Produto: Identificador do Curso;

Turma: Nome da Turma;

Valor: Valor do item/produto;

Valor Venda: Valor incluindo desconto (caso exista);

Valor Desconto: Desconto aplicado (caso exista);

Valor Repasse: Valor de comissão repassado ao DN por uma venda de Seller;

CNPJ Seller: CNPJ do Seller que realizou a venda na loja principal;

Nome Seller: Nome do Seller que realizou a venda na loja principal;

Unidade: Filial vinculada ao produto.


Ao finalizar a inscrição/matricula no Portal de inscrição do Processo Seletivo é realizada a seguintes ações:

  • Cadastro e vinculo do responsável financeiro no Contrato do Aluno;
  • Geração do lançamento financeiro da primeira parcela,
  • Baixa do lançamento, de acordo com as informações de pagamento efetuados na plataforma VTEX.

A geração de dados financeiros e pagamentos realiza a efetivação dos cadastros dos dados financeiros ao contrato do aluno e processa as baixas de lançamentos realizados provenientes da venda de cursos, conforme a configuração financeira do processo seletivo no TOTVS Educacional (SGE) para venda na plataforma VTEX.


Para os Processos Seletivos cujas ofertas configurem que o responsável financeiro não seja o próprio aluno, o cadastro do responsável financeiro será realizado a partir dos dados do responsável financeiro informados no momento de compra na plataforma VTEX e vinculado ao contrato gerado. Este cadastro considera a verificação, validação e unicidade do CPF//CNPJ, validando a existência de um cadastro cliente/fornecedor e, caso não exista, será realizada criação do mesmo.
O cadastro do responsável financeiro será realizado considerando as seguintes informações:

Cód. Cliente Fornecedor;

Nome Fantasia/Social;

Nome;

Classificação (Preenchido pelo SGE como Cliente);

Categoria (Preenchido pelo SGE como PF caso seja retornado na consulta do VTEX o CPF e como PJ caso tenha sido retornado um CNPJ);

CPF/CNPJ;

E-mail;

Endereço Completo;

Telefones.


Para que o responsável financeiro seja o próprio aluno o parâmetro  deverá estar marcado na aba financeiro da área de interesse ofertada do processo seletivo; conforme imagem abaixo:

A página do processo seletivo não permite que seja informado um responsável do tipo pessoa jurídica. No entanto, será possível receber um CNPJ de responsável financeiro o mesmo será incluído no cadastro do cliente com base nos dados consultados.

A baixa de lançamentos financeiros e pagamentos é executada após a geração do contrato e lançamento financeiro da primeira parcela, visto que as matrículas que virão da VTEX para o SGE, já terão o pagamento confirmado na Plataforma.

A realização das baixas dos lançamentos financeiros serão realizadas no TOTVS Educacional (SGE), de acordo com as informações referentes à forma de pagamento (Boleto Bancário, PIX, Cartão de Crédito ou Débito), data de pagamento e valor pago.

Após a execução, os registros relacionados à baixa de lançamento financeiro como: Data de Criação, Usuário Responsável, Dados Enviados, Dados Recebidos, Mensagem de Erro e Status do Registros na Integração ficarão armazenados na tabela de LOG.

Demais informações necessárias para para a baixa (conta caixa e moeda, por exemplo) deverão estar parametrizadas com valores defaults no TOTVS Educacional (SGE), sem necessidade da customização preencher tais campos.
O regional que optar pelo pagamento através do TOTVS Educacional (SGE), funcionalidade nativa, a customização não irá efetuar a baixa do lançamento financeiro automaticamente ao finalizar o processo de matrícula. Esse processo será automatizado apenas quando utilizar a integração do VTEX e a área de interesse do processo seletivo estiver parametrizada para gerar lançamento.

Se o contrato possuir uma bolsa, os lançamentos financeiros são gerados considerando o desconto em todas as parcelas do plano de pagamento e não somente na 1° parcela;

Caso o TOTVS Educacional (SGE) possua integração com Protheus ou utilize o financeiro do TOTVS Educacional, a comunicação com o sistema financeiro utilizará as regras já existentes de integração, porém para integração com outros sistemas como AX, Dynamics e outros poderão ser necessárias alterações/implementações para atender essas especificidades. Tais alterações não serão tratadas neste escopo.


Caso seja apresentado erro no momento da baixa de lançamento financeiro, a informação também será gravada nos dados do contrato (anexos) que poderá ser consultado para execução do Processo reprocessamento da baixa (descrito no próximo item).


Para as situações em que, ao finalizar a inscrição/matrícula no TOTVS Educacional (SGE), proveniente de vendas de ofertas na plataforma VTEX, sejam apresentados erros no processamento de baixa, ao Contrato Financeiro é possível realizar o  Reprocessamento de Baixa.

No processo de Reprocessamento de Baixa, será reexecutada a baixa do lançamento financeiro, que por sua vez, armazenará um novo retorno.

Este processo está disponível em: TOTVS Educacional | Financeiro/Contábil | Contratos | Anexos l Dados do Pagamento l Processos l Reprocessamento Baixa.



Caso a baixa do lançamento não tenha ocorrido com sucesso, será gravado na aba histórico o status de erro

O armazenamento das informações relacionadas aos dados financeiros dos pagamentos referentes às matrículas efetuadas no TOTVS Educacional (SGE), provenientes de vendas de ofertas na plataforma VTEX, são associadas a um anexo ao Contrato Financeiro.


O anexo está disponível em: TOTVS Educacional | Financeiro/Contábil | Contratos | Anexos l Dados do Pagamento.


Nele serão apresentados os dados do pagamento realizados na plataforma VTEX, preenchidos automaticamente a partir da conclusão da inscrição/matrícula do aluno.

Aba: Identificação:

Dados do Pagamento: Dados referentes ao pagamento efetuado na plataforma VTEX, como código e descrição;

Lançamento Baixado: Campos preenchido automaticamente a partir da verificação da baixa de lançamento financeiro.




Aba: Histórico:

A aba de histórico será preenchida na inclusão do registro e para cada tentativa de processamento, caso a baixa não tenha ocorrido com sucesso na inclusão. Os campos serão:

Data: Vincula a data do processamento da baixa de lançamento financeiro.

Status: Apresenta status de Sucesso ou Erro, de acordo com o processamento

Erro: Apresenta a mensagem de erro durante o processamento da baixa, caso ocorra.



Para que o uma inscrição/matrículas seja finalizada, será realizada algumas validações referentes à compra/pagamento na plataforma VTEX como:

Disponibilidade de vagas, geração de lançamentos financeiros, baixas e vinculação do responsável Financeiro.

Ao executar a venda, são realizadas as verificações relacionadas às ofertas disponíveis na plataforma VTEX, considerando:

  • Turmas com vagas Esgotadas
  • Matrículas Pendentes por erro


Ao avançar para a etapa de matrícula após a confirmação de pagamento, a customização irá validar/contabilizar o número de vagas da turma de oferta com o número de matrículas já realizadas. As vagas disponíveis na turma podem ser verificadas no cadastro da Turma, através dos campos: Número máximo de alunos e Alunos matriculados.

Havendo disponibilidade de vagas, a matrícula será efetivada/concluída no TOTVS Educacional (SGE).
Porém, se já atingido o número de candidatos/inscritos às vagas ofertadas, será apresentada uma mensagem de alerta para que o candidato/inscrito aguarde o contato da secretaria escolar, como apresentamos no cenário a seguir.

O controle de matrículas em turma com vagas esgotadas, reúne as informações referentes à compra/pagamento na plataforma VTEX do candidato/inscrito que não teve a sua matrícula efetivada no TOTVS Educacional (SGE), devido a indisponibilidade de vagas da turma de oferta de curso.  Os dados armazenados durante a inscrição serão utilizados pela secretaria escolar no processo manual de efetivação da matrícula. 

Turma: APP.CPI.001.I (Aperfeiçoamento Profissional em Costureiro Industrial do Vestuário).
Vagas: 03
Relação de Candidatos/Inscritos:

  • Candidato/Inscrito 01: Matrícula não-efetivada (aguardando confirmação de pagamento). Gerado boleto bancário via plataforma VTEX;
  • Candidato/Inscrito 02: Matrícula efetivada. Pagamento via cartão de crédito na plataforma VTEX;
  • Candidato/Inscrito 03: Matrícula efetivada. Pagamento via cartão de crédito na plataforma VTEX;
  • Candidato/Inscrito 04: Matrícula presencial (Via secretaria escolar).


Diante o cenário, o candidato/inscrito 01 aguarda a confirmação de pagamento para que possa prosseguir à sua matrícula.
Já os demais candidatos/inscritos 02 e 03 tiveram as matrículas efetivadas no TOTVS Educacional (RM) por terem realizado pagamento via cartão de crédito.

Assim, o candidato 04 que compareceu a secretaria escolar, teve também a sua matrícula efetivada no TOTVS Educacional (RM), uma vez que no momento do seu comparecimento, o candidato/inscrito 01 ainda não prosseguiu à efetivação da matrícula devido ao período de confirmação/compensação do pagamento realizado via boleto bancário.
Considerando que as vagas da turma foram assim preenchidas, após o período de confirmação/compensação do pagamento do boleto bancário, ao prosseguir à finalização de sua matrícula, será apresentada ao candidato/inscrito 01 a mensagem (padrão) de alerta:


Desta forma, a customização armazenará através do Monitor de Vendas, os dados cadastrais do aluno, bem como os dados e status de matrícula, pagamentos e responsável financeiro.
Já o responsável pelo curso será notificado via e-mail que proceda à verificação da pendência de matrícula para este candidato/inscrito (descrito no próximo item).

Analisada a situação, a secretaria escolar, poderá utilizar os dados armazenados durante a inscrição no processo manual de efetivação da matrícula. 

Realizada uma venda via plataforma VTEX relacionada a oferta de turma cujas vagas já tenham sido preenchidas no TOTVS Educacional (SGE), será disparado um e-mail de notificação ao o endereço definido na parametrização de e-mail da customização. (Para maiores informações dessa parametrização, cliquei aqui).

O envio de e-mail ao responsável do curso visa a notificação de matrículas pendentes em turma com vagas esgotadas no TOTVS Educacional (SGE), para que a secretaria escolar possa realizar manualmente as matrículas necessárias.

A partir do recebimento do e-mail de notificação, o responsável deverá entrar em proceder à conclusão da matrícula no TOTVS Educacional (SGE), considerando que o aluno já efetuou o pagamento correspondente à oferta do curso.

O controle de matrículas pendentes por erro no TOTVS Educacional (SGE), é realizado a partir dos dados da inscrição do candidato/inscrito, incluindo os dados do pagamento realizado na plataforma VTEX que estarão disponíveis para que a secretaria escolar realize manualmente a efetivação da matrícula para que sejam utilizados pela secretaria escolar no processo manual de efetivação da matrícula.

O Monitor de vendas pagamentos VTEX, também realiza o armazenamento de dados/status associados às inscrições/vendas que não possuem vínculo de matrículas registrados no TOTVS Educacional (SGE).

Sempre que houver alguma pendência para o processamento de matrícula por falta de vagas na turma ou algum outro motivo de erro, essa matrícula pendente será gravada no Anexo Matrículas Pendentes na tela do Itens do Pedido.


Na tela é possível visualizar:

Data da inscrição: Data de criação do registro;

Identificador: Identificador sequencial da inscrição;

Dados Recebidos: Relação dos dados recebidos pelo VTEX na URL de inscrição/matrícula, em formato JSON.

Status do Pedido: Preenchido inicialmente com o valor Pendente, mas que compreende os seguintes status:

Pendente: Pagamento realizado no VTEX sem matrícula gerada no SGE;

Pendente com Erro: Pagamento realizado no VTEX, sem matrícula gerada no SGE;

Vaga indisponível: Pagamento realizado no VTEX, sem matrícula no SGE por falta de vagas;

Baixa Pendente: Pagamento realizado no VTEX, matrícula gerada no SGE com baixa de lançamento pendente;

Matrícula Finalizada: Pagamento realizado no VTEX, matrícula gerada no SGE com lançamento baixado.

Após a conferência de dados e realizada a matrícula pelo usuário, para permitir a gestão e controle interno do usuário, serão automaticamente preenchidos os campos:

Matrícula Efetuada: Após efetivação da matrícula, a flag será automaticamente preenchida;

Data da Efetivação: Preenchida automaticamente com a data corrente na qual a matrícula foi realizada;

Usuário Responsável: Este campo será preenchido apenas quando a flag: matrícula efetuada for marcada manualmente.

Caso seja apresentado erro para o processamento da matrícula e que o erro não esteja relacionado ao número de vagas já preenchidas na turma de oferta, a customização irá gravar uma mensagem de erro na aba do anexo de matrículas pendentes: 

Para que a secretaria escolar realize manualmente a efetivação da matrícula, o usuário do SGE poderá acessar/consultar os dados do candidato através dos Anexos: Matriculas (na tela de itens do Pedido) Aba Dados do Aluno:

  Após a efetivação da matricula do aluno, para que se tenha um gestão eficaz das matriculas que estavam como "pendentes", o usuário poderá marcar manualmente a flag: Matricula Efetivada.

 

 Quando a Flag for marcada o campo: Usuário Responsável será preenchido automaticamente com o login do usuário responsável pele efetivação.