sales/includes/db/cust_trans_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 //------------------------------------------------------------------------------
  13 //      Retreive parent document number(s) for given transaction
  14 //
  15 function get_parent_trans($trans_type, $trans_no) {
  16
  17         $sql = 'SELECT trans_link FROM
  18                         '.TB_PREF.'debtor_trans WHERE
  19                         (trans_no=' .$trans_no. ' AND type='.$trans_type.' AND trans_link!=0)';
  20
  21         $result = db_query($sql, 'Parent document numbers cannot be retrieved');
  22
  23         if (db_num_rows($result)) {
  24                 $link = db_fetch($result);
  25                 return array($link['trans_link']);
  26         }
  27         if ($trans_type!=10) return 0;  // this is credit note with no parent invoice
  28         // invoice: find batch invoice parent trans.
  29         $sql = 'SELECT trans_no FROM
  30                         '.TB_PREF.'debtor_trans WHERE
  31                         (trans_link='.$trans_no.' AND type='. get_parent_type($trans_type) .')';
  32
  33         $result = db_query($sql, 'Delivery links cannot be retrieved');
  34
  35         $delivery = array();
  36         if(db_num_rows($result)>0) {
  37                 while($link = db_fetch($result)) {
  38                         $delivery[] = $link['trans_no'];
  39                 }
  40         }
  41         return count($delivery) ? $delivery : 0;
  42 }
  43
  44 //----------------------------------------------------------------------------------------
  45 // Mark changes in debtor_trans_details
  46 //
  47 function update_customer_trans_version($type, $versions) {
  48
  49         $sql= 'UPDATE '.TB_PREF. 'debtor_trans SET version=version+1
  50                         WHERE type='.$type. ' AND (';
  51
  52         foreach ($versions as $trans_no=>$version)
  53                 $where[] =      '(trans_no='.$trans_no.
  54                         ' AND version='.$version.')';
  55
  56                 $sql .= implode(' OR ', $where) .')';
  57
  58         return  db_query($sql, 'Concurrent editing conflict');
  59 }
  60
  61 //----------------------------------------------------------------------------------------
  62 // Gets document header versions for transaction set of type $type
  63 // $trans_no = array(num1, num2,...);
  64 // returns array(num1=>ver1, num2=>ver2...)
  65 //
  66 function get_customer_trans_version($type, $trans_no) {
  67         if (!is_array($trans_no))
  68                 $trans_no = array( $trans_no );
  69
  70         $sql= 'SELECT trans_no, version FROM '.TB_PREF. 'debtor_trans
  71                         WHERE type='.$type.' AND (';
  72
  73         foreach ($trans_no as $key=>$trans)
  74                 $trans_no[$key] =       'trans_no='.$trans_no[$key];
  75
  76         $sql .= implode(' OR ', $trans_no) . ')';
  77
  78         $res = db_query($sql, 'document version retreival');
  79
  80         $vers = array();
  81         while($mysql=db_fetch($res)) {
  82                 $vers[$mysql['trans_no']] = $mysql['version'];
  83         }
  84         return $vers;
  85 }
  86 //----------------------------------------------------------------------------------------
  87 // $Total, $Tax, $Freight, $discount all in customer's currency
  88 // date_ is display date (non-sql)
  89 function write_customer_trans($trans_type, $trans_no, $debtor_no, $BranchNo,
  90         $date_, $reference, $Total, $discount=0, $Tax=0, $Freight=0, $FreightTax=0,
  91         $sales_type=0, $order_no=0, $trans_link=0, $ship_via=0, $due_date="",
  92         $AllocAmt=0, $rate=0, $dimension_id=0, $dimension2_id=0)
  93 {
  94         $new = $trans_no==0;
  95         $curr = get_customer_currency($debtor_no);
  96         if ($rate == 0)
  97                 $rate = get_exchange_rate_from_home_currency($curr, $date_);
  98
  99         $SQLDate = date2sql($date_);
 100         if ($due_date == "")
 101                 $SQLDueDate = "0000-00-00";
 102         else
 103                 $SQLDueDate = date2sql($due_date);
 104
 105         if ($trans_type == systypes::bank_payment())
 106                 $Total = -$Total;
 107
 108         if ($new) {
 109         $trans_no = get_next_trans_no($trans_type);
 110
 111         $sql = "INSERT INTO ".TB_PREF."debtor_trans (
 112                 trans_no, type,
 113                 debtor_no, branch_code,
 114                 tran_date, due_date,
 115                 reference, tpe,
 116                 order_, ov_amount, ov_discount,
 117                 ov_gst, ov_freight, ov_freight_tax,
 118                 rate, ship_via, alloc, trans_link,
 119                 dimension_id, dimension2_id
 120                 ) VALUES ($trans_no, $trans_type,
 121                 ".db_escape($debtor_no).", ".db_escape($BranchNo).",
 122                 '$SQLDate', '$SQLDueDate', ".db_escape($reference).",
 123                 ".db_escape($sales_type).", $order_no, $Total, ".db_escape($discount).", $Tax,
 124                 ".db_escape($Freight).",
 125                 $FreightTax, $rate, ".db_escape($ship_via).", $AllocAmt, ".db_escape($trans_link).",
 126                 $dimension_id, $dimension2_id)";
 127         } else {        // may be optional argument should stay unchanged ?
 128         $sql = "UPDATE ".TB_PREF."debtor_trans SET
 129                 debtor_no=".db_escape($debtor_no)." , branch_code=".db_escape($BranchNo).",
 130                 tran_date='$SQLDate', due_date='$SQLDueDate',
 131                 reference=".db_escape($reference).", tpe=".db_escape($sales_type).", order_=$order_no,
 132                 ov_amount=$Total, ov_discount=".db_escape($discount).", ov_gst=$Tax,
 133                 ov_freight=".db_escape($Freight).", ov_freight_tax=$FreightTax, rate=$rate,
 134                 ship_via=".db_escape($ship_via).", alloc=$AllocAmt, trans_link=$trans_link,
 135                 dimension_id=$dimension_id, dimension2_id=$dimension2_id
 136                 WHERE trans_no=$trans_no AND type=$trans_type";
 137         }
 138         db_query($sql, "The debtor transaction record could not be inserted");
 139
 140         add_audit_trail($trans_type, $trans_no, $date_, $new ? '': _("Updated."));
 141
 142         return $trans_no;
 143 }
 144
 145 //----------------------------------------------------------------------------------------
 146
 147 function get_customer_trans($trans_id, $trans_type)
 148 {
 149         $sql = "SELECT ".TB_PREF."debtor_trans.*,
 150                 ov_amount+ov_gst+ov_freight+ov_freight_tax+ov_discount AS Total,
 151                 ".TB_PREF."debtors_master.name AS DebtorName, ".TB_PREF."debtors_master.address, ".TB_PREF."debtors_master.email AS email2,
 152                 ".TB_PREF."debtors_master.curr_code, ".TB_PREF."debtors_master.tax_id, ".TB_PREF."debtors_master.payment_terms ";
 153
 154         if ($trans_type == systypes::cust_payment()) {
 155                 // it's a payment so also get the bank account
 156                 $sql .= ", ".TB_PREF."bank_accounts.bank_name, ".TB_PREF."bank_accounts.bank_account_name,
 157                         ".TB_PREF."bank_accounts.account_type AS BankTransType ";
 158         }
 159
 160         if ($trans_type == 10 OR $trans_type == 11 OR $trans_type == 13) {
 161                 // it's an invoice so also get the shipper and salestype
 162                 $sql .= ", ".TB_PREF."shippers.shipper_name, "
 163                 .TB_PREF."sales_types.sales_type, "
 164                 .TB_PREF."sales_types.tax_included, "
 165                 .TB_PREF."cust_branch.*, "
 166                 .TB_PREF."debtors_master.discount, "
 167                 .TB_PREF."tax_groups.name AS tax_group_name, "
 168                 .TB_PREF."tax_groups.id AS tax_group_id ";
 169         }
 170
 171
 172         $sql .= " FROM ".TB_PREF."debtor_trans, ".TB_PREF."debtors_master ";
 173
 174         if ($trans_type == systypes::cust_payment()) {
 175                 // it's a payment so also get the bank account
 176                 $sql .= ", ".TB_PREF."bank_trans, ".TB_PREF."bank_accounts";
 177         }
 178
 179         if ($trans_type == 10 OR $trans_type == 11 OR $trans_type == 13) {
 180                 // it's an invoice so also get the shipper, salestypes
 181                 $sql .= ", ".TB_PREF."shippers, ".TB_PREF."sales_types, ".TB_PREF."cust_branch, ".TB_PREF."tax_groups ";
 182         }
 183
 184         $sql .= " WHERE ".TB_PREF."debtor_trans.trans_no=$trans_id
 185                 AND ".TB_PREF."debtor_trans.type=$trans_type
 186                 AND ".TB_PREF."debtor_trans.debtor_no=".TB_PREF."debtors_master.debtor_no";
 187
 188         if ($trans_type == systypes::cust_payment()) {
 189                 // it's a payment so also get the bank account
 190                 $sql .= " AND ".TB_PREF."bank_trans.trans_no =$trans_id
 191                         AND ".TB_PREF."bank_trans.type=$trans_type
 192                         AND ".TB_PREF."bank_accounts.id=".TB_PREF."bank_trans.bank_act ";
 193         }
 194         if ($trans_type == 10 OR $trans_type == 11 OR $trans_type == 13) {
 195                 // it's an invoice so also get the shipper
 196                 $sql .= " AND ".TB_PREF."shippers.shipper_id=".TB_PREF."debtor_trans.ship_via
 197                         AND ".TB_PREF."sales_types.id = ".TB_PREF."debtor_trans.tpe
 198                         AND ".TB_PREF."cust_branch.branch_code = ".TB_PREF."debtor_trans.branch_code
 199                         AND ".TB_PREF."cust_branch.tax_group_id = ".TB_PREF."tax_groups.id ";
 200         }
 201
 202         $result = db_query($sql, "Cannot retreive a debtor transaction");
 203
 204         if (db_num_rows($result) == 0) {
 205                 // can't return nothing
 206                 display_db_error("no debtor trans found for given params", $sql, true);
 207                 exit;
 208         }
 209
 210         if (db_num_rows($result) > 1) {
 211                 // can't return multiple
 212                 display_db_error("duplicate debtor transactions found for given params", $sql, true);
 213                 exit;
 214         }
 215
 216         //return db_fetch($result);
 217         $row = db_fetch($result);
 218         $row['email'] = $row['email2'];
 219         return $row;
 220 }
 221
 222 //----------------------------------------------------------------------------------------
 223
 224 function exists_customer_trans($type, $type_no)
 225 {
 226         $sql = "SELECT trans_no FROM ".TB_PREF."debtor_trans WHERE type=$type
 227                 AND trans_no=$type_no";
 228
 229         $result = db_query($sql, "Cannot retreive a debtor transaction");
 230
 231         return (db_num_rows($result) > 0);
 232 }
 233
 234 //----------------------------------------------------------------------------------------
 235
 236 // retreives the related sales order for a given trans
 237
 238 function get_customer_trans_order($type, $type_no)
 239 {
 240         $sql = "SELECT order_ FROM ".TB_PREF."debtor_trans WHERE type=$type AND trans_no=$type_no";
 241
 242         $result = db_query($sql, "The debtor transaction could not be queried");
 243
 244         $row = db_fetch_row($result);
 245
 246         return $row[0];
 247 }
 248
 249 //----------------------------------------------------------------------------------------
 250
 251 function get_customer_details_from_trans($type, $type_no)
 252 {
 253         $sql = "SELECT ".TB_PREF."debtors_master.name, ".TB_PREF."debtors_master.curr_code, ".TB_PREF."cust_branch.br_name
 254                 FROM ".TB_PREF."debtors_master,".TB_PREF."cust_branch,".TB_PREF."debtor_trans
 255                 WHERE ".TB_PREF."debtor_trans.type=$type AND ".TB_PREF."debtor_trans.trans_no=$type_no
 256                 AND ".TB_PREF."debtors_master.debtor_no = ".TB_PREF."debtor_trans.debtor_no
 257                 AND     ".TB_PREF."cust_branch.branch_code = ".TB_PREF."debtor_trans.branch_code";
 258
 259         $result = db_query($sql, "could not get customer details from trans");
 260         return db_fetch($result);
 261 }
 262
 263 //----------------------------------------------------------------------------------------
 264
 265 function void_customer_trans($type, $type_no)
 266 {
 267         // clear all values and mark as void
 268         $sql = "UPDATE ".TB_PREF."debtor_trans SET ov_amount=0, ov_discount=0, ov_gst=0, ov_freight=0,
 269                 ov_freight_tax=0, alloc=0, version=version+1 WHERE type=$type AND trans_no=$type_no";
 270
 271         db_query($sql, "could not void debtor transactions for type=$type and trans_no=$type_no");
 272 }
 273
 274 //----------------------------------------------------------------------------------------
 275
 276 function post_void_customer_trans($type, $type_no)
 277 {
 278         switch ($type) {
 279                 case 10 :
 280                 case 11 :
 281                         void_sales_invoice($type, $type_no);
 282                         break;
 283                 case 13 :
 284                         void_sales_delivery($type, $type_no);
 285                         break;
 286                 case 12 :
 287                         void_customer_payment($type, $type_no);
 288                         break;
 289         }
 290 }
 291
 292 //----------------------------------------------------------------------------------------
 293
 294 function get_customer_trans_link($type, $type_no)
 295 {
 296         $row = db_query("SELECT trans_link from ".TB_PREF."debtor_trans
 297                 WHERE type=$type AND trans_no=$type_no",
 298                 "could not get transaction link for type=$type and trans_no=$type_no");
 299         return $row[0];
 300 }
 301 //----------------------------------------------------------------------------------------
 302
 303 ?>