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