Projeto: FS008780 - Conciliador
Nome do Cliente: Confederação Nacional da Indústria - SENAI
Objetivo
Este documento foi elaborado para informar aos usuários-chave da área Educacional do SENAI, a disponibilização de um Portal Web - Conciliador de Split de Pagamentos, que realiza a conciliação das vendas de cursos entre VTEX x GETNET x PROTHEUS E SGE.
Esse documento tem como base descrever a integração entre VTEX x GETNET x PROTHEUS, que visa conciliar as vendas feitas na VTEX, integrado ao Protheus do DN e a GETNET.
Para isso, será apresentada uma visão prática da solução desenvolvida, explorando os conceitos utilizados e as funcionalidades do Sistema. O material descreve algumas etapas referentes como:
Público Alvo
Este manual é destinado aos colaboradores selecionados como usuários-chave do SENAI.
Metodologia
Este material tem como base a visão prática e completa da funcionalidade Customizada.
Importante: O Portal Conciliador não está preparado para tratar transações referentes à plano de assinatura (onde o Order id do pedido fica errado no extrato da GetNet) e pedidos com itens de sellers diferentes, já que a transação foi definida para ter apenas um seller relacionado.
Portal Web, totalmente apartado do SGE, com a finalidade de realizar a conciliação de vendas realizadas no VTEX, integrando com GetNet e Protheus.
Pré-requisitos
Acessar o ambiente de instalação do portal para acessar os parâmetros. Não existe interface no portal conciliador para informar os parâmetros.
Detalhamento do Processo
Os parâmetros necessários para execução dos processos devem ser informados no arquivo de configuração do conciliador appsettings.json, disponível no diretório de instalação (exemplo: c:\TOTVS\ApiConciliador). Segue a lista:
Parâmetros de Acesso:
Parâmetros de acesso:
Outros Parâmetros:
Parâmetros de acesso:
Outros parâmetros:
Importante:
Não existe interface para preenchimento destes valores.
Detalhamento do Processo
Por meio do arquivo appsettings.json, será possível adicionar grupos de novos regionais ou parceiros.
Para incluir ou atualizar um Seller, será necessário utilizar o seguinte template base conforme exemplo abaixo, disponível em: c:\TOTVS\Conciliador\ConciliadorPortal
{
"cnpj": "", - Informa o CNPJ do regional, somente números
"nome": "", - Descrição do nome do regional
"nomeReduzido": "", - Descrição do nome reduzido do regional
"sellerId": "", - Identificador de Franquiado
"groupId": "" – Codigo de agrupamento do regional
}
Após o usuário informar os valores para cada campo citado acima, será necessário incluir estas informações do template no arquivo appsettings.json dentro da lista de Sellers.
Pré-requisitos
A publicação deste portal pode ser feita através do Internet Information Services (IIS) Windows.
Detalhamento do Processo
O Portal Conciliador terá uma estrutura própria de login e layout. Os dados serão armazenados na nova base de dados criada. Os campos e filtros serão definidos no detalhamento de cada tela/página que compõem o portal.
A página inicial do portal irá trazer a lista de menus disponíveis na lateral esquerda, conforme modelo abaixo:
O usuário terá opção de realizar o logoff do portal, através de ícone no canto superior direito.
Importante:
Não está prevista funcionalidade de logoff automático do usuário após um período de inatividade.
Autenticação dos usuários
A autenticação no portal será feita através do Azure do SENAI DN, ao acessar o endereço do Portal Conciliador, será exibida tela de login /autenticação do Azure, conforme exemplo abaixo:
Após login efetuado, o usuário será direcionado para o endereço inicial do Portal Conciliador, já autenticado.
Perfil / Grupos de usuários:
Todos os usuários com acesso ao Portal Conciliador terão acesso à todas as funcionalidades disponíveis. A restrição de acesso conforme o grupo será para visualização de dados pertinentes a cada Grupo/Regional.
Ao logar no Portal Conciliador, ele identificará o grupo do usuário logado e permitirá a visualização apenas dos dados do Regional (grupo) do usuário.
Caso um usuário esteja associado a mais de um grupo, ele terá permissão para visualizar os dados de todos os grupos associados. Usuários associados ao grupo SENAI DN não terão restrição de acesso à dados.
Importante:
A utilização dos grupos do Azure se faz necessária neste momento devido ao curto prazo para desenvolvimento das funcionalidades do Conciliador e necessidade imediata de controle de acesso à dados por Regional. Com a evolução do Portal Conciliador, este recurso poderá ser migrado para dentro do portal (usuários e perfis), com novo esforço e custo necessário para adequação.
Funcionalidades do menu Integrador
Detalhamento do Processo
No menu do Portal Conciliador, será exibida uma opção chamada Integrador, que terá submenus responsáveis por realizar a importação dos dados da VTEX, GetNet, Protheus e Pagamentos, gravando o vínculo entre eles, quando identificado.
O processo de importação não será automatizado neste momento. Ele precisa ser disparado manualmente por algum usuário responsável (administrador financeiro) e não terá opção de informar o período que deseja consultar.
1- Buscar dados das Transações GetNet (Extrato)
Ao acionar o processo de Importação de Dados, os dados das transações realizadas e processadas pela GetNet serão obtidos através da API GetNet de solicitação de extrato eletrônico (demonstrativo), serão buscados todos os registros desde a última execução do processo até a data atual.
Serão importadas transações de Crédito à vista, Crédito Parcelado Lojista, Crédito Parcelamento Administradora, Cancelamento e Chargeback com status igual a 0-Aprovado. Transações com status Não Aprovado ou outro status diferente de Aprovado não serão importadas para o Conciliador.
Conciliação
Ao importar os dados do GetNet, os status da conciliação entre GetNet e VTEX e GetNet e Protheus deverão ser preenchidos automaticamente, de acordo com o tipo de transação (crédito, cancelamento e chargeback) e a conferência e comparação de dados, conforme descrito nos itens Conciliação dos sub-requisitos de Transações (crédito, cancelamento e chargeback).
2- Busca dados das vendas VTEX (Pedidos)
Ao acionar o processo de Importação de Dados, os dados das vendas realizadas através do Marketplace VTEX serão obtidos, através da API VTEX, e gravados na tabela correspondente do Portal Conciliador. Serão buscados todos os pedidos disponíveis no feed de pedidos VTEX.
Observação: Se existir algum pedido GetNet sem pedido VTEX, para esses casos, a busca será direto na API de pedidos para atualizar os dados correspondentes.
Importante:
Conciliação
Ao importar os dados do VTEX, o status da conciliação entre GetNet e VTEX deverá ser preenchido automaticamente (transações de crédito) conforme conferência e comparação de dados das - Transações dos tipos Crédito à vista, Crédito Parcelado Lojista e Crédito Parcelamento Administradora / Conciliação.
3- Buscar dados dos títulos no Protheus
Ao acionar o processo de Importação de Dados, os dados das vendas realizadas através do Marketplace VTEX serão obtidos, com base no número do pedido VTEX, através de API disponibilizada pelo SENAI, para que seja possível vincular os títulos às transações do GetNet. Serão gravados no conciliador os dados de todos os títulos associados ao pedido para conferência.
Para vendas realizadas pelo SENAI Nacional, a integração com o Protheus Nacional acontece assim:
Para vendas realizadas por algum Regional ou Parceiro, a integração com o Protheus Nacional acontece assim:
Observação
Conciliação
Ao importar os títulos do Protheus, é necessário atualizar o status da conciliação entre GetNet e Protheus automaticamente, de acordo com o tipo de transação (crédito, cancelamento ou chargeback) e a comparação de dados, conforme descrito nos requisitos de transações / Conciliação.
Funcionalidade do menu GetNet Pagamentos
Pré-requisitos
Executar o processo de Importação de Dados - Pagamentos do Extrato GetNet, para a customização buscar todos os dados de pagamentos/recebimentos (débito e crédito) do extrato GetNet para serem exibidos na interface de pagamentos, que serão conciliados com os títulos correspondentes no Protheus.
Detalhamento do Processo
Ao executar o processo todos os pagamentos efetuados pela GetNet, sejam referentes a transações de crédito ou transações de débito, como cancelamento e chargeback, serão registrados no bloco de pagamentos do extrato GetNet e podem ser obtidos através da API GetNet de solicitação de extrato eletrônico (demonstrativo). O pagamento acontece 31 dias após a data da venda.
O menu ficará disponível dentro da opção Integrador, GetNet Pagamentos, que será responsável por buscar no extrato os dados referentes aos pagamentos efetuados pela GetNet.
A cada execução, serão buscados todos os registros desde a última execução do processo até a data atual. Os pagamentos importados estarão vinculados aos títulos do Protheus já importados para o Portal Conciliador.
Conciliação
Ao importar os pagamentos do extrato GetNet, eles serão automaticamente vinculados aos títulos do Protheus já importados para o portal conciliador (processo de Busca Dados Protheus - conciliação da transação). O status da conciliação será preenchido automaticamente, conforme descrito em - Conciliação Automática deste documento.
Total de Recebimentos e Valor Banco
Será gravado na interface de Valores Diários o total de recebimentos (somatório dos pagamentos - débito e crédito) e o valor total pago para o DN por dia, que será o somatório de todos os registros de pagamento (todas as bandeiras) daquela data. Devem ser considerados apenas os pagamentos realizados para o DN (filtrar pelo CNPJ do cliente 33.564.543/0001-90, seguindo regra padrão de arredondamento).
Para recebimentos/pagamentos de um regional ou parceiro (seller), o extrato traz os valores totais. No entanto, serão considerados apenas os valores referentes às comissões, já que esses valores serão repassados para a conta do DN e precisarão ser conferidos na interface de Valores Diários.
A interface de agendamento poderá ser acionada através do menu lateral chamado Agendamento de Processos.
Ao acesso o Menu e abrir a tela de configuração de agendamento, é necessário informar:
Hora da Execução (1ª execução): Onde o usuário informará a data e hora da primeira execução;
Agendamento em caso de erro:
Após configuração do Agendamento será exibida uma mensagem de confirmação, antes da execução do processo:
Se ocorrer alguma falha no processo de agendamento, uma mensagem de erro será exibida, conforme o exemplo abaixo:
Se o tipo de processo selecionado já tiver um agendamento configurado, uma mensagem de confirmação será exibida ao usuário, sugerindo a possibilidade de sobrescrever as informações existentes.
Para consultar os agendamentos configurados é necessário acessar o menu: Agendamento de processo > Agendamentos:
Neste menu, você poderá consultar todos os agendamentos realizados.
Os agendamentos de cada processo serão organizados por fila, apresentando as seguintes informações nas colunas:
Expandindo a linha do agendamento, é possível visualizar os dados de cada processo, incluído a mensagem de retorno de cada envio:
Para facilitar a visualização, o usuário poderá utilizar o Filtro (por status), localizado no canto superior direto da tela.
Para realizar um cancelamento, o usuário deve acessar o menu de agendamentos, selecionar o agendamento desejado e clicar no botão "Cancelar", conforme na imagem abaixo.
Será exibida uma mensagem de confirmação para validar o cancelamento.
Ao confirmar, o status, dados, hora e responsável pelo agendamento serão registrados.
Para reagendar o processo, é necessário realizar novamente o procedimento de agendamento.
Foi disponibilizado o serviço Concliliador.Sevice nos Serviços do Windows para que seja realizada a execução dos Processos Agendados, o mesmo deverá estar sempre executando.
Funcionalidades do menu Transação
Pré-requisitos
Executar os processo de importação de dados (Integrador), para identificar se as vendas que aconteceram no VTEX tem registro de extrato relacionado no GetNet e vice-versa.
Detalhamento do Processo
A interface de conciliação VTEX x GetNet x Protheus poderá ser acionada através do menu lateral chamado Transação. Será exibida a lista de pedidos e suas informações (GetNet, VTEX e Protheus) e os status das conciliações dos dados. O usuário terá a opção de expandir os dados das vendas do VTEX, do extrato GetNet e dos títulos do Protheus, vinculadas através do número do pedido e seus respectivos status de Conciliação.
Ao acessar este menu, será exibida interface com opções de filtros disponíveis para exibição dos registros, que serão:
Esta interface lista todas as transações de crédito, cancelamento e chargeback. O filtro da interface ficou definido da seguinte forma:
Importante:
Nenhum filtro será obrigatório. Caso o usuário deseje informar apenas as datas ou apenas o número do pedido, serão exibidos todos os dados referentes à data e pedido selecionado.
Após seleção dos filtros, será exibida a lista de transações/pedidos conforme valores informados pelo usuário. A relação de informações será exibida nos blocos de informações (GetNet, VTEX, Protheus e Conciliação) conforme os seguintes tipos de transação abaixo.
Transações dos tipos Crédito à vista, Crédito Parcelado Lojista e Crédito Parcelamento Administradora
Será exibido as informações dos títulos/parcelas agrupadas por Pedido. Ao expandir, exibe as informações das caixinhas abaixo:
As transações de Cancelamento e Chargeback podem ser agrupadas, da mesma forma como ficam as transações de crédito, já que no momento do cancelamento a GetNet devolve os dados de todas as parcelas relacionadas. O que não podem ser agrupados são os pagamentos, que são efetuados por parcela, mês a mês (interface Recebimentos).
Portanto, na linha de resumo da Transação (pedido) cancelada, será exibida apenas uma transação com o detalhamento das parcelas que compõem a transação no bloco GetNet (expandir o registro).
Além disso, será necessário mostrar o bloco GetNet para essas transações. No escopo original, o bloco VTEX não seria exibido para para transações de cancelamento e chargeback. No entanto, com a mudança na busca dos dados, será necessário exibir o bloco com as seguintes informações:
Funcionalidades do menu Conferir Manualmente
Detalhamento do Processo
O botão Conferir Manualmente está disponível na interface de Conciliação de Transação no portal Conciliador e o usuário poderá alterar o status da conciliação manualmente (GetNet x VTEX e GetNet x Protheus), nos casos em que as transações não tenha sido conciliadas automaticamente, pelo portal conciliador.
Ao clicar neste menu, a customização irá habilitar uma caixa de texto para o usuário preencher alguma observação na transação e salvar. Neste momento, os status da conciliação (GetNet x VTEX e/ou GetNet x Protheus) serão alterados para Conferido Manualmente e ficarão visíveis na página inicial da transação.
Através desta mesma interface será possível visualizar as observações já preenchidas.
Funcionalidade do menu Recebimentos
Detalhamento do Processo
A Interface de Recebimentos esta disponível no portal Conciliador através do menu lateral, ao clicar neste menu será exibidos os dados do extrato GetNet referentes aos pagamentos efetuados para o SENAI, de forma resumida, com opção de expandir o registro para visualização dos detalhes importados do GetNet, Protheus e sua Conciliação. Cada pagamento precisa ter um título correspondente no Protheus.
Para conciliação diária de recebimentos, é necessário verificar quais são os registros de pagamento obtidos no extrato GetNet, os registros referentes aos descontos realizados pela GetNet em decorrência de cancelamento ou chargeback e os títulos relacionados a todas essas transações/pagamentos (contas a pagar e receber).
Ao acionar a interface de Conciliação de Recebimentos, será possível visualizar os dados dos pagamentos do extrato GetNet, crédito ou débito, obtidos através da API GetNet de solicitação de extrato eletrônico, e seus respectivos títulos gerados no Protheus, obtidos através das APIs Protheus (a pagar e a receber). As informações desta interface não serão agrupadas por Pedido, como acontece com a interface de Conciliação das Transações. Na tela inicial, será exibida uma linha para cada pagamento/título identificado.
Ao acessar, será exibida interface com opções de filtros disponíveis para exibição dos registros, que serão:
Ao digitar na caixinha, a pesquisa é feita automaticamente a partir dos registros existentes na tela.
Ao clicar em busca avançada, é exibida interface que possibilita fazer um filtro mais detalhado, conforme campos disponíveis abaixo:
Ao expandir o registro, serão detalhadas as informações da GetNet e Protheus, além dos dados da Conciliação, conforme abaixo:
Ao clicar na seta para expandir, os dados são exibidos conforme abaixo:
Detalhamento do Processo
Ao importar os títulos do Protheus, o usuário deverá realizar a conferência dos dados de pagamentos GetNet e título Protheus e atualizar o status da conciliação automaticamente, de acordo com o tipo de transação (crédito, cancelamento ou chargeback). Todo título gerado no Protheus referente a um pedido no VTEX, precisa ter um registro de pagamento correspondente no extrato GetNet. Quando o pagamento é identificado, a baixa precisa ser enviada para o Protheus após fechamento dos valores de conciliação do dia.
Para vendas realizadas pelo SENAI Nacional, a integração financeira com o Protheus Nacional gera um título a receber para cada parcela com a operadora de cartão em nome do cliente GetNet, com seu respectivo valor de taxa (campo decréscimo - Protheus).
Para vendas realizadas por algum Regional ou Parceiro, a integração financeira com o Protheus Nacional gera um título a receber para cada parcela com a operadora de cartão, referente ao parcelamento da comissão, em nome do cliente GetNet, com seu respectivo valor de taxa e com o código do regional registrado no campo código do cliente origem.
Para casos de Cancelamento de vendas pelo SENAI Nacional, a integração financeira com o Protheus Nacional envia para o Protheus os títulos a pagar para a GetNet, parcela por parcela. Para cancelamento de vendas de um Regional ou Parceiro, também são gerados os títulos a pagar, porém, com o valor de cada parcela referente à comissão de venda, parcela por parcela.
Para casos de Chargeback de vendas do SENAI Nacional ou Regional/Parceiro, a integração financeira com Protheus Nacional envia para o Protheus os títulos a pagar para a GetNet, parcela por parcela, no valor total da venda. Neste caso, o repasse da devolução para o Regional é de responsabilidade do SENAI Nacional.
Abaixo estão listados as regras e os campos que serão exibidos para cada tipo de conciliação:
Pagamento SENAI Nacional
Nesta conciliação é necessário verificar:
Pagamento Regional/Parceiro
Nesta conciliação é necessário verificar:
I
Cancelamento Pagamento SENAI Nacional
Nesta conciliação é necessário verificar:
Cancelamento Pagamento Regional/Parceiro
Nesta conciliação é necessário verificar:
Chargeback Pagamento SENAI Nacional e Regional/Parceiro
Nesta conciliação é necessário verificar:
Caso o pagamento atenda aos itens citados acima em cada cenário, ele será gravado com status de Conciliado e status da baixa Pendente. Desta forma, esse título ficará apto a ser enviado para ser baixado no Protheus.
Detalhamento do Processo
O botão Conferir Manualmente está disponível na interface de de Pagamentos no portal, para os títulos que não foram conciliados ou baixados com sucesso automaticamente. Este botão ficará habilitado para usuário, apenas quando o título selecionado estiver com status de Conciliação diferente Conciliado ou Status de Baixa diferente de Baixado.
Caso positivo, ao clicar neste botão, a customização irá habilitar uma caixa de texto para o usuário preencher alguma observação no pagamento e salvar. Neste momento, o status da conciliação será alterado para Conferido Manualmente e o status de baixa do título será alterado para Baixa Manual e ficarão visíveis na página inicial de pagamento.
Este processo irá apenas alterar os status da conciliação e da baixa do título que estiverem com erro. Não será realizada nenhuma validação, exportação, importação ou processamento automático de informações de conciliação neste momento.
O processo de Extração de dados é acionado no Menu lateral que tem o mesmo nome: Extração de Dados:
Ao acessar o Menu será apresentado na tela os seguintes campos:
Ao clicar em Gerar arquivo é apresentado uma mensagem de informando que o tempo de geração vai depender do volume de dados do período selecionado. E quando finalizado o processo será apresentada uma notificação que a geração foi concluida.
Quando o arquivo é gerado, será apresentado no grid a linha com o nome do Arquivo, as datas de referencia, a data de execução e a ações (download e exclusão).
O usuário poderá selecionar o tipo do arquivo que deseja fazer o Download: CVC ou XLSX
No arquivo são apresentados os dados do recebimento.
Exemplo:
Os arquivos gerados, permaneceram no grid até que o usuário faça a exclusão. Para que isso acontece é necessário clicar no ícone de exclusão na linha do arquivo desejado:
Funcionalidade do menu Valores Diários
Detalhamento do Processo
A interface de Valores Diários deve realizar o somatório dos valores conforme abaixo, com regras diferenciadas para vendas de DN e DRs/Parceiros:
Total Recebimentos: São considerados os pagamentos de crédito (sinal +):
Vendas DN: somatório dos valores líquidos da parcela (valor bruto da parcela - valor da taxa).
Vendas DR: somatório dos valores líquidos da comissão (valor da comissão da parcela - valor taxa).
Total Descontos: São considerados os pagamentos de débito (sinal -):
Vendas DN: somatório dos valores líquidos da parcela (valor bruto da parcela - valor da taxa).
Vendas DR: somatório dos valores líquidos da comissão (valor da comissão da parcela - valor taxa).
Ao acessar a interface, o usuário poderá visualizar a lista de registros por data e preencher os campos necessários. Será uma visão, que listará os seguintes campos:
Importante:
Quando o valor depositado for igual a zero, não é necessário calcular a diferença. O limite máximo de abatimento diário é o valor de crédito do dia. Caso seja atingido ou ultrapassado o máximo, o valor depositado pelo banco é zero e deve ser informado manualmente nesta interface. Independente do valor de abatimento atingido, o extrato de pagamentos retorna sempre todos os registros a receber e os cancelamentos e chargebacks que deverão ser pagos (baixados).
Funcionalidades do menu Baixa de Títulos
Detalhamento do Processo
Enviar para o Protheus, através de API, a baixa dos títulos pagos ou descontados pela GetNet na data referenciada, já registrados nas interfaces de Recebimentos. Serão enviados todos os títulos associados aos Recebimentos: pagamentos do extrato GetNet a receber (crédito) ou a pagar (cancelamento e chargeback).
O menu Baixa de Títulos, estará disponível no portal conciliador, para o usuário enviar as baixas dos títulos diariamente para o Protheus e visualizar eventuais erros que possam ocorrer no processo.
Para executar o processo de baixa de títulos, o usuário deverá clicar no botão Executar Processo e informar uma data referência para envio da baixa para o Protheus.
Ao clicar em Executar, a customização só irá enviar a baixa dos títulos se o valor do banco estiver preenchido na interface Valores Diários para a data de referência selecionada. Não será validada a diferença entre o valor depositado no banco (informado pelo usuário) e os valores de pagamentos e cancelamentos.
Não será possível selecionar registros/títulos. Este processo deverá identificar todos os pagamentos efetuados pela GetNet na data referência (recebimentos e abatimentos), para então localizar os títulos correspondentes no Protheus para envio da baixa. Serão enviadas para o Protheus a baixa de todos os títulos cuja a data de pagamento da GetNet seja igual a data referência informada (a pagar e receber).
Ao acessar este menu, será exibida a interface com logs dos últimos processamentos feitos por data e tipo (pagar ou receber), com opção de reprocessamento em caso de erro, para execução manual.
Serão exibidos os dados:
Importante:
Foi adicionado um novo status para os registros de processamento de baixa, por data e tipo (pagar e receber):
Ao expandir (clicar na seta) o registro será exibida a lista dos títulos processados por data e tipo, seus respectivos status de baixa e mensagem de erro (quando existir), como detalhe do log do processo.
Caso exista pelo menos um título com status de Baixa com Erro, o status do processamento será Erro o usuário deverá processar novamente a data referência através desta interface. Nestes casos, serão enviadas novamente apenas as baixas dos títulos que ainda não foram baixados. Quando todos os títulos da data/referência estiverem baixados com sucesso, o status do processamento deve ser alterado para Sucesso. O usuário poderá visualizar o identificador do título com erro através desta interface, ao expandir o resumo da execução do processo. Após processamento, será gravado resumo do log do processo, status geral do processamento e status da baixa por título.
Importante:
A baixa parcial de títulos não será tratada nem travada neste escopo. É de responsabilidade do SENAI garantir que a regra de arredondamento seja a mesma no VTEX, GetNet e Protheus para não gerar diferença no Protheus.