Merge pull request #1302 from itflow-org/feat-recurring-invoice-auto-send-toggle

Add ability for recurring invoices to be generated as draft to allow review and amendment prior to sending

admin/database_updates/2.7.9.php

@@ -0,0 +1,14 @@
+<?php
+
+/*
+ * ITFlow - Database update to version 2.7.9 (from 2.7.8)
+ * Included by admin/database_updates.php - do not access directly
+ */
+
+defined('FROM_DB_UPDATER') || die("Direct file access is not allowed");
+
+    // Add auto-send option to recurring invoices (default to enabled) or whether they should be generated as drafts for manual review & sending
+
+    mysqli_query($mysqli, "ALTER TABLE `recurring_invoices`
+        ADD COLUMN `recurring_invoice_auto_send` tinyint(1) NOT NULL DEFAULT 1 AFTER `recurring_invoice_note`
+    ");

agent/modals/recurring_invoice/recurring_invoice_edit.php

@@ -9,7 +9,8 @@ $recurring_invoice_id = intval($_GET['id']);
 $sql = mysqli_query($mysqli, "SELECT recurring_invoice_category_id, recurring_invoice_client_id, recurring_invoice_created_at,
     recurring_invoice_discount_amount, recurring_invoice_frequency,
     recurring_invoice_next_date, recurring_invoice_number, recurring_invoice_prefix,
-    recurring_invoice_scope, recurring_invoice_status FROM recurring_invoices WHERE recurring_invoice_id = $recurring_invoice_id LIMIT 1");
+    recurring_invoice_auto_send, recurring_invoice_scope, recurring_invoice_status
+     FROM recurring_invoices WHERE recurring_invoice_id = $recurring_invoice_id LIMIT 1");
 
 $row = mysqli_fetch_assoc($sql);
 $recurring_invoice_prefix = escapeHtml($row['recurring_invoice_prefix']);
@@ -19,6 +20,7 @@ $recurring_invoice_frequency = escapeHtml($row['recurring_invoice_frequency']);
 $recurring_invoice_status = escapeHtml($row['recurring_invoice_status']);
 $recurring_invoice_created_at = date('Y-m-d', strtotime($row['recurring_invoice_created_at']));
 $recurring_invoice_next_date = escapeHtml($row['recurring_invoice_next_date']);
+$recurring_invoice_auto_send = intval($row['recurring_invoice_auto_send']);
 $recurring_invoice_discount = floatval($row['recurring_invoice_discount_amount']);
 $category_id = intval($row['recurring_invoice_category_id']);
 $client_id = intval($row['recurring_invoice_client_id']);
@@ -101,11 +103,22 @@ ob_start();
             </div>
         </div>
 
+        <div class="mb-3">
+            <label>Action <strong class="text-danger">*</strong></label>
+            <div class="input-group">
+                    <span class="input-group-text"><i class="fa fa-fw fa-paper-plane"></i></span>
+                <select class="form-select select" name="auto_send" required>
+                    <option <?php if ($recurring_invoice_auto_send == 1) { echo "selected"; } ?> value="1">Send Automatically</option>
+                    <option <?php if ($recurring_invoice_auto_send == 0) { echo "selected"; } ?> value="0">Generate Draft for Review</option>
+                </select>
+            </div>
+        </div>
+
         <div class="mb-3">
             <label>Status <strong class="text-danger">*</strong></label>
             <div class="input-group">
                     <span class="input-group-text"><i class="fa fa-fw fa-clock"></i></span>
-                <select class="form-select select2" name="status" required>
+                <select class="form-select select" name="status" required>
                     <option <?php if ($recurring_invoice_status == 1) {
                                 echo "selected";
                             } ?> value="1">Active</option>

agent/post/recurring_invoice.php

@@ -124,6 +124,7 @@ if (isset($_POST['edit_recurring_invoice'])) {
     $scope = escapeSql($_POST['scope']);
     $status = intval($_POST['status']);
     $recurring_invoice_discount = floatval($_POST['recurring_invoice_discount']);
+    $auto_send = intval($_POST['auto_send']);
 
     // Get Recurring Invoice Details and Client ID for Logging
     $sql = mysqli_query($mysqli,"SELECT recurring_invoice_prefix, recurring_invoice_number, recurring_invoice_client_id FROM recurring_invoices WHERE recurring_invoice_id = $recurring_invoice_id");
@@ -143,7 +144,7 @@ if (isset($_POST['edit_recurring_invoice'])) {
     }
     $recurring_invoice_amount = $recurring_invoice_amount - $recurring_invoice_discount;
 
-    mysqli_query($mysqli,"UPDATE recurring_invoices SET recurring_invoice_scope = '$scope', recurring_invoice_frequency = '$frequency', recurring_invoice_next_date = '$next_date', recurring_invoice_category_id = $category, recurring_invoice_discount_amount = $recurring_invoice_discount, recurring_invoice_amount = $recurring_invoice_amount, recurring_invoice_status = $status WHERE recurring_invoice_id = $recurring_invoice_id");
+    mysqli_query($mysqli,"UPDATE recurring_invoices SET recurring_invoice_scope = '$scope', recurring_invoice_frequency = '$frequency', recurring_invoice_next_date = '$next_date', recurring_invoice_category_id = $category, recurring_invoice_discount_amount = $recurring_invoice_discount, recurring_invoice_amount = $recurring_invoice_amount, recurring_invoice_auto_send = $auto_send, recurring_invoice_status = $status WHERE recurring_invoice_id = $recurring_invoice_id");
 
     mysqli_query($mysqli,"INSERT INTO history SET history_status = '$status', history_description = 'Recurring Invoice edited', history_recurring_invoice_id = $recurring_invoice_id");
 
@@ -370,12 +371,13 @@ if (isset($_GET['force_recurring'])) {
         recurring_invoice_client_id, recurring_invoice_currency_code,
         recurring_invoice_discount_amount, recurring_invoice_frequency, recurring_invoice_id,
         recurring_invoice_last_sent, recurring_invoice_next_date, recurring_invoice_note,
-        recurring_invoice_scope, recurring_invoice_status FROM recurring_invoices, clients WHERE client_id = recurring_invoice_client_id AND recurring_invoice_id = $recurring_invoice_id");
+        recurring_invoice_scope, recurring_invoice_auto_send, recurring_invoice_status FROM recurring_invoices, clients WHERE client_id = recurring_invoice_client_id AND recurring_invoice_id = $recurring_invoice_id");
 
     $row = mysqli_fetch_assoc($sql_recurring_invoices);
     $recurring_invoice_id = intval($row['recurring_invoice_id']);
     $recurring_invoice_scope = escapeSql($row['recurring_invoice_scope']);
     $recurring_invoice_frequency = validateRecurringFrequency($row['recurring_invoice_frequency']);
+    $recurring_invoice_auto_send = intval($row['recurring_invoice_auto_send']);
     $recurring_invoice_status = escapeSql($row['recurring_invoice_status']);
     $recurring_invoice_last_sent = escapeSql($row['recurring_invoice_last_sent']);
     $recurring_invoice_next_date = escapeSql($row['recurring_invoice_next_date']);
@@ -403,10 +405,12 @@ if (isset($_GET['force_recurring'])) {
     //Generate a unique URL key for clients to access
     $url_key = randomString(32);
 
-    mysqli_query($mysqli,"INSERT INTO invoices SET invoice_prefix = '$config_invoice_prefix', invoice_number = $new_invoice_number, invoice_scope = '$recurring_invoice_scope', invoice_date = CURDATE(), invoice_due = DATE_ADD(CURDATE(), INTERVAL $client_net_terms day), invoice_discount_amount = $recurring_invoice_discount_amount, invoice_amount = $recurring_invoice_amount, invoice_currency_code = '$recurring_invoice_currency_code', invoice_note = '$recurring_invoice_note', invoice_category_id = $category_id, invoice_status = 'Sent', invoice_url_key = '$url_key', invoice_recurring_invoice_id = $recurring_invoice_id, invoice_client_id = $client_id");
+    mysqli_query($mysqli,"INSERT INTO invoices SET invoice_prefix = '$config_invoice_prefix', invoice_number = $new_invoice_number, invoice_scope = '$recurring_invoice_scope', invoice_date = CURDATE(), invoice_due = DATE_ADD(CURDATE(), INTERVAL $client_net_terms day), invoice_discount_amount = $recurring_invoice_discount_amount, invoice_amount = $recurring_invoice_amount, invoice_currency_code = '$recurring_invoice_currency_code', invoice_note = '$recurring_invoice_note', invoice_category_id = $category_id, invoice_status = 'Draft', invoice_url_key = '$url_key', invoice_recurring_invoice_id = $recurring_invoice_id, invoice_client_id = $client_id");
 
     $new_invoice_id = mysqli_insert_id($mysqli);
 
+    mysqli_query($mysqli,"INSERT INTO history SET history_status = 'Draft', history_description = 'Invoice Generated from Recurring!', history_invoice_id = $new_invoice_id");
+
     //Copy Items from original invoice to new invoice
     $sql_invoice_items = mysqli_query($mysqli,"SELECT item_description, item_id, item_name, item_order, item_price, item_quantity, item_subtotal,
         item_tax_id FROM recurring_invoice_items WHERE item_recurring_invoice_id = $recurring_invoice_id ORDER BY item_id ASC");
@@ -439,7 +443,10 @@ if (isset($_GET['force_recurring'])) {
         mysqli_query($mysqli,"INSERT INTO invoice_items SET item_name = '$item_name', item_description = '$item_description', item_quantity = $item_quantity, item_price = $item_price, item_subtotal = $item_subtotal, item_tax = $item_tax_amount, item_total = $item_total, item_tax_id = $tax_id, item_invoice_id = $new_invoice_id");
     }
 
-    mysqli_query($mysqli,"INSERT INTO history SET history_status = 'Sent', history_description = 'Invoice Generated from Recurring!', history_invoice_id = $new_invoice_id");
+    // Only send the invoice if the recurring invoice is set to auto-send, otherwise just leave as draft for manual sending
+    if ($recurring_invoice_auto_send == 1) {
+
+        mysqli_query($mysqli,"INSERT INTO history SET history_status = 'Sent', history_description = 'Invoice Sent from Recurring!', history_invoice_id = $new_invoice_id");
 
         //Update Recurring Balances by tallying up recurring items also update recurring dates
         $sql_recurring_invoice_total = mysqli_query($mysqli,"SELECT SUM(item_total) AS recurring_invoice_total FROM recurring_invoice_items WHERE item_recurring_invoice_id = $recurring_invoice_id");
@@ -518,7 +525,8 @@ if (isset($_GET['force_recurring'])) {
 
             }
 
-    } //End Recurring Invoices Loop
+        } //End Recurring Invoices Mail Loop
+    }
 
     logAudit("Invoice", "Create", "$session_name forced recurring invoice into an invoice", $client_id, $new_invoice_id);
 

agent/recurring_invoice.php

@@ -22,7 +22,7 @@ if (isset($_GET['recurring_invoice_id'])) {
             recurring_invoice_category_id, recurring_invoice_created_at,
             recurring_invoice_currency_code, recurring_invoice_discount_amount,
             recurring_invoice_email_notify, recurring_invoice_frequency, recurring_invoice_last_sent,
-            recurring_invoice_next_date, recurring_invoice_note, recurring_invoice_number,
+            recurring_invoice_next_date, recurring_invoice_note, recurring_invoice_auto_send, recurring_invoice_number,
             recurring_invoice_prefix, recurring_invoice_scope, recurring_invoice_status,
             recurring_payment_id, recurring_payment_method, recurring_payment_recurring_invoice_id,
             recurring_payment_saved_payment_id FROM recurring_invoices
@@ -61,6 +61,7 @@ if (isset($_GET['recurring_invoice_id'])) {
     $recurring_invoice_discount = floatval($row['recurring_invoice_discount_amount']);
     $recurring_invoice_currency_code = escapeHtml($row['recurring_invoice_currency_code']);
     $recurring_invoice_note = escapeHtml($row['recurring_invoice_note']);
+    $recurring_invoice_auto_send = intval($row['recurring_invoice_auto_send']);
     $recurring_invoice_email_notify = intval($row['recurring_invoice_email_notify']);
     $category_id = intval($row['recurring_invoice_category_id']);
     $client_id = intval($row['client_id']);
@@ -148,11 +149,13 @@ if (isset($_GET['recurring_invoice_id'])) {
             <div class="row">
 
                 <div class="col-2">
+                    <?php if ($recurring_invoice_auto_send) { ?>
                         <?php if ($recurring_invoice_email_notify) { ?>
                             <a href="post.php?recurring_invoice_email_notify=0&recurring_invoice_id=<?= $recurring_invoice_id ?>&csrf_token=<?= $_SESSION['csrf_token'] ?>" class="btn btn-primary"><i class="fas fa-fw fa-bell me-2"></i>Email Notify</a>
                         <?php } else { ?>
                             <a href="post.php?recurring_invoice_email_notify=1&recurring_invoice_id=<?= $recurring_invoice_id ?>&csrf_token=<?= $_SESSION['csrf_token'] ?>" class="btn btn-outline-danger"><i class="fas fa-fw fa-bell-slash me-2"></i>Email Notify</a>
                         <?php } ?>
+                    <?php } ?>
                 </div>
                 <div class="col-3">
                     <?php $sql_saved_payments = mysqli_query($mysqli, "SELECT saved_payment_description, saved_payment_id FROM client_saved_payment_methods WHERE saved_payment_client_id = $client_id");

cron/nightly_tasks.php

@@ -674,7 +674,7 @@ if ($config_send_invoice_reminders == 1) {
 // Logging
 // logAudit("Cron", "Task", "Cron created notifications for past due invoices and sent out notifications to the primary and billing contacts email");
 
-// Send Recurring Invoices that match todays date and are active
+// Generate & Send Recurring Invoices that match todays date and are active
 
 //Loop through all recurring that match today's date and is active
 $sql_recurring_invoices = mysqli_query($mysqli, "SELECT client_name, client_net_terms, recurring_invoice_amount, recurring_invoice_category_id,
@@ -682,7 +682,7 @@ $sql_recurring_invoices = mysqli_query($mysqli, "SELECT client_name, client_net_
     recurring_invoice_discount_amount, recurring_invoice_email_notify,
     recurring_invoice_frequency, recurring_invoice_id, recurring_invoice_last_sent,
     recurring_invoice_next_date, recurring_invoice_note, recurring_invoice_scope,
-    recurring_invoice_status, recurring_payment_account_id, recurring_payment_currency_code,
+    recurring_invoice_status, recurring_invoice_auto_send, recurring_payment_account_id, recurring_payment_currency_code,
     recurring_payment_method, recurring_payment_recurring_invoice_id FROM recurring_invoices
     LEFT JOIN recurring_payments ON recurring_invoice_id = recurring_payment_recurring_invoice_id
     LEFT JOIN clients ON client_id = recurring_invoice_client_id
@@ -701,6 +701,7 @@ while ($row = mysqli_fetch_assoc($sql_recurring_invoices)) {
     $recurring_invoice_amount = floatval($row['recurring_invoice_amount']);
     $recurring_invoice_currency_code = escapeSql($row['recurring_invoice_currency_code']);
     $recurring_invoice_note = escapeSql($row['recurring_invoice_note']);
+    $recurring_invoice_auto_send = intval($row['recurring_invoice_auto_send']);
     $recurring_invoice_email_notify = intval($row['recurring_invoice_email_notify']);
     $category_id = intval($row['recurring_invoice_category_id']);
     $client_id = intval($row['recurring_invoice_client_id']);
@@ -726,7 +727,7 @@ while ($row = mysqli_fetch_assoc($sql_recurring_invoices)) {
     //Generate a unique URL key for clients to access
     $url_key = randomString(32);
 
-    mysqli_query($mysqli, "INSERT INTO invoices SET invoice_prefix = '$config_invoice_prefix', invoice_number = $new_invoice_number, invoice_scope = '$recurring_invoice_scope', invoice_date = CURDATE(), invoice_due = DATE_ADD(CURDATE(), INTERVAL $client_net_terms day), invoice_discount_amount = $recurring_invoice_discount_amount, invoice_amount = $recurring_invoice_amount, invoice_currency_code = '$recurring_invoice_currency_code', invoice_note = '$recurring_invoice_note', invoice_category_id = $category_id, invoice_status = 'Sent', invoice_url_key = '$url_key', invoice_recurring_invoice_id = $recurring_invoice_id, invoice_client_id = $client_id");
+    mysqli_query($mysqli, "INSERT INTO invoices SET invoice_prefix = '$config_invoice_prefix', invoice_number = $new_invoice_number, invoice_scope = '$recurring_invoice_scope', invoice_date = CURDATE(), invoice_due = DATE_ADD(CURDATE(), INTERVAL $client_net_terms day), invoice_discount_amount = $recurring_invoice_discount_amount, invoice_amount = $recurring_invoice_amount, invoice_currency_code = '$recurring_invoice_currency_code', invoice_note = '$recurring_invoice_note', invoice_category_id = $category_id, invoice_status = 'Draft', invoice_url_key = '$url_key', invoice_recurring_invoice_id = $recurring_invoice_id, invoice_client_id = $client_id");
 
     $new_invoice_id = mysqli_insert_id($mysqli);
 
@@ -751,9 +752,13 @@ while ($row = mysqli_fetch_assoc($sql_recurring_invoices)) {
 
     }
 
-    mysqli_query($mysqli, "INSERT INTO history SET history_status = 'Sent', history_description = 'Invoice Generated from Recurring!', history_invoice_id = $new_invoice_id");
+    mysqli_query($mysqli, "INSERT INTO history SET history_status = 'Draft', history_description = 'Invoice Generated from Recurring!', history_invoice_id = $new_invoice_id");
 
+    if ($recurring_invoice_auto_send == 1) {
         appNotify("Recurring Sent", "Recurring Invoice $config_invoice_prefix$new_invoice_number for $client_name Sent", "/agent/invoice.php?invoice_id=$new_invoice_id", $client_id);
+    } else {
+        appNotify("Recurring Generated", "Recurring Invoice $config_invoice_prefix$new_invoice_number for $client_name Generated", "/agent/invoice.php?invoice_id=$new_invoice_id", $client_id);
+    }
 
     triggerCustomAction('invoice_create', $new_invoice_id);
 
@@ -783,7 +788,8 @@ while ($row = mysqli_fetch_assoc($sql_recurring_invoices)) {
     $contact_name = escapeSql($row['contact_name']);
     $contact_email = escapeSql($row['contact_email']);
 
-    if ($config_recurring_auto_send_invoice == 1 && $recurring_invoice_email_notify == 1) {
+    // Send invoice email if: (1) Global recurring auto-send is on, (2) the recurring invoice is set to auto-send (than just be a draft), and (3) the recurring invoice is opted in for the client to be notified
+    if ($config_recurring_auto_send_invoice == 1 && $recurring_invoice_auto_send == 1 && $recurring_invoice_email_notify == 1) {
 
         $subject = "Invoice $invoice_prefix$invoice_number";
         $body = "Hello $contact_name,<br><br>An invoice regarding \"$invoice_scope\" has been generated. Please view the details below.<br><br>Invoice: $invoice_prefix$invoice_number<br>Issue Date: $invoice_date<br>Total: " . numfmt_format_currency($currency_format, $invoice_amount, $recurring_invoice_currency_code) . "<br>Due Date: $invoice_due<br><br><br>To view your invoice, please click <a href=\'https://$config_base_url/guest/guest_view_invoice.php?invoice_id=$new_invoice_id&url_key=$invoice_url_key\'>here</a>.<br><br><br>--<br>$company_name - Billing<br>$config_invoice_from_email<br>$company_phone";
@@ -851,6 +857,17 @@ while ($row = mysqli_fetch_assoc($sql_invalid_recurring_invoices)) {
 }
 // End Flag any active recurring "next run" dates that are in the past
 
+// Start Notify draft invoices needing review
+$sql_invoices_pending_send = mysqli_query($mysqli,"SELECT invoice_id FROM invoices WHERE invoice_status = 'Draft'");
+$invoices_pending_send = mysqli_num_rows($sql_invoices_pending_send);
+
+if ($invoices_pending_send > 0) {
+
+    appNotify("Draft Invoices", "There are $invoices_pending_send draft invoices pending review", "/agent/invoices.php?&status=Draft");
+}
+// End Notify draft invoices needing review
+
+
 
 // Start Recurring Payments
 $sql_recurring_payments = mysqli_query($mysqli, "

db.sql

@@ -2002,6 +2002,7 @@ CREATE TABLE `recurring_invoices` (
   `recurring_invoice_amount` decimal(15,2) NOT NULL DEFAULT 0.00,
   `recurring_invoice_currency_code` varchar(200) NOT NULL,
   `recurring_invoice_note` text DEFAULT NULL,
+  `recurring_invoice_auto_send` tinyint(1) NOT NULL DEFAULT 1,
   `recurring_invoice_email_notify` tinyint(1) NOT NULL DEFAULT 1,
   `recurring_invoice_created_at` datetime NOT NULL DEFAULT current_timestamp(),
   `recurring_invoice_updated_at` datetime DEFAULT NULL ON UPDATE current_timestamp(),