Projeto:FS008537 (AACPD0) - Integração VTEX - Informações Financeiras.
FS008837 -Integração VTEX - Link de matrícula / Envio de e-mail
Nome do Cliente: Confederação Nacional da Indústria - SENAIObjetivo
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.
Expandir | ||
---|---|---|
| ||
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:
Refletir no SGE todos os pedidos gerados na plataforma VTEX com todos os seus dados de pagamento.
- 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);
- 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 aluno. 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. |
Expandir | ||
---|---|---|
| ||
Liberação dos Anexos Customizados na Árvore de Perfil:
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. |
Expandir | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
A Integração VTEX foi desenvolvida com parâmetros customizados para o registro de informações de dados específicos e necessários para a operação. A interface para configuração desses parâmetros está disponível em: TOTVS Educacional | Sistema Indústria | Integração VTEX | Parâmetros.
Novo! Aos Parâmetros da Integração VTEX, foi inserido um novo parâmetro: URL do Processo Seletivo, no qual deverá ser vinculada a URL base do Portal, incluindo a barra no final. Este registro é essencial para atendimento os Regionais que possuem vários servidores diferentes para o portal. O acesso está disponível em: TOTVS Educacional l Sistema Indústria | Integração VTEX l Parâmetros l Aba: Parâmetros Gerais.
Aos Parâmetros da Integração VTEX, na aba: Dados Financeiros, deverão ser vinculadas as formas de pagamento já cadastradas no SGE que serão utilizadas no processo de baixa automática de lançamentos financeiros no TOTVS Educacional. O acesso está disponível em: TOTVS Educacional l Sistema Indústria | Integração VTEX l Parâmetros l Aba: 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:
Novo!
Para integração nativa entre RM e Protheus no mesmo momento em que é enviado o meio de pagamento de acordo com a forma de pagamento (boleto, pix, cartão de crédito ou débito), a customização também irá enviar o Motivo da Baixa com os códigos correspondentes informados nos parâmetros. Esta informação não fica armazenada em tabelas do RM, ela é preenchida no momento em que a baixa acontece é enviada diretamente para o Protheus através do XML da integração.
Nesta aba é possível parametrizar todos os dados necessários para o usuário definir um textão padrão do envio automático de e-mail (para o responsável do curso) , nos casos em que o número de vagas disponíveis para a oferta de curso tenha se esgotado e existam candidatos/inscritos com pendência de matrícula. O acesso está disponível em: TOTVS Educacional l Sistema Indústria | Integração VTEX l Parâmetros l Aba: E-mail Campos a serem preenchidos:
Nesta aba, é possível parametrizar todos os dados necessários para o usuário definir um textão padrão do envio automático de e-mail, nos casos em que o aluno que ainda não efetivou sua matrícula e/ou para aqueles que tiveram erro durante o processo de matrícula. O acesso está disponível em: TOTVS Educacional l Sistema Indústria | Integração VTEX l Parâmetros l Aba: E-mail Link de Matrícula. Novo! Foram adicionados dois novos campos para configuração de envio de e-mail:
Exemplo de Agendamento Automático: O processo está configurado para exportar, a cada duas horas, os dados para VTEX, incluindo o e-mail para aluno com o link de matrícula. Após duas horas (na próxima execução do processo), ele será ajustado para identificar se poderá enviar o e-mail neste momento. Caso o intervalo de horas para o envio de email ainda não tenha sido atingido (superior a 2 horas), ele não poderá ser enviado neste processamento. Além disso, caso o número máximo de envio de e-mail seja atingido, o email também não poderá ser enviado. O período de intervalo em horas, o número máximo de envio e a recorrência de agendamento serão definidas por parâmetros: Além disso foi criado uma nova tag para concatenação dos cursos e link da matrícula dos mesmo para (Parametros|E-mail Link de Matrícula|Template e-mail), mantendo as tags individuais das mesmas.
|
Expandir | |||||||
---|---|---|---|---|---|---|---|
| |||||||
O processo de consulta de pagamentos VTEX, disponível em: TOTVS Educacional | Sistema Indústria | Integração VTEX | Consulta Pagamentos, identifica os dados associados aos pagamentos das vendas realizadas e/ou canceladas. O processo poderá ser executado manualmente ou agendado, conforme a necessidade. Através desse processo é possível visualizar todos os pedidos existentes na fila, considerando os seguintes status:
O processo de Consulta de Pagamentos VTEX, busca as informações de vendas de pedidos realizados na loja e armazena os dados no Monitor de vendas. São consultados dados de pagamentos da política comercial B2C e B2B.
|
Expandir | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||
Através do Monitor de Vendas, disponível em: TOTVS Educacional | Sistema Indústria | Integração VTEX l Monitor de Vendas, é possível visualizar os dados associados aos pagamentos provenientes de inscrições/vendas efetuadas na plataforma VTEX.
Aba Identificação: Nesta aba estão relacionados os dados relacionados ao pedido, tais como:
Aba Dados Cliente: Nesta aba estão listados os dados relacionados ao Responsável Financeiro vinculado ao pedido, tais como:
A aba 'Dados do Cliente', poderá ser editada pra atualização do cadastro.
|
Expandir | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
Para que o uma Inscrição/Matrículas seja finalizada, será realizada algumas validações referentes à compra/pagamento na plataforma VTEX, tais como:
|
Expandir | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Para matrículas realizadas com sucesso, a customização executa ás seguintes ações:
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.
| ||||||||||||||||
Expandir | ||||||||||||||||
| ||||||||||||||||
Expandir | ||||||||||||||||
| ||||||||||||||||
Expandir | ||||||||||||||||
|
Informações |
---|
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. |
title | Monitor de Vendas - Pagamentos VTEX |
---|
O Monitor de vendas, 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: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;
Campo exclusivo do DN SENAI:
Status Protheus - 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 -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 - 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.
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.
title | Anexo - Pagamentos |
---|
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.
title | Anexo - Itens do Pedido |
---|
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.
title | Geração de Dados Financeiros e Pagamentos |
---|
Ao finalizar a inscrição/matricula no Portal de inscrição do Processo Seletivo é realizada a seguintes ações:
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.
title | Geração e Vínculo do Responsável Financeiro ao Contrato |
---|
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.
Aviso | ||
---|---|---|
| ||
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. |
title | Baixa de Lançamento |
---|
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.
Aviso | ||
---|---|---|
| ||
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. |
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).
title | Reprocessamento da Baixa |
---|
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
title | Anexos: Dados de Pagamento na tela do Contrato Financeiro |
---|
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.
title | Finalização de Inscrição/Matrículas - TOTVS Educacional (SGE) |
---|
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,
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.
title | Observação: |
---|
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:
Ao executar a venda, são realizadas as verificações relacionadas às ofertas disponíveis na plataforma VTEX, considerando:
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.
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.
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.
Nota | ||||||
---|---|---|---|---|---|---|
| ||||||
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. Para identificar o registro da forma de pagamento que será utilizado na baixa são consultados os parâmetros 'Dados Financeiros'.
| ||||||
|
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).
title | Finalização de Inscrição/Matrículas - TOTVS Educacional (SGE) |
---|
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).
|
title | Matrículas Pendentes - TOTVS Educacional (SGE) |
---|
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).
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 alguma 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.