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


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 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 realiza a verificação de dados associados aos pagamentos relacionados às vendas (realizadas/canceladas), disponível em: TOTVS Educacional | Sistema Indústria | Integração VTEX.



Este processo poderá ser executado manualmente ou automaticamente, onde serão acionadas as API's.

Obter itens de feed: Ao consultar essa API será possível visualizar todos os pedidos existentes na fila considerando os status:

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

Confirmar Pedido: Após os dados do pedido serem salvos no Monitor de vendas, deverá ser enviado a confirmação do Pedido para que o mesmo seja removido da fila.

Consulta de pedido: Ao informar o número do pedido, serão retornados todos os dados referente ao mesmo.


O processo de monitoramento de vendas pagamentos VTEX realiza o armazenamento de 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: Boleto, PIX, Cartão de Crédito ou Débito;
  • Valor do Pedido: Valor do pagamento efetuado;
  • Valor Pago: Valor incluindo desconto (caso exista);
  • Valor do Desconto: Valor do desconto aplicado;
  • Status Protheus - Campo exclusivo do DN SENAI: Apresenta o status da integração do pedido com Protheus. Para os DR'S SENAI, o campo não trará informações.
  • Valor Total Repasse - Campo exclusivo do DN SENAI: Apresenta o valor total correspondente ao repasse a ser realizado ao DN SENAI sobre a venda/pedido realizado em ofertas das lojas dos DR'S SENAI/Parceiros (Seller). Quando se tratar de uma venda/pedido realizado sobre uma oferta de curso da própria loja do DN SENAI, o campo não trará informações uma vez que o repasse é realizado somente de um DR SENAI/Parceiro (Seller) para o DN SENAI.
  • Nome do Seller - Campo exclusivo do DN SENAI: Apresenta o nome do DR SENAI/Parceiro (Seller) ofertante do curso associado à venda/pedido realizado. Quando se tratar de uma venda/pedido realizado sobre uma oferta de curso da própria loja do DN SENAI, o campo não trará informações.



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: Endereço do responsável financeiro, incluindo CEP, Logradouro, Número, Complemento, Bairro, Estado, País, Cidade;
  • País: País do endereço do responsável financeiro;
  • Telefones: Telefones do responsável financeiro, incluindo telefone principal, telefone celular e telefone comercial.



Anexos - Pagamentos (Aba Identificação): 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;
  • 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 Total: Valor do pagamento efetuado;
  • Valor Venda: Valor incluindo desconto (caso exista);
  • Valor Desconto: Desconto aplicado.



A visualização da relação de Itens do Pedido, provenientes de inscrições/vendas efetuadas na plataforma VTEX estará disponível em: TOTVS Educacional | Sistema Indústria | Integração VTEX l Monitor de Vendas l Anexos l Itens do Pedido.



Anexos - Itens do Pedido (Aba Identificação): 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.



O processo de monitoramento 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).
Ao finalizar o processo de inscrição, quando verificada a baixa de pagamento, a plataforma VTEX processará a matrícula no TOTVS Educacional (SGE).
Quando houver pendência para o processamento de matrícula por falta de vagas na turma, a customização irá disparar um e-mail com mensagem de notificação para o responsável pelo curso.
Porém 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 no anexo de matrículas pendentes, localizado no monitor de vendas Itens do pedido.
Assim, o usuário poderá acessar/consultar os dados do candidato através dos Anexos: Itens do Pedido para realização das matrículas de forma manual, e ainda, se necessário associar o status dos registros: Matrícula já efetivada pelo usuário.


Anexos - Itens do Pedido (Aba: Identificação):

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


Anexos - Itens do Pedido (Aba: Matrículas Pendentes):

  • Data da inscrição: Data de criação do registro;
  • Status Matrícula: Preenchido inicialmente com o valor Pendente, permite 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.


O processo de finalização de inscrição/matrículas valida as informações referentes à compra/pagamento na plataforma VTEX como: disponibilidade de vagas, seleção do parâmetro Gerar Lançamento na Área de Interesse ofertada do processo seletivo (venda online), geração de lançamentos financeiros, baixas e vinculação do responsável financeiro.



