Módulo Gerencianet Boleto para WHMCS
✓ 2.499 downloads realizados.
Capturas de tela
Funcionalidades
O módulo Gofas Gerencianet Boleto para WHMCS possui configuração simples, objetiva e focada em atender todos os modelos de negócio. Nos "bastidores" o módulo automatiza os principais processos, simplificando e cuidando de todos os detalhes da automatização de recebimentos.
✓ Boletos registrados sem taxas de registro/baixa;
✓ Juros e multas após o vencimento do boleto
✓ 2ª via automática com valor atualizado (cálculo de multa e juros) ao acessar a fatura
✓ Confirmação automática de pagamento, da baixa nas faturas pagas sem necessidade de configurações extras ou arquivos adicionais na pasta padrão "callback"
✓ Boleto com sua marca: logotipo e informações da sua empresa
✓ Informações do boleto diretamente na fatura, sobre desconto, taxas, cálculos entre outras informações.
✓ Linha digitável do boleto na fatura, com opção de copiar apenas com um clique
copiar apenas com um clique.
✓ Informações do boleto nos Emails. Opcionalmente, o módulo gera o boleto quando a fatura é gerada e fornece mergetags para inserir nos templates de email do WHMCS, que exibem diretamente no corpo do email das faturas, a linha digitável, link para versão em HTML e PDF, data de vencimento, ID do boleto, entre outras informações (veja a lista completa em "Instalação"). O cliente pode realizar o pagamento, sem precisar acessar o WHMCS;
✓ Link direto para o Boleto (sem redirecionamentos), utilizando a tag padrão {$invoice_link} dos templates de email. Essa opção substitui automaticamente os links das faturas nos emails, pelo link direto para o Boleto, sem necessidade de redirecionamentos, autenticação e nem mesmo editar os templates de email;
✓ Redireciona para o boleto, ao acessar a fatura (opcional). Ideal para fornecer acesso rápido e autenticado aos boletos via links de faturas no email, em conjunto com o Módulo Auto Login para WHMCS. Também é possível redirecionar para o Boleto apenas adicionando o parâmetro redirectToBillet=true no URL da fatura (e desativa ao adicionar redirectToBillet=false), veja exemplos neste artigo.
✓ Dispensa configurações de campos personalizados (CPF/CNPJ), o módulo detecta automaticamente os campos personalizados de clientes
✓ Notifica administradores do WHMCS por email, sobre erros ao gerar boletos, ideal para agilizar o diagnóstico antes do cliente acionar o suporte.
✓ Imagem personalizada para o botão "Finalizar Pagamento".
✓ Desconto por método de pagamento, fixo ou em porcentagem, para todos boletos gerados por este método de pagamento.
✓ Desconto antes do vencimento, permite definir até quantos dias antes do vencimento da fatura o desconto deve ser aplicado ao Boleto.
✓ Descontos personalizados, fixo(R$) ou em porcentagem(%) diretamente no perfil de clientes específicos via campos personalizados
✓ Configuração de tarifa adicional, fixo(R$) ou em porcentagem(%)
✓ Cancela o Boleto automaticamente. Agora o módulo possui mais opções de cancelamento remoto dos boletos, ao cancelar a Fatura no WHMCS, quando um boleto já venceu no momento em que uma segunda é gerada e também, manualmente diretamente no painel do WHMCS, através do módulo addon incluso no download
✓ Aviso de atualização e verificação de versão diretamente na tela de configuração do módulo.
✓ Configuração mais simples e intuitiva. Agora selecionar os campos de perfil do cliente, departamentos de suporte, etc, é realizado num menu suspenso(dropdown), ao invés de definir ID ou qualquer informação confusa e complexa de obter, como era no passado.
✓ E muito mais...
Documentação
Requisitos do sistema: PHP >= 7.1.+, WHMCS >= 7.10.+
- Baixe, descompacte o arquivo
gofasgerencianetboleto.zip Copie o arquivo/modules/gateways/gofasgerencianetboleto.phpe o diretório/modules/gateways/gofasgerencianetboleto/, (encontrados na pasta recém descompactada) para dentro do diretório de gateways do WHMCS: /modules/gateways/;- Ative o módulo na interface administrativa do no menu `Opções > Pagamentos > Portais para Pagamentos > Aba All Payment Gateways`.
Pré Configuração
- Depois de ativar o módulo Gateway e o Addon no WHMCS, faça login na sua conta Gerencianet, acesse API > Minhas Aplicações > Nome da Aplicação para criar sua Aplicação e gerar as credenciais
Client IDeClient Secret; - Veja nesta imagem onde encontrar essa opção no antigo painel de controle Gerencianet e neste imagem onde se encontra essa opção na versão mais recente do painel de controle
- No painel de controle WHMCS, navegue até
Opções > Pagamentos > Portais para Pagamento > All Payment Gatewayse clique "Gofas Gerencianet - Boleto"para ativar o módulo; - Crie um campo personalizado de cliente para CPF e/ou CNPJ, ou se preferir, criar dois campos distintos, um campo apenas para CPF e outro campo para CNPJ. O módulo identifica os campos do perfil do cliente automaticamente
Opções do Módulo
Veja uma demonstração da tela de configurações do módulo clicando aqui.
- Client_Id Produção: (Obrigatório) Cole a Client_Id encontrada na aba Produção da sua aplicação;
- Client Secret Produção: (Obrigatório) Cole a Client Secret encontrada na aba Produção da sua aplicação;
- Client_Id Desenvolvimento: (Obrigatório) Cole a Client_Id encontrada na aba Desenvolvimento da sua aplicação;
- Client Secret Desenvolvimento:(Obrigatório) Cole a Client Secret encontrada na aba Desenvolvimento da sua aplicação;
- Administrador do WHMCS: (Obrigatório) Defina o administrador com permissões para utilizar a API interna do WHMCS;
- Modo de Testes / Sandbox: Marque essa opção para alternar entre o modo Desenvolvimento e Produção;
- Modo Diagnóstico / Debug: Marque essa opção para exibir resultados e erros retornados pela API Gerencianet e API interna do WHMCS. Use isso apenas em modo de testes ou se precisar diagnosticar erros;
- Salvar Logs: Salva informações de diagnóstico no menu Utilitários > Logs > Log de Módulo do painel de controle do WHMCS. Para essa opção funcionar, é necessário acessar Utilitários > Logs > Log de Módulo e ativar o debug de módulo clicando em "Ativar Log de Debug";
- Administrador do WHMCS: (Obrigatório) Insira o nome de usuário ou ID do administrador com permissão de uso da API interna do WHMCS;
- Valor da tarifa por Boleto: (Opcional) Insira o valor da comissão paga à Gerencianet a cada Boleto com pagamento confirmado. Esse valor não será somado ao total do boleto, servirá apenas para calcular e preencher o campo "Taxas" (fee) da lista de transações do WHMCS. Use ponto(.) para separar casas decimais, ex.: 1.5;
- Valor mínimo do Boleto: (Opcional) Insira o valor mínimo da fatura para permitir pagamento via Boleto, 5 equivale à R$ 5,00. O valor mínimo padrão é R$5,00. Use ponto(.) para separar casas decimais, ex.: 1.5;
- Informações do Boleto no email: Adiciona link, linha digitável, vencimento e outras informações do boleto no corpo dos emails de faturas. Essa opção faz o módulo gerar os boletos no momento em que a fatura é gerada, (do contrário o Boleto é gerado no 1º acesso à Fatura). Veja abaixo, nas configurações do addon, a lista de tags disponíveis.
- Substituir link da fatura por link do boleto: Substitui o URL da Fatura pelo URL do Boleto nos emails de "Nova Fatura" (tag
{$invoice_link}do template de email Invoice Created). - Cancelar Boleto ao cancelar Fatura: (Opcional) Cancela o Boleto associado à uma fatura quando essa fatura é cancelada no WHMCS;
- Cancelar Boleto Vencido: (Opcional) Cancela o Boleto gerado anteriormente pela Fatura antes de gerar novo Boleto/segunda via. Sem essa opção definida, o módulo altera a data de vencimento do Boleto vencido associado à Fatura, ou gera um novo boleto mas não altera o status do Boleto anterior;
- Dias adicionais para nova data de vencimento de Boletos: Número de dias que serão somados a data do vencimento do Boleto ao gerar segunda via ou atualizar um boleto vencido. Essa opção aplica-se apenas a Faturas vencidas, faturas que ainda não venceram sempre irão gerar Boletos com a mesma data de vencimento da Fatura;
- Notificar admins do WHMCS sobre erros: Escolha o departamento de suporte que receberá notificação por email quando houver erros ao gerar o boleto. Esse recurso possibilita uma tomada de ação antes que o cliente contacte o suporte ou desista da compra, como por exemplo, quando o boleto não é gerado por um erro de cadastro do cliente;
- Tipo de Desconto Personalizado: Selecione o Campo Personalizado de Clientes que define o tipo de desconto personalizado em R$(Reais) e %(Porcentagem). Veja aqui como configurar os Campos Personalizados de Clientes;
- Valor do Desconto Personalizado: Escolha o Campo Personalizado de Clientes usado para aplicar descontos diferenciados para clientes específicos. Formato: Decimal, separado por ponto. Maior ou igual a 0.00 e menor que o valor da cobrança.
- Desconto ou Taxa adicional: Escolha de deseja oferecer desconto ou acrescentar taxa para pagamentos via Boleto;
- Tipo de desconto/taxa: Escolha se o desconto ou taxa será em Porcentagem ou em Reais;
- Valor do Desconto ou Taxa: Valor que será abatido ou acrescentado ao valor total das faturas;
- Validade do desconto: Defina o máximo de dias antes do vencimento para aplicar desconto.
- Deixe em branco para aplicar desconto mesmo após o vencimento;
- Insira 0 (zero) para aplicar desconto a Boletos gerados até a data de vencimento da Fatura;
- Insira de 1 a X, sendo X = ao nº de dias antes do vencimento, que as Faturas são geradas para aplicar desconto apenas a Boletos gerados entre 1 e X dias antes da data de vencimento da Fatura.
Ao ativar essa opção a data de vencimento do Boleto será igual a data de vencimento da Fatura - (menos) o nº de dias definido nesse campo. Será adicionada a instrução ao caixa "não aceitar pagamento após o vencimento"; - Multa após o vencimento: Multa cobrada após o vencimento (máximo 10%). Use ponto(.) para separar casas decimais, ex.: 1.5;
- Juros após o vencimento: Juros por dia cobrados após o vencimento (Mínimo de 0.001 e máximo de 0.33). Use ponto(.) para separar casas decimais;
- Exibir linha digitável: Exibe a linha digitável/código de barras do Boleto, abaixo do botão "visualizar boleto";
- Exibir data de Vencimento: Exibe a data de vencimento do Boleto na fatura, abaixo do botão "visualizar boleto";
- Exibir Desconto / Taxa na fatura: Assinale se desejar informar sobre o Desconto ou Taxa na fatura;
- Redirecionar para o Boleto: Redireciona o cliente diretamente para o URL do boleto ao acessar a fatura. Adicione &redirectToBillet=false ao URL da fatura para desativar em acessos específicos, exemplo: https://whmcs.gofas.net/viewinvoice.php?id=4800&redirectToBillet=false. Nos templates de email a mergetag ficaria desta forma: {$invoice_link}&redirectToBillet=false
- Imagem do botão "Visualizar Boleto": Insira o URL da imagem que será usada como botão "Visualizar Boleto" (tamanho recomendado: 160x43px);
- Mensagem ao cliente: Inclui no boleto uma mensagem personalizada para o cliente (máximo 80 caracteres);
- 1ª Instrução do boleto: Insira a 1ª linha de instruções do Boleto;
- 2ª Instrução do boleto: Insira a 2ª linha de instruções do Boleto;
- 3ª Instrução do boleto: Insira a 3ª linha de instruções do Boleto;
- 4ª Instrução do boleto: Insira a 4ª linha de instruções do Boleto;
Opções customizadas
Nessa sessão serão exibidas as opções personalizadas, que podem ser adicionadas com conhecimento básico em PHP e sem editar diretamente o código do módulo, como descrito neste tutorial.
Exibir informações do Boleto nos Emails
Antes de configurar os templates de email, tenha certeza de ter executado o segundo passo da sessão "Instalação" referente a instalação do Móduo Addon.
Com o módulo Gateway e o Addon ativados, você encontrará as tags de email disponíveis logo abaixo do editor dos templates de email do WHMCS:
Tags de mesclagem (mergetags) disponíveis:
{$ggnb_billet_info}: Exibe em conjunto todas as informações do boleto formatadas em um bloco HTML semelhante a tag padrão `{$invoice_html_contents}` (exemplo);
{$ggnb_link} - Exibe o link do Boleto. Pode ser utilizado em um botão de forma semelhante a esta: <a href="{$ggnb_link}">Visualizar Boleto</a>;
{$ggnb_pdf} - Exibe o link do Boleto em PDF;
{$ggnb_barcode} - Exibe a linha digitável do boleto (representação numérica do código de barras);
{$ggnb_expire_at} - Exibe a data de vencimento do Boleto;
{$ggnb_total} - Exibe o valor total do Boleto;
{$ggnb_charge_id} - Exibe o ID da transação registrada na API Gerencianet;
{$ggnb_api_mode} - Exibe sandbox para boletos gerados no modo de teste e live, para Boletos gerados no modo produção da API;
{$ggnb_debug} - Exibe informações de depuração no corpo do email (use apenas quando precisar coletar informações de diagnóstico);
Changelog
Unreleased
Implemented enhancements:
- Módulo agora gratuito. Não há mais comissionamento via marketplace #138
v3.4.0 (2021-10-07)
v3.3.1 (2021-07-09)
Implemented enhancements:
- Evita erro ao tentar atualizar a data de vencimento de boleto gerado a mais de 90 dias #137
- Incorporar changelog na documentação pública do módulo #136
- Automatizar a edição do changelog #135
Fixed bugs:
- Corrigida a conta de recebimento de repasses via marketplace para "Gofas Software" #134
* This Changelog was automatically generated by github_changelog_generator
v3.3.0
08/02/2021
- Agora você pode escolher duas formas de licenciamento: R$9,90/mês ou R$0,25/boleto recebido. A comissão de R$0,25 / boleto só é adicionada quando não houver uma licença ativa nas configurações do módulo. O módulo não para de funcionar sem a licença;
- Simplificação dos logs e debug, menos processamento de dados e maior desempenho em grande escala;
- User-Agent no header da requisição ao verificar atualizações no gofas.net;
v3.2.1
24/01/2021
- Melhoria: Garante a criação de boletos e inclusão dos dados nos emails das faturas recém criadas ao rodar o cron;
- Melhoria: Corrige formatação de itens de linha dos Boletos gerados por faturas mescladas, de acordo com as exigências da API Gerencianet;
- Melhoria: Corrige formatação de itens de linha dos Boletos gerados por faturas referentes a upgrades;
v3.2.0
22/10/2020
- Nova opção: 5 - Administrador do WHMCS - Define o administrador com permissões para utilizar a API interna do WHMCS. Evita erros ocasionados por alterações introduzidas no WHMCS v8.+.;
- Dispensa a necessidade de instalar o módulo addon Gerencianet para rodar as funções:
- 11 - Informações do Boleto no email;
- 12 - Substituir link da fatura por link do boleto;
- 13- Cancelar Boleto ao cancelar Fatura;
- Descontinuado e removido do pacote de download o módulo addon Gerencianet;
v3.1.0
08/10/2020
- Simplificação do método de adição de código customizado;
- Melhorias para garantir compatibilidade completa com WHMCS 8.0+ e o com o novo Auto Login para WHMCS v3.0+;
v3.0.3
- Corrigida a exibição de informações de diagnóstico na fatura com debug desativado (report 12954);
v3.0.2
- Melhoria na verificação de atualizações;
v3.0.1
- Agora descontos são exibidos no Boleto como itens de linha, tornando a aparência do boleto semelhante às faturas;
- Corrigido o erro 3500073 ao aplicar desconto aos boletos.
v3.0.0
- Eliminada a dependência da SDK Gerencianet para PHP, evitando erros comuns relacionados à incompatibilidade da biblioteca GuzzleHttp com versões específicas do PHP e WHMCS;
- Redução de 1,4MB para 426KB no tamanho do módulo;
- Módulo Addon agora cancela transações também do módulo Gerencianet Cartão para WHMCS;
- Corrigido bug que retornava em algumas situações, devido a conflito nas configurações, o erro "A data do vencimento deve ser maior que a data atual";
- Corrigido bug que podia impedir o módulo de obter sempre o boleto mais recente gerado por cada fatura, ao anexar informações do boleto aos emails.
- Corrigido bug que podia causar erro 404 em URL das imagens no admin antes de salvar as configurações;
v2.2.3
- Substituição de versão da SDK Gerencianet para corrigir erros relacionados à biblioteca guzzlehttp;
V2.2.2
- Configuração "Administrador do WHMCS" não é mais requerida para versões do WHMCS maiores que 7.2;
- Correção na numeração das opções presentes nas configurações do módulo.
- Atualizada a SDK Gerencianet para versão 2.4.0;
V2.2.1
- Informações do boleto no email. Agora em conjunto com o addon Gerencianet que acompanha o pacote de download, opcionalmente, o módulo gera o boleto quando a fatura é gerada e fornece mergetags para os modelos de email de faturas que, exibem diretamente no corpo do email enviado ao cliente, a linha digitável, link para versão em HTML e PDF, data de vencimento e ID do boleto.
- Link direto para o Boleto utilizando a tag padrão
{$invoice_link}dos templates de email. Essa opção substitui automaticamente os links das faturas nos emails, pelo link direto para o Boleto, sem necessidade de redirecionamentos ou autenticação; - Aviso de atualização e verificação de versão diretamente nas configurações do módulo;
- Campos de configurações customizadas (avançado). Agora é possível (com conhecimento básico em php), incluir , funções e alterar o funcionamento do gateway, sem editar diretamente o código original, apenas incluindo as customizações em pastas específicas do módulo. Dessa forma é possível atualizar o módulo no futuro sem perder as alterações. Como demonstração do funcionamento das opções personalizadas, oferecemos duas customizações cedidas generosamente pela Go Suite e mais uma customização criada por nós para contornar a situação descrita neste tópico do fórum. Vaja as customizações e saiba mais sobre como incluir configurações adicionais e manipular as variáveis do módulo neste artigo.
- – Debug no log de módulo do WHMCS. Agora o módulo além de exibir informações de diagnóstico na tela das faturas, também oferece a opção de salvar o debug no log de módulo do WHMCS;
- – Cancelar o Boleto anterior ao gerar um novo. Diferente da opção já existente que cancelava o boleto apenas quando já havia vencido;
- Cancela o Boleto ao cancelar Fatura. Dispensa a necessidade de acessar o painel de controle Gerencianet para cancelar um boleto, basta cancelar a fatura no WHMCS e o boleto associado à ela será cancelado também;
- – Melhoria nos cálculos de taxas, descontos, multa, juros, crédito e demais valores variáveis que devem ser calculados nas mais variadas hipóteses;
- – Exibe mais informações na Fatura, sobre descontos, multa , juros, taxas, etc;
- – Taxas exibidas como itens de linha no boleto;
- – Descrição do serviço agora são exibidas nas linhas/itens do Boleto quando há taxas adicionais configuradas (antes era exibido Fatura ID #XX)
- – Gera novo boleto ao aplicar crédito à fatura, (e cancela o anterior se a opção descrita no item 7 estiver ativada) ou quando o valor da fatura mudou e já existe um boleto associado à essa fatura;
- – Opções numeradas nas configurações, para localização mais rápida;
- – Mais opções de redirecionamento para o Boleto: Ao adicionar o parâmetro
redirectToBillet=trueno URL da fatura, o cliente será redirecionamento para o boleto ao acessar a fatura e ao adicionar o parâmetroredirectToBillet=falseno URL da fatura (se a opção de redirecionamento estiver ativada nas configurações do módulo), o redirecionamento da fatura para o boleto será desativado apenas para essa fatura. Muito útil para aditar os templates de email, adicionando regras de redirecionamento para o boleto específicas para cada situação
Exemplo: substitua a tag {$invoice_link} por {$invoice_link}&redirectToBillet=false nos templates de email e será formado um URL semelhante a este: https://whmcs.gofas.net/
viewinvoice.php?id=138&redirec tToBillet=false - Copiar a linha digitável do boleto com um clique;
- Copiar debug com um clique;
- Obtém CPF e CNPJ sem necessidade de configuração, agora o módulo detecta automaticamente os campos personalizados de cliente referentes ao CPF e CNPJ
- Selecionar os campos de perfil do cliente em um menu suspenso, quando requeridos nas configurações do módulo, ao invés de definir o nº de ordem , ID ou qualquer informação confusa ou complexa de obter como no passado, agora é exibido um menu com todos os campos personalizados existentes no WHMCS, onde o só admin só precisa selecionar o custom field;
- Selecionar o departamento de suporte com um clique na opção “Notificar suporte do WHMCS sobre erros” das configurações do módulo. Semelhante a opção anterior, agora o módulo obtém uma lista dos departamentos de suporte configurados para o administrador selecionar;
- Removida a opção CPF + CNPJ para Pessoa Jurídica por não ser mais obrigatória ao usar a API Gerencianet;
- Corrigido o link que aponta para a área do cliente em caso de erros, quando o admin do WHMCS não definiu nas configurações gerais do WHMCS o URL da instalação incluindo o diretório da instalação.
- Módulo Addon Gerencianet atualizado,
- Agora ele é compatível com as versões mais recentes do gateway e do WHMCS
- Traz os hooks necessários para ações em segundo plano (como gerar o boleto ao gerar a fatura)
- Corrigido o erro que estava atrapalhando o cancelamento dos Boletos a partir do ID da fatura
- Corrigido o erro que subtraia R$0,01 nos cálculos de juros + multa + taxa – desconto/crédito, em versões específicas do php e php-fpm;
- Melhoria no callback de boletos com desconto, agora o módulo edita a fatura adicionando um item de linha com o mesmo valor do desconto evitando que a fatura fique em aberto.
v1.2.3
- Configurações adicionais para corrigir o URL do sistema/WHMCS, nas mensagens de erro, quando a instalação do WHMCS está numa subpasta e o admin configurou o URL do sistemas nas configurações, sem essa subpasta.
v1.2.2
- Atualização da SDK Gerencianet;
v1.2.1
- Optimização e limpeza do código, reduzindo parâmetros que não são mais necessários e melhorando o desempenho de diversas funções;
- Corrigido o bug que poderia causar uma diferença de R$0,01 (um centavo) na confirmação de pagamento;
- Agora quando o valor do pagamento realizado é maior que o valor total da fatura( devido à adição de taxas, multa e/ou juros ao boleto, por exemplo), antes de dar baixa no pagamento, ao processar o callback, o módulo edita a fatura adicionando um novo item com a descrição “Acréscimo” e o valor de diferença entre o total da fatura e o valor pago. Dessa forma os valores das transações passam a ser o mesmo valor do pagamento.
v1.1.0
- Agora nomes de itens de serviços/produtos da Fatura é limitado à 255 caracteres, caracteres adicionais são removidos para evitar o erro "A string é muito longa, máximo 255 caracteres: /items/0/name";
- Correção do link da imagem de exemplo nas configurações do módulo, referente aos campos personalizados de desconto;
- Outras melhorias nos textos explicativos das configurações do módulo;
- Atualização da SDK Gerencianet da versão 1.0.11 para a versão 2.0.0. A partir de agora o módulo obrigatoriamente requer php versão 5.5 ou maior;
v1.0.3
- Correção: Corrigido o bug que ignorava os centavos do desconto personalizado inserido na versão 1.0.2.
v1.0.2
- Nova funcionalidade: Valor do desconto personalizado. Agora você pode criar um custom_field visível apenas para admins do WHMCS e determinar o valor do desconto personalizado para clientes específicos. Para ativar essa opção e aplicar o desconto ao Boleto, basta preencher esse campo com a “Ordem de Exibição” do campo personalizado de cliente “Valor do desconto”;
- Nova funcionalidade: Tipo de desconto personalizado. Assim como o valor de desconto personalizado citado acima, agora você pode criar um campo personalizado para determinar o tipo de desconto que algum cliente específico vai receber no Boleto. Para ativar essa opção, você precisa criar um custom_field do tipo “Lista de opções” com as duas opções de tipo de desconto, Reais (R$) ou Porcentagem (%), depois disso, basta preencher esse campo nas configurações do módulo com a “Ordem de Exibição” do campo personalizado de cliente “Tipo de desconto”. Use os sinais $ e % nos nomes das opções dos custom_fields;
- Nova funcionalidade: Validade do desconto. Agora o módulo possui um campo de texto nas configurações onde é possível determinar o número de dias antes do vencimento, que o desconto deve ser aplicado, ex.: “Oferecer desconto para pagamento até 5 dias antes do vencimento”;
- Prevenção: Reformulação completa da tela de configurações do módulo, com ainda mais explicações, links para mais informações e tutoriais. Configurações opcionais e obrigatórias agora são diferenciadas pelas cores verde e vermelho para facilitar o entendimento e as configurações foram divididas em sessões;
- Diagnóstico: Debug agora inclui mais informações úteis para a identificação de erros de integração;
- Melhoria: Foram acrescentadas verificações que previnem possíveis erros ao aplicar desconto aos Boletos, descobertos em instalações que utilizam configurações de desconto juntamente com configurações de multa e juros;
- Melhoria: Agora o link para visualizar o Boleto abre em uma nova guia do navegador, mantendo a página da Fatura aberta lado a lado com a visualização do Boleto;
- Melhoria: Agora o módulo é capaz de identificar se as transações associadas à Fatura foram geradas em modo Live ou Sandbox, transações geradas por outros módulos são ignoradas. Essa opção previne um dos erros mais comuns da API Gerencianet, o erro “Tentativa de obter detalhes da transação, mas informou um charge_id incorreto“, relacionado diretamente a forma errada de manejar as Faturas associadas aos Boletos;
- Melhoria: Agora o módulo verifica o status da transação antes de consumir a API Gerencianet, evitando o erro “Apenas transações com status [new], [link], [waiting] ou [unpaid] podem ser canceladas” retornado quando o usuário do módulo esquece de excluir as transações associadas à Fatura, antes de gerar um novo Boleto ou ao alternar do modo Desenvolvimento (sandbox) para produção (live);
- Melhoria: O código está mais eficiente, organizado e preparado para novas atualizações.
0.2.7
- Callback: Verifica se um admin foi definido nas configurações do módulo, caso contrário, atribui o usuário ID 1 a operação.
0.2.6
- Melhorias na verificação da origem da requisição ao script do módulo,
para impedir que as funções do módulo sejam executadas ao gerar faturas
e/ou emails em massa, evitando assim a interrupção de processos em
massa ao invocar o módulo.
0.2.5
- Agora cupons de desconto (itens com valor negativo na fatura) são adicionados ao campo "desconto" padrão da API Gerencianet, somados ao desconto configurado no módulo (se configurado).
Essa atualização corrige o erro "O valor -XXX é menor que o mínimo 0" retornado pela API Gerencianet.
0.2.4
- Corrige erro que em alguns casos pode gerar mais de um Boleto para cada fatura;
- Adiciona novas linhas ao debug para diagnóstico específico dos campos CPF e CNPJ;
0.2.3
- Nova opção: Valor da tarifa por Boleto. Agora é possível configurar o valor relativo à comissão paga à Gerencianet a cada Boleto com pagamento confirmado. Essa informação servirá para calcular e preencher o campo "Taxas" (fees) da lista de transações, fazendo o cálculo do valor líquido recebido via Boletos;
- Nova opção: Mensagem ao cliente. Agora é possível configurar uma mensagem personalizada com até 80 caracteres, que será exibida entre o cabeçalho e o descritivo do Boleto com o título "Observação". O intuito dessa nova funcionalidade é que não seja necessário utilizar as linhas de instrução para mensagens direcionadas ao cliente, afinal, as linhas de instrução são mensagens destinadas ao Caixa e não devem ser utilizadas para outro propósito;
- Nova opção: Multa após o vencimento. Agora é possível configurar multa em percentagem (%), que será adicionada ao valor total do Boleto quando o mesmo for gerado após o vencimento e também adiciona instruções ao Caixa informando a multa;
- Nova opção: Juros por dia após o vencimento. Agora é possível configurar juros por dia em percentagem (%), que será adicionado ao valor total do Boleto quando o mesmo for gerado após o vencimento e também adiciona instruções ao Caixa informando sobre os juros;
- Melhoria: Agora a opção "Dias adicionais à data de vencimento do Boleto" permite gerar o Boleto com vencimento para a mesma data que foi gerado, ao configurar essa opção com 0 (zero).
- Melhoria: Textos explicativos das configurações foram reformulados e as configurações mais sensíveis contém links com mais informações;
- Melhoria: Modo debug agora contém mais explicações, links para artigos com mais informações e destaca as mensagens de erro em letras vermelhas para localização mais rápida do trecho onde o script foi interrompido;
- Melhoria: Otimização e revisão completa do código, agora trechos do script que eram repetidos em situações diferentes foram convertidos em funções, que podem ser executadas separadamente e em casos diferentes apenas alterando os argumentos;
- Melhoria: Callback agora inclui um debug completo do recebimento da notificação, verificação dos dados do Boleto e da Fatura (GN API e WHMCS API). O resultado do recebimento de notificações pode ser visualizado na sua conta Gerencianet > API > Aplicação > Produção ou Desenvolvimento > Histórico de Notificações;
- Corrigido o bug que adicionava o valor da taxa do Boleto com crédito ao cliente, após a confirmação do pagamento;
- Corrigido o bug que adicionava/abatia o valor da taxa ou desconto fixo (R$) de cada item da fatura, especificamente quando o admin configurava taxa ou desconto fixo e o sistema gerava faturas com mais de um item;
0.2.2
- Evita falhas ao gerar a data de vencimento do Boleto quando o admin não configura ou configura com 0(zero) a opção "Dias adicionais à data de vencimento do Boleto";
- Alerta nas configurações que as opções "Debug" e "Redirecionar para o Boleto" não podem ser usadas simultaneamente;
- Melhora mensagens de erro atualizadas na API Gerencianet;
0.2.0
- Agora os Boletos são gerados apenas quando o cliente acessa a Fatura;
- Agora quando uma fatura é acessada após o vencimento, o Boleto gerado anteriormente tem a data de vencimento atualizada, ao invés de gerar um novo boleto;
- Nova opção: Cancelar o boleto vencido e gerar um novo. Ao marcar essa opção, quando o cliente acessar uma Fatura vencida o módulo vai cancelar o Boleto associado à ela e gerar um novo;
- Adicionada a capacidade de reportar todos os erros e avisos do php, independente da configuração do servidor;
- Melhorias de segurança;
- Melhorias de compatibilidade com PHP < 5.6;
- Melhorias no callback, como a adição de um debugque grava as respostas do servidor nos logs das transações na API Gerencianet;
0.1.9
- Corrige erro "Fatal error: Class 'Gerencianet\Gerencianet' not found " quando o boleto é gerado no fluxo de contratação do WHMCS;
0.1.8
- Nova opção: Valor mínimo para aceitar pagamentos via boleto;
- Nova opção: Dias adicionais à data de vencimento do Boleto. Se aplica a faturas vencidas, faturas que não venceram geram boletos com a mesma data de vencimento da fatura;
- Nova opção: Desconto ou Taxa adicional, em R$ (reais) ou % (porcentagem);
- Nova opção: Exibir Desconto ou Taxa na fatura;
- Nova opção: Novos campos para adicionar as credenciais Client_Id e Client_Secret de Desenvolvimento. Agora para alternar rapidamente entre Desenvolvimento/Produção basta assinalar/desassinalar a opção "Sandbox";
- Melhoria: Exibir Data de vencimento e Linha digitável agora são duas opções distintas e podem ser configuradas separadamente;
- Nova opção: Agora é possível configurar apenas um campo personalizado para CPF ou CNPJ, o módulo reconhece o tipo de documento e gera a cobrança como pessoa física ou jurídica de acordo com o documento informado. Ainda é possível utilizar dois campos, um campo para cada documento;
- Melhoria: Ao gerar uma cobrança como Pessoa Jurídica (CNPJ), se o cliente não preencheu o campo "Empresa", o módulo preenche esse campo automaticamente com o Nome e Sobrenome do cliente, evitando erros de validação da API Gerencianet;
0.1.7
- Agora não é mais obrigatório enviar o nome e CPF do cliente quando a cobrança é para Pessoa Jurídica, por padrão, o módulo vai ignorar o CPF se eles estiver incorreto ou ausente;
- Adicionada a opção "Exigir CPF e CNPJ de Pessoa Jurídica", no caso do admin desejar tornar obrigatório o envio também do nome e CPF da pessoa física que está concretizando o pagamento em nome da empresa, nesse caso será exibido um erro se o CPF ou o CNPJ estiverem incorretos;
- Agora se ocorrer um erro ao gerar Boleto devido ao CNPJ do cliente estar incorreto, o sistema vai tentar gerar o boleto com o CPF antes de exibir um erro;
- Adicionada a opção "Mostrar erro "CNPJ incorreto", no caso do admin desejar exibir um erro quando a cobrança não é realizada devido a CNPJ inválido, do contrário, o sistema tenta associar a cobrança ao CPF do cliente no caso de CNPJ incorreto ou ausente, como descrito na feature anterior;
- Agora o módulo adiciona um 0 (zero) no começo do CPF se esse tem 10 dígitos, como forma de impedir o erro "CPF Incorreto". O motivo dessa feature é por que muitas vezes que o CPF do cliente inicia com dígito zero, ele acredita que não precisa preencher esse dígito;
- Agora o módulo adiciona um 0 (zero) no começo do CNPJ se esse tem 13 dígitos, como forma de impedir o erro "CNPJ Incorreto" ou associar o Boleto ao CPF do cliente. O motivo dessa feature é o mesmo da anterior;
0.1.6
- Quando ativo o Debug é exibido apenas na visualização da fatura e não no admin;
- Quando ativo o Redirecionamento da fatura para o boleto só ocorre na visualização da fatura e não no admin.
0.1.5
- Adicionadas as opções "Ordem do campo CPF" e "Ordem do campo CNPJ" às configurações do módulo, que permitem apontar a ordem de exibição dos campos personalizados;
- Melhorias nos textos, adição de links e nova ordem das opções do módulo, tornando-o ainda mais intuitivo;
0.1.4
- Adicionada a opção de redirecionar o link da fatura diretamente para o URL do boleto;
- Melhoria na opção de envio de email em caso de erro, agora é possível escolher o departamento de suporte que será notificado.
0.1.3
- Agora o cliente associado à transação pode ser uma Pessoa Jurídica. Nesse caso, além do CPF, devem ser informados a Razão Social e o CNPJ da empresa. Se os campos Empresa e CNPJ (segundo campo personalizado) estiverem preenchidos no perfil do cliente o boleto será gerado com as informações de pessoa jurídica, se algum desses dois capos estiver em branco, o boleto será gerado com as informações de pessoa física.
0.1.2
- Adicionada a opção de notificar o admin por email em caso de falha ao gerar o Boleto;
- Removido o comando
gettransactionsque consultava transações geradas pela fatura atual, a consulta por transações agora é realizada analisando o resultado do comandogetinvoice.
0.1.1
- Redução de variáveis desnecessárias tornando a validação de dados mais rápida e eficaz;
- Debug mais completo: adicionadas novas informações de resultados às consultas às APIs;
0.1.0
- Lançamento
- A tarifa do Boleto paga separadamente à Gerencianet é de R$2,99 para usuários do módulo Gofas Gerencianet Boleto para WHMCS;
- Sempre faça backup antes de mudar algo em seu sistema.
- Para evitar erros ao editar os templates de email, por copiar e colar texto com formatação no editor de texto do WHMCS, abra o editor HTML e copie o template para um editor de código (Dreamweaver ou Brackets por exemplo), edite, abra novamente o editor de HTML dos templates de email do WHMCS e cole o modelo atualizado. Veja na imagem abaixo onde encontrar o editor HTML dos templates de email;
- Configurações Personalizadas e alterações no funcionamento do módulo podem ser realizadas, sem editar o código original, podendo atualizar o módulo no futuro sem perder suas customizações.
Para mais informações consulte o Tutorial: Adicionar configurações customizadas ao Módulo Gerencianet Boleto para WHMCS; - Para Diagnosticar Erros em mais detalhes, consulte o tutorial: Diagnosticar erros do módulo Gerencianet Boleto para WHMCS;
Erros comuns:
Além dos códigos de erro GN API, fornecemos mensagens de erro específicos do módulo, humanamente entendíveis, para facilitar o diagnóstico e solução de dificuldades.
Erros que necessitam da interação do cliente não mostram códigos na tela, como no caso de CPF ou outras informações cadastrais inválidas, nesse caso é exibida uma mensagem personalizada com instruções e o link direto para a edição do cadastro, para que o próprio cliente possa alterar suas informações cadastrais e continuar o pagamento, sem ter de acionar o suporte.
Opcionalmente, você pode configurar o módulo para disparar um email ao departamento de suporte encarregado cada vez que um dos seus clientes ver um erro ao gerar o boleto, essa é uma ótima forma de identificar e corrigir o erro antes do cliente acionar o suporte e assim minimizar o impacto negativo que erros de aplicações podem causar :P. A seguir você confere os erros mais comuns e como são impressos na tela:
Tela branca ou erro 500, veja o artigo: Como resolver o Erro 500, tela branca e os “falsos erros” do WHMCS;
- "Erro de comunicação na 1ª conexão com a GN API".
Acontece no momento de verificar se a fatura atual já gerou algum boleto.
Solução: Verifique as os suas credenciais (client_id e client_secret) e as configurações do módulo, lembre-se de que as credenciais são diferentes para o ambiente de produção e desenvolvimento; - "Falha ao gerar a transação, na 2º conexão com a GN API". Significa que o sistema constatou que não há nenhum boleto dentro do prazo de vencimento associado a fatura atual, mas não conseguiu gerar a transação. Verifique se os campos "Descrição" e "Valor total" da fatura estão configurados corretamente;
- "Erro de comunicação na 2º conexão com a GN API".
Significa que o sistema constatou que não há nenhum boleto dentro do prazo de vencimento associado a fatura atual, mas não conseguiu se conectar novamente para gerar a transação. Ative a opção "Debug" do módulo para diagnosticar com maiores detalhes; - "Erro de comunicação na 3º conexão com a GN API".
Acontece no momento em que seria gerado o Boleto. Ative a opção "Debug" do módulo para diagnosticar com maiores detalhes; - "Não foi possível gerar o boleto porque o seu CPF está incorreto."
"Não foi possível gerar o boleto porque o seu Telefone está incorreto." - "Não foi possível gerar o boleto porque o seu Nome e/ou Sobrenome estão incorretos."
Você precisa fazer login para comentar.