sales/includes/db/sales_invoice_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 //      Add or update Sales Invoice
  14 //
  15 function write_sales_invoice(&$invoice)
  16 {
  17         global $Refs;
  18
  19         $trans_no = $invoice->trans_no;
  20         if (is_array($trans_no))
  21                 $trans_no = key($trans_no);
  22
  23         $date_ = $invoice->document_date;
  24         $charge_shipping =$invoice->freight_cost;
  25
  26         begin_transaction();
  27
  28         hook_db_prewrite($invoice, ST_SALESINVOICE);
  29         $company_data = get_company_prefs();
  30
  31         $branch_data = get_branch_accounts($invoice->Branch);
  32
  33         $customer = get_customer($invoice->customer_id);
  34
  35         add_new_exchange_rate($customer['curr_code'], $date_, $invoice->ex_rate);
  36
  37         // offer price values without freight costs
  38         $items_total = $invoice->get_items_total_dispatch();
  39         $freight_tax = $invoice->get_shipping_tax();
  40
  41         if (!$invoice->is_prepaid())
  42                 update_customer_trans_version(get_parent_type(ST_SALESINVOICE), $invoice->src_docs);
  43     elseif (count($invoice->prepayments)) {     // partial invoice
  44                 $last_payment = end($invoice->prepayments);
  45                 $gl_date = sql2date($last_payment['tran_date']);
  46         } else {        // final invoice
  47                 $gl_date = $invoice->document_date;
  48         }
  49
  50         $ov_gst = 0;
  51         $taxes = $invoice->get_taxes(); // all taxes with freight_tax
  52         $dec = user_price_dec();
  53         foreach ($taxes as $taxitem) {
  54                 $taxitem['Value'] =  round2($taxitem['Value'], $dec);
  55                 $ov_gst +=  $taxitem['Value'];
  56         }
  57
  58         if($invoice->tax_included==0) {
  59             $items_added_tax = $ov_gst - $freight_tax;
  60             $freight_added_tax = $freight_tax;
  61         } else {
  62             $items_added_tax = 0;
  63             $freight_added_tax = 0;
  64         }
  65
  66         /* Insert/update the debtor_trans */
  67         $sales_order = $invoice->order_no;
  68         if (is_array($sales_order))
  69                         $sales_order = $sales_order[0]; // assume all crucial SO data are same for every delivery
  70
  71         if ($trans_no) {
  72                 $allocs = get_payments_for($trans_no, ST_SALESINVOICE, $invoice->customer_id);
  73                 delete_comments(ST_SALESINVOICE, $trans_no);
  74                 void_gl_trans(ST_SALESINVOICE, $trans_no, true);
  75                 void_trans_tax_details(ST_SALESINVOICE, $trans_no);
  76         } else
  77                 $allocs = get_payments_for($invoice->order_no, ST_SALESORDER, $invoice->customer_id);
  78
  79         if ($invoice->is_prepaid()) // selected prepayment is already in cart
  80         {
  81                 $allocs = $invoice->prepayments;
  82                 // values posted are reduced by prepaid_factor
  83                 $prepaid_factor = $invoice->prep_amount/$invoice->get_trans_total();
  84         } else {
  85                 $prepaid_factor = 1;
  86         }
  87
  88          // write_customer_trans have to be called after optional void_cust_allocations above
  89         $invoice_no = write_customer_trans(ST_SALESINVOICE, $trans_no, $invoice->customer_id,
  90                 $invoice->Branch, $date_, $invoice->reference, $items_total, 0,
  91                 $items_added_tax, $invoice->freight_cost, $freight_added_tax,
  92                 $invoice->sales_type, $sales_order, $invoice->ship_via,
  93                 $invoice->due_date, 0, 0, $invoice->dimension_id,
  94                 $invoice->dimension2_id, $invoice->payment, $invoice->tax_included, $invoice->prep_amount);
  95
  96         if ($trans_no == 0) {
  97                 $invoice->trans_no = array($invoice_no=>0);
  98         } else
  99                 move_trans_attachments(ST_SALESINVOICE, $trans_no, $invoice_no);
 100
 101         $total = 0;
 102         // for prepayments use deferred income account if set
 103         $sales_account = $invoice->is_prepaid() ? get_company_pref('deferred_income_act') : 0;
 104
 105         $invoice->split_line_values();
 106         foreach ($invoice->line_items as $line_no => $line) {
 107                 $qty = $line->qty_dispatched;
 108                 $line_taxfree_price = $line->gl_amounts['Net'];
 109
 110                 $line_tax = $line->gl_amounts['Tax'];
 111
 112                 write_customer_trans_detail_item(ST_SALESINVOICE, $invoice_no, $line->stock_id,
 113                         $line->item_description, $line->qty_dispatched,
 114                         $line->line_price(), $qty ? $line_tax/$qty : 0, $line->discount_percent,
 115                         $line->unit_cost, $line->src_id,
 116                         $trans_no ? $line->id : 0);
 117
 118                 // Update delivery items for the quantity invoiced
 119                 if ($line->qty_old != $line->qty_dispatched)
 120                 {
 121                         if ($invoice->is_prepaid())
 122                                 update_prepaid_so_line($line->src_id, $line->qty_dispatched-$line->qty_old);
 123                         else
 124                                 update_parent_line(ST_SALESINVOICE, $line->src_id, ($line->qty_dispatched-$line->qty_old));
 125                 }
 126                 if ($line->qty_dispatched != 0) {
 127                         $stock_gl_code = get_stock_gl_code($line->stock_id);
 128
 129                         if ($line->line_price() != 0) {
 130                                 //Post sales transaction to GL credit sales
 131
 132                                 // If there is a Branch Sales Account, then override with this,
 133                                 // else take the Item Sales Account
 134                                 if (!$invoice->is_prepaid())
 135                                         $sales_account = ($branch_data['sales_account'] != "" ? $branch_data['sales_account'] : $stock_gl_code['sales_account']);
 136                                 // If there is a Customer Dimension, then override with this,
 137                                 // else take the Item Dimension (if any)
 138                                 $dim = ($invoice->dimension_id != $customer['dimension_id'] ? $invoice->dimension_id :
 139                                         ($customer['dimension_id'] != 0 ? $customer["dimension_id"] : $stock_gl_code["dimension_id"]));
 140                                 $dim2 = ($invoice->dimension2_id != $customer['dimension2_id'] ? $invoice->dimension2_id :
 141                                         ($customer['dimension2_id'] != 0 ? $customer["dimension2_id"] : $stock_gl_code["dimension2_id"]));
 142                                 $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $sales_account, $dim, $dim2,
 143                                         -$line_taxfree_price*$prepaid_factor, $invoice->customer_id);
 144
 145                                 if ($line->discount_percent != 0) {
 146
 147                                         $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_,
 148                                                 $branch_data["sales_discount_account"], $dim, $dim2,
 149                                                 ($line_taxfree_price * $line->discount_percent)*$prepaid_factor, $invoice->customer_id);
 150                                 } /*end of if discount !=0 */
 151                         }
 152                 } /*quantity dispatched is more than 0 */
 153         } /*end of delivery_line loop */
 154
 155         if (($items_total + $charge_shipping) != 0) {
 156                 $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $branch_data["receivables_account"], 0, 0,
 157                         ($items_total + $charge_shipping + $items_added_tax + $freight_added_tax)*$prepaid_factor, $invoice->customer_id);
 158         }
 159         $to_allocate = ($items_total + $charge_shipping + $items_added_tax + $freight_added_tax);
 160
 161         if ($charge_shipping != 0) {
 162                 $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $company_data["freight_act"], 0, 0,
 163                         -$invoice->get_tax_free_shipping()*$prepaid_factor, $invoice->customer_id);
 164         }
 165         // post all taxes
 166         foreach ($taxes as $taxitem) {
 167                 if ($taxitem['Net'] != 0) {
 168                         $ex_rate = get_exchange_rate_from_home_currency(get_customer_currency($invoice->customer_id), $date_);
 169                         add_trans_tax_details(ST_SALESINVOICE, $invoice_no, $taxitem['tax_type_id'],
 170                                 $taxitem['rate'], $invoice->tax_included, $prepaid_factor*$taxitem['Value'],
 171                                  $taxitem['Net'], $ex_rate, $date_, $invoice->reference, TR_OUTPUT, $invoice->tax_group_id);
 172                         if (isset($taxitem['sales_gl_code']) && !empty($taxitem['sales_gl_code']) && $taxitem['Value'] != 0)
 173                                 $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $taxitem['sales_gl_code'], 0, 0,
 174                                         (-$taxitem['Value'])*$prepaid_factor, $invoice->customer_id);
 175                 }
 176         }
 177
 178         /*Post a balance post if $total != 0 */
 179         add_gl_balance(ST_SALESINVOICE, $invoice_no, $date_, -$total, PT_CUSTOMER, $invoice->customer_id);
 180
 181         add_comments(ST_SALESINVOICE, $invoice_no, $date_, $invoice->Comments);
 182
 183         if ($trans_no == 0) {
 184                 $Refs->save(ST_SALESINVOICE, $invoice_no, $invoice->reference, null, $invoice->fixed_asset);
 185                 if ($invoice->payment_terms['cash_sale'] && $invoice->pos['pos_account']) {
 186                         $amount = $items_total + $items_added_tax + $invoice->freight_cost
 187                                 + $freight_added_tax;
 188
 189                         // to use debtors.pmt_discount on cash sale:
 190                         // extend invoice entry page with final amount after discount
 191                         // and change line below.
 192                         $discount = 0; // $invoice->cash_discount*$amount;
 193                         $pmtno = write_customer_payment(0, $invoice->customer_id,
 194                                 $invoice->Branch, $invoice->pos['pos_account'], $date_,
 195                                 $Refs->get_next(ST_CUSTPAYMENT, null, array('customer' => $invoice->customer_id,
 196                                         'branch' => $invoice->Branch, 'date' => $date_)),
 197                                 $amount-$discount, $discount,
 198                                 $invoice->pos['pos_name'].' #'.$invoice_no);
 199                         add_cust_allocation($amount, ST_CUSTPAYMENT, $pmtno, ST_SALESINVOICE, $invoice_no, $invoice->customer_id, $date_);
 200
 201                         update_debtor_trans_allocation(ST_SALESINVOICE, $invoice_no, $invoice->customer_id);
 202                         update_debtor_trans_allocation(ST_CUSTPAYMENT, $pmtno, $invoice->customer_id);
 203                 }
 204         }
 205         reallocate_payments($invoice_no, ST_SALESINVOICE, $date_, $to_allocate, $allocs, $invoice->customer_id);
 206         hook_db_postwrite($invoice, ST_SALESINVOICE);
 207
 208         commit_transaction();
 209
 210         return $invoice_no;
 211 }
 212
 213 //--------------------------------------------------------------------------------------------------
 214
 215 function void_sales_invoice($type, $type_no)
 216 {
 217         begin_transaction();
 218
 219         hook_db_prevoid($type, $type_no);
 220         void_bank_trans($type, $type_no, true);
 221         void_gl_trans($type, $type_no, true);
 222
 223         // reverse all the changes in parent document(s)
 224         $factor = get_cust_prepayment_invoice_factor($type_no);
 225         if ($factor != 0)
 226         {
 227                 $lines = get_customer_trans_details($type, $type_no);
 228                 while($line = db_fetch($lines))
 229                 {
 230                         update_prepaid_so_line($line['src_id'], -$factor*$line['quantity']);
 231                 }
 232         }
 233         else
 234         {
 235                 $deliveries = get_sales_parent_numbers($type, $type_no);
 236
 237                 if ($deliveries !== 0) {
 238                         if ($type == ST_SALESINVOICE && count($deliveries) == 1 && get_reference(ST_CUSTDELIVERY, $deliveries[0]) == "auto")
 239                         {
 240                                 void_sales_delivery(ST_CUSTDELIVERY, $deliveries[0], false);
 241                                 $date_ = Today();
 242                                 add_audit_trail(ST_CUSTDELIVERY, $deliveries[0], $date_, _("Voided."));
 243                                 add_voided_entry(ST_CUSTDELIVERY, $deliveries[0], $date_, "");
 244                         }
 245                         else
 246                         {
 247                                 $srcdetails = get_sales_parent_lines($type, $type_no);
 248                                 while ($row = db_fetch($srcdetails)) {
 249                                         update_parent_line($type, $row['id'], -$row['quantity']);
 250                                 }
 251                         }
 252                 }
 253         }
 254         // clear details after they've been reversed in the sales order
 255         void_customer_trans_details($type, $type_no);
 256
 257         void_stock_move($type, $type_no); // in case of credit note with return
 258
 259         void_trans_tax_details($type, $type_no);
 260
 261         void_cust_allocations($type, $type_no);
 262
 263         // do this last because other voidings can depend on it - especially voiding
 264         // DO NOT MOVE THIS ABOVE VOIDING or we can end up with trans with alloc < 0
 265         void_customer_trans($type, $type_no);
 266         commit_transaction();
 267 }
 268
 269 function is_cust_invoice_credited($trans_no)
 270 {
 271         return db_num_rows(get_sales_child_lines(ST_SALESINVOICE, $trans_no));
 272 }
 273
 274 function get_cust_prepayment_invoice_factor($trans_no)
 275 {
 276         $sql = "SELECT IF(dt.prep_amount>0, dt.prep_amount/so.total ,0)
 277                 FROM ".TB_PREF."debtor_trans dt
 278                 LEFT JOIN ".TB_PREF."sales_orders so ON so.trans_type=".ST_SALESORDER." AND so.order_no=dt.order_
 279                  WHERE dt.type=".ST_SALESINVOICE." AND trans_no=".db_escape($trans_no);
 280         $row = db_fetch(db_query($sql, 'cannot retrieve prepaid invoice factor'));
 281         return $row[0];
 282 }
 283
 284 /*
 285         Return yet not invoiced amount of prepayment invoice (or 0 if normal invoice)
 286 */
 287 function prepaid_invoice_remainder($order)
 288 {
 289         $sql = "SELECT so.total - IFNULL(SUM(inv.prep_amount),0) FROM "
 290                 .TB_PREF."sales_orders so,
 291                 ".TB_PREF."debtor_trans inv,
 292                 ".TB_PREF."payment_terms pt
 293                 WHERE  so.order_no=".db_escape($order)
 294                         ." AND so.trans_type=".ST_SALESORDER
 295                         ." AND inv.type=".ST_SALESINVOICE
 296                         ." AND inv.order_=so.order_no"
 297                         ." AND so.payment_terms=pt.terms_indicator"
 298                         ." AND inv.payment_terms=pt.terms_indicator"
 299                         ." AND pt.days_before_due = -1";
 300
 301         $result = db_fetch(db_query($sql, "cannot find final invoice value"));
 302         return $result[0] ? $result[0] : 0;
 303 }
 304
 305
 306 /*
 307         Find oldest delivery date for sales invoice
 308 */
 309 function get_oldest_delivery_date($invoice_no)
 310 {
 311         $sql = "SELECT MIN(trans.tran_date)
 312                         FROM
 313                                 ".TB_PREF."debtor_trans_details del
 314                         LEFT JOIN ".TB_PREF."debtor_trans_details inv
 315                                 ON inv.src_id=del.id
 316                         LEFT JOIN ".TB_PREF."debtor_trans trans
 317                                 ON trans.type=".ST_CUSTDELIVERY." AND trans.trans_no = del.debtor_trans_no
 318                         WHERE
 319                                 inv.debtor_trans_type=".ST_SALESINVOICE
 320                                 ." AND inv.debtor_trans_no=".db_escape($invoice_no);
 321         $res = db_query($sql, 'cannot find oldest delivery date');
 322         $date = db_fetch($res);
 323         return $date[0];
 324 }
 325
 326 /*
 327         Find oldest payment date for sales invoice
 328 */
 329 function get_oldest_payment_date($invoice_no)
 330 {
 331         $sql = "SELECT MIN(payment.tran_date)
 332                         FROM
 333                         ".TB_PREF."cust_allocations alloc,
 334                         ".TB_PREF."debtor_trans payment
 335                         WHERE
 336                                 alloc.trans_type_to=".ST_SALESINVOICE." AND alloc.trans_no_to=".db_escape($invoice_no)
 337                         ." AND alloc.trans_type_from=payment.type AND alloc.trans_no_from=payment.trans_no";
 338         $res = db_query($sql, 'cannot find oldest delivery date');
 339         $date = db_fetch($res);
 340         return $date[0];
 341 }