admin/db/voiding_db.inc

   1 <?php
   2 /**********************************************************************
   3     Copyright (C) FrontAccounting, LLC.
   4         Released under the terms of the GNU General Public License, GPL,
   5         as published by the Free Software Foundation, either version 3
   6         of the License, or (at your option) any later version.
   7     This program is distributed in the hope that it will be useful,
   8     but WITHOUT ANY WARRANTY; without even the implied warranty of
   9     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10     See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
  11 ***********************************************************************/
  12 include_once($path_to_root . "/sales/includes/sales_db.inc");
  13 include_once($path_to_root . "/purchasing/includes/purchasing_db.inc");
  14 include_once($path_to_root . "/inventory/includes/inventory_db.inc");
  15 include_once($path_to_root . "/manufacturing/includes/manufacturing_db.inc");
  16
  17 function void_transaction($type, $type_no, $date_, $memo_)
  18 {
  19         global $Refs;
  20         $void_entry = get_voided_entry($type, $type_no);
  21
  22         if ($void_entry != null)
  23                 return _('This transaction was already voided before.');
  24
  25         switch ($type) {
  26                 case ST_JOURNAL : // it's a journal entry
  27                         if (!exists_gl_trans($type, $type_no))
  28                                 return _('Selected transaction does not exists.');
  29                         void_journal_trans($type, $type_no);
  30                         break;
  31
  32                 case ST_BANKDEPOSIT : // it's a deposit
  33                 case ST_BANKTRANSFER : // it's a transfer
  34                         if (!check_void_bank_trans($type, $type_no))
  35                                 return _('This transaction cannot be voided because the operation would decrease account balance below allowed limit in some point of account history.');
  36                 case ST_BANKPAYMENT : // it's a payment
  37                         if (!exists_bank_trans($type, $type_no))
  38                                 return _('Selected transaction does not exists.');
  39                         void_bank_trans($type, $type_no);
  40                         break;
  41
  42                 case ST_CUSTPAYMENT : // it's a customer payment
  43                         if (!check_void_bank_trans($type, $type_no))
  44                                 return _('This transaction cannot be voided because the operation would decrease account balance below allowed limit in some point of account history.');
  45                 case ST_SALESINVOICE : // it's a customer invoice
  46                         if (is_cust_invoice_credited($type_no))
  47                                 return _('This invoice cannot be voided because it was already credited.');
  48                 case ST_CUSTCREDIT : // it's a customer credit note
  49                 case ST_CUSTDELIVERY : // it's a customer dispatch
  50                         if (!exists_customer_trans($type, $type_no))
  51                                 return _('Selected transaction does not exists.');
  52                         if ($type == ST_CUSTDELIVERY)   // added 04 Oct 2008 by Joe Hunt. If delivery note has a not voided invoice, then NO.
  53                         {
  54                                 $childs = get_sales_child_lines($type, $type_no, false); // 2011-03-17 This had been changed. Joe
  55                                 if ($childs && db_num_rows($childs))
  56                                         return _('This delivery cannot be voided because it was already invoiced.');
  57                         }
  58                         post_void_customer_trans($type, $type_no);
  59                         break;
  60
  61                 case ST_LOCTRANSFER : // it's a stock transfer
  62                         if (get_stock_transfer_items($type_no) == null)
  63                                 return _('Selected transaction does not exists.');
  64                         void_stock_transfer($type_no);
  65                         break;
  66
  67                 case ST_INVADJUST : // it's a stock adjustment
  68                         if (get_stock_adjustment_items($type_no) == null)
  69                                 return _('Selected transaction does not exists.');
  70                         void_stock_adjustment($type_no);
  71                         break;
  72
  73                 case ST_PURCHORDER : // it's a PO
  74                                 return _('This transaction type cannot be voided.');
  75                         break;
  76
  77                 case ST_SUPPRECEIVE : // it's a GRN
  78                         if (exists_grn_on_invoices($type_no))
  79                                 return _('This GRN cannot be voided because it was already invoiced.');
  80                 case ST_SUPPINVOICE : // it's a suppler invoice
  81                 case ST_SUPPCREDIT : // it's a supplier credit note
  82                 case ST_SUPPAYMENT : // it's a supplier payment
  83                         if (!exists_supp_trans($type, $type_no))
  84                                 return _('Selected transaction does not exists.');
  85                         if (!post_void_supp_trans($type, $type_no))
  86                                 return _('Error encountered when voiding transaction.');
  87                         break;
  88
  89                 case ST_WORKORDER : // it's a work order
  90                         if (!get_work_order($type_no, true))
  91                                 return _('Selected transaction does not exists.');
  92                         void_work_order($type_no);
  93                         break;
  94
  95                 case ST_MANUISSUE : // it's a work order issue
  96                         if (!exists_work_order_issue($type_no))
  97                                 return _('Selected transaction does not exists.');
  98                         void_work_order_issue($type_no);
  99                         break;
 100
 101                 case ST_MANURECEIVE : // it's a work order production
 102                         if (!exists_work_order_produce($type_no))
 103                                 return _('Selected transaction does not exists.');
 104                         void_work_order_produce($type_no);
 105                         break;
 106
 107                 case ST_SALESORDER: // it's a sales order
 108                 case ST_SALESQUOTE: // it's a sales quotation
 109                         return _('This transaction type cannot be voided.');
 110
 111                 case ST_COSTUPDATE : // it's a stock cost update
 112                         return _('This transaction type cannot be voided.');
 113                         break;
 114         }
 115
 116         // only add an entry if it's actually been voided
 117         add_audit_trail($type, $type_no, $date_, _("Voided.")."\n".$memo_);
 118         $Refs->restore_last($type, $type_no);
 119         add_voided_entry($type, $type_no, $date_, $memo_);
 120         return false;
 121 }
 122
 123 //--------------------------------------------------------------------------------------------------
 124
 125 function get_voided_entry($type, $type_no)
 126 {
 127         $sql = "SELECT * FROM ".TB_PREF."voided WHERE type=".db_escape($type)
 128                 ." AND id=".db_escape($type_no);
 129
 130         $result = db_query($sql, "could not query voided transaction table");
 131
 132         return db_fetch($result);
 133 }
 134
 135 //--------------------------------------------------------------------------------------------------
 136
 137 function add_voided_entry($type, $type_no, $date_, $memo_)
 138 {
 139         $date = date2sql($date_);
 140         $sql = "INSERT INTO ".TB_PREF."voided (type, id, date_, memo_)
 141                 VALUES (".db_escape($type).", ".db_escape($type_no).", "
 142                 .db_escape($date).", ".db_escape($memo_).")";
 143
 144         db_query($sql, "could not add voided transaction entry");
 145 }
 146
 147 //--------------------------------------------------------------------------------------------------
 148