Quando aplicado o recurso de envio de documentos para o cadastro do aluno, seja para as matrículas realizadas via web ou presencial (secretaria escolar), o TOTVS Educacional (SGE) manterá as rotinas padrões do produto (sem interferência de customização), que são:

  1. Considera válida a documentação anexada à inscrição;
  2. Para as inscrições provenientes de processos seletivos que aplicam a validação manual dos arquivos de documentos obrigatórios, antes de matricular o candidato, o TOTVS Educacional (SGE) irá realizar a inscrição na oferta de curso, mantendo o status da inscrição como: Aguardando aprovação;
  3. No processo de aprovação de documentos, após a validação, a matrícula é realizada (tanto o presencial quanto na web).



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

  • Controle de Matrícula em Turma com Vagas Esgotadas: 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, para que sejam utilizados pela secretaria escolar no processo manual de efetivação da matrícula.

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.



Para as situações em que seja utilizado o boleto bancário como meio de pagamento, somente após a confirmação de pagamento, o candidato/inscrito será redirecionado para a etapa de matrícula.
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.
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 (uma vez que podem ser realizadas matrículas presenciais via secretaria escolar), será apresentada uma mensagem de alerta para que o candidato/inscrito aguarde o contato da secretaria escolar, como apresentamos no cenário a seguir.


Exemplo:
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:
"Aguarde o contato da instituição para finalização da sua matrícula".

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.

  • Envio Automático de e-mail - Turma com Vagas Esgotadas: 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.

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


  • Controle de Matrículas Pendentes por Erro: 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.


  • Geração de Dados Financeiros e Pagamentos: O processo de 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.

Ao realizar a venda de um curso através da plataforma VTEX, a customização irá realizar os seguintes processos:


Geração e Vínculo do Responsável Financeiro ao Contrato Gerado: 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, processando a 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 (Inclui: CEP, Tipo Rua, Logradouro, Número, Complemento, Tipo Bairro, Bairro, Estado, Cidade, País);
  • Telefone;
  • Celular;
  • Telefone Comercial.



Para que o responsável financeiro seja o próprio aluno (ALUNO.CODCFO) o parâmetro (SPSPARAMETROSAREAOFERTADA.CADASTRAALUNOCOMORESPFINANC) deverá estar marcado na aba financeiro da área de interesse ofertada do processo seletivo.



A página do processo seletivo não permite que seja informado um responsável do tipo pessoa jurídica. No entanto, a customização poderá receber um CNPJ de responsável financeiro e fará o cadastro do cliente com base nos dados consultados no VTEX através da API.



  • Baixa de Lançamentos Financeiros: O processo de baixa de lançamentos financeiros e pagamentos é executado após a geração do contrato e lançamento financeiro da primeira parcela, uma vez que concluída a venda e confirmação de pagamento na plataforma VTEX, as matrículas serão geradas no TOTVS Educacional (SGE). 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.



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 reprocessamento da baixa.



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.



  • Vínculo de Dados da Inscrição/Matrícula com os Dados do Pagamento: O vínculo de dados relacionados à matrícula (contrato) aos dados de pagamento da compra realizada através da plataforma VTEX estarão disponíveis no TOTVS Educacional (SGE) através do monitor de vendas bem como vinculado ao contrato, ao finalizar a inscrição.

Após verificar o pagamento da inscrição, a customização irá realizar vincular os dados do pagamento à matrícula, bem como o status referente à baixa do lançamento financeiro (sucesso ou erro), data do processamento e mensagem de erro (quando houver).



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, estarão associadas a um anexo ao Contrato Financeiro.
A partir do Anexo: Dados do Pagamento do Contrato Financeiro, é possível verificar os Dados do Pagamento, que estarão disponíveis em: TOTVS Educacional | Financeiro/Contábil | Contratos | Anexos l Dados do Pagamento.


Anexos - Dados do Pagamento: Neste anexo 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.
Anexos - Dados do Pagamento (Aba: Identificação):

  • Dados do Pagamento: Lista os 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.



Anexos - Dados do Pagamento (Aba: Histórico):

  • 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 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 foi adicionado o Reprocessamento de Baixa.
A partir do Processo: 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.




Atenção: Caso a baixa do lançamento não tenha ocorrido com sucesso, será gravado na aba histórico o status de erro. Portanto, será possível reprocessar a baixa do título que irá executar o mesmo processo descrito ao finalizar a inscrição