purchasing/includes/supp_trans_class.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 /* Definition of the Supplier Transactions class to hold all the information for an accounts payable invoice or credit note
  13 */
  14
  15 include_once($path_to_root . "/taxes/tax_calc.inc");
  16
  17 class supp_trans
  18 {
  19
  20         var $grn_items; /*array of objects of class grn_item using the id as the pointer */
  21         var $gl_codes; /*array of objects of class gl_codes using a counter as the pointer */
  22         var $supplier_id;
  23         var $supplier_name;
  24         var $terms;
  25
  26         var $tax_description;
  27         var $tax_group_id;
  28         var $tax_included;
  29
  30         var $trans_type;        // invoice or credit
  31         var $trans_no;
  32
  33         var $Comments;
  34         var $tran_date;
  35         var $due_date;
  36         var $src_docs = array();                // source invoice for this credit note (if any)
  37
  38         var $supp_reference;
  39         var $reference;
  40         var $ov_amount;
  41         var $ov_discount;
  42         var $ov_gst;
  43         var $gl_codes_counter=0;
  44         var $credit = 0;
  45         var $tax_algorithm;
  46         var $stored_algorithm;
  47         var $currency;
  48
  49         function supp_trans($trans_type, $trans_no=0)
  50         {
  51                 /*Constructor function initialises a new Supplier Transaction object */
  52                 $this->read($trans_type, $trans_no);
  53         }
  54
  55         function read($trans_type, $trans_no)
  56         {
  57                 $this->trans_type = $trans_type;
  58                 $this->trans_no = $trans_no;
  59                 $this->grn_items = array();
  60                 $this->gl_codes = array();
  61                 if ($trans_no) {
  62                         read_supp_invoice($trans_no, $trans_type, $this);
  63                         if ($trans_type == ST_SUPPCREDIT)
  64                         {
  65                                 $this->src_docs = find_src_invoices($trans_no);
  66                         }
  67                         read_supplier_details_to_trans($this, $this->supplier_id);
  68                 }
  69         }
  70
  71         function add_grn_to_trans($grn_item_id, $po_detail_item, $item_code, $item_description,
  72                 $qty_recd, $prev_quantity_inv, $this_quantity_inv, $order_price, $chg_price,
  73                 $std_cost_unit, $gl_code)
  74         {
  75                 $this->grn_items[$grn_item_id] = new grn_item($grn_item_id, $po_detail_item,
  76                         $item_code, $item_description, $qty_recd, $prev_quantity_inv, $this_quantity_inv,
  77                         $order_price, $chg_price, $std_cost_unit, $gl_code, $this->tax_included);
  78                 $this->src_docs = find_src_invoices($this);
  79                 return 1;
  80         }
  81
  82         function add_gl_codes_to_trans($gl_code, $gl_act_name, $gl_dim, $gl_dim2, $amount, $memo_)
  83         {
  84                 $this->gl_codes[$this->gl_codes_counter] = new gl_codes($this->gl_codes_counter,
  85                         $gl_code, $gl_act_name, $gl_dim, $gl_dim2, $amount, $memo_);
  86                 $this->gl_codes_counter++;
  87                 return 1;
  88         }
  89
  90         function remove_grn_from_trans($grn_item_id)
  91         {
  92             unset($this->grn_items[$grn_item_id]);
  93         }
  94         function remove_gl_codes_from_trans($gl_code_counter)
  95         {
  96              unset($this->gl_codes[$gl_code_counter]);
  97         }
  98
  99         function is_valid_trans_to_post()
 100         {
 101                 return (count($this->grn_items) > 0 || count($this->gl_codes) > 0 ||
 102                         ($this->ov_amount != 0) || ($this->ov_discount > 0));
 103         }
 104
 105         function clear_items()
 106         {
 107                 unset($this->grn_items);
 108                 unset($this->gl_codes);
 109                 $this->ov_amount = $this->ov_discount = $this->supplier_id = 0;
 110
 111                 $this->grn_items = array();
 112                 $this->gl_codes = array();
 113         }
 114
 115     function get_taxes($tax_group_id=null, $shipping_cost=0, $gl_codes=true)
 116     {
 117         $items = array();
 118         $prices = array();
 119
 120         if ($tax_group_id == null)
 121                 $tax_group_id = $this->tax_group_id;
 122
 123                 // preload the taxgroup !
 124                 $tax_group = get_tax_group_items_as_array($tax_group_id);
 125
 126         foreach ($this->grn_items as $ln_itm)
 127         {
 128                 $items[] = $ln_itm->item_code;
 129 //              $prices[] =round( ($ln_itm->this_quantity_inv * $ln_itm->taxfree_charge_price($tax_group_id, $tax_group)),
 130                 $prices[] =round( ($ln_itm->this_quantity_inv * $ln_itm->chg_price),
 131                          user_price_dec());
 132         }
 133
 134         if ($tax_group_id == null)
 135                 $tax_group_id = $this->tax_group_id;
 136         $taxes = get_tax_for_items($items, $prices, $shipping_cost, $tax_group_id,
 137                 $this->tax_included, null, $this->tax_algorithm);
 138
 139 ///////////////// Joe Hunt 2009.08.18
 140
 141                 if ($gl_codes)
 142                 {
 143                         foreach ($this->gl_codes as $gl_code)
 144                         {
 145                                 $index = is_tax_account($gl_code->gl_code);
 146                                 if ($index !== false)
 147                                 {
 148                                         $taxes[$index]['Value'] += $gl_code->amount;
 149                                 }
 150                         }
 151                 }
 152 ////////////////
 153         return $taxes;
 154     }
 155         //
 156         //      Returns total invoice amount without taxes.
 157         //
 158     function get_total_taxfree($tax_group_id=null)
 159     {
 160         $total = 0;
 161
 162                 // preload the taxgroup !
 163                 if ($tax_group_id != null)
 164                         $tax_group = get_tax_group_items_as_array($tax_group_id);
 165                 else
 166                         $tax_group = null;
 167
 168                 foreach ($this->grn_items as $ln_itm)
 169                 $total += round(($ln_itm->this_quantity_inv * $ln_itm->taxfree_charge_price($tax_group_id, $tax_group)),
 170                          user_price_dec());
 171
 172                 foreach ($this->gl_codes as $gl_line)
 173                 {       //////// 2009-08-18 Joe Hunt
 174                         if (!is_tax_account($gl_line->gl_code))
 175                                 $total += $gl_line->amount;
 176                 }
 177                 return $total;
 178     }
 179         //
 180         //      Returns transaction total
 181         //
 182         function get_items_total()
 183         {
 184                 $total = 0;
 185
 186                 foreach ($this->grn_items as $ln_itm)
 187                         $total += round($ln_itm->this_quantity_inv * $ln_itm->chg_price, user_price_dec());
 188
 189                 foreach ($this->gl_codes as $gl_line)
 190                 {   //////// 2010-10-10 Joe Hunt
 191                         if (!is_tax_account($gl_line->gl_code) || $this->tax_included)
 192                                 $total += $gl_line->amount;
 193                 }
 194                 return $total;
 195         }
 196 } /* end of class defintion */
 197
 198 class grn_item
 199 {
 200
 201 /* Contains relavent information from the purch_order_details as well to provide in cached form,
 202 all the info to do the necessary entries without looking up ie additional queries of the database again */
 203
 204         var $id;
 205         var $po_detail_item;
 206         var $item_code;
 207         var $item_description;
 208         var $qty_recd;
 209         var $prev_quantity_inv;
 210         var $this_quantity_inv;
 211         var $order_price;
 212         var $chg_price;
 213         var $std_cost_unit;
 214         var $gl_code;
 215         var $tax_included;
 216
 217         function grn_item ($id, $po_detail_item, $item_code, $item_description, $qty_recd,
 218                 $prev_quantity_inv, $this_quantity_inv, $order_price, $chg_price,
 219                 $std_cost_unit, $gl_code, $tax_included)
 220         {
 221
 222                 $this->id = $id;
 223                 $this->po_detail_item = $po_detail_item;
 224                 $this->item_code = $item_code;
 225                 $this->item_description = $item_description;
 226                 $this->qty_recd = $qty_recd;
 227                 $this->prev_quantity_inv = $prev_quantity_inv;
 228                 $this->this_quantity_inv = $this_quantity_inv;
 229                 $this->order_price =$order_price;
 230                 $this->chg_price = $chg_price;
 231                 $this->std_cost_unit = $std_cost_unit;
 232                 $this->gl_code = $gl_code;
 233                 $this->tax_included = $tax_included;
 234         }
 235
 236         function full_charge_price($tax_group_id, $tax_group=null)
 237         {
 238                 return get_full_price_for_item($this->item_code,
 239                   $this->chg_price, $tax_group_id, $this->tax_included, $tax_group);
 240         }
 241
 242         function taxfree_charge_price($tax_group_id, $tax_group=null)
 243         {
 244 //              if ($tax_group_id==null)
 245 //                      return $this->chg_price;
 246                 return get_tax_free_price_for_item($this->item_code, $this->chg_price,
 247                   $tax_group_id, $this->tax_included, $tax_group);
 248         }
 249 }
 250
 251
 252 class gl_codes
 253 {
 254
 255         var $Counter;
 256         var $gl_code;
 257         var $gl_act_name;
 258         var $gl_dim;
 259         var $gl_dim2;
 260         var $amount;
 261         var $memo_;
 262
 263         function gl_codes ($Counter, $gl_code, $gl_act_name, $gl_dim, $gl_dim2, $amount, $memo_)
 264         {
 265
 266         /* Constructor function to add a new gl_codes object with passed params */
 267                 $this->Counter = $Counter;
 268                 $this->gl_code = $gl_code;
 269                 $this->gl_act_name = $gl_act_name;
 270                 $this->gl_dim = $gl_dim;
 271                 $this->gl_dim2 = $gl_dim2;
 272                 $this->amount = $amount;
 273                 $this->memo_= $memo_;
 274         }
 275 }
 276
 277 ?>