Customer Payments, Payments to Supplier: improved readbility and multiply cleanups...
[fa-stable.git] / sales / includes / db / sales_invoice_db.inc
index 617abd7f6c36f1e2d248e2c3395556435a1f5bbf..cd80b2cf939830a4d441f1cbb3711ddabf89d62d 100644 (file)
 <?php
+/**********************************************************************
+    Copyright (C) FrontAccounting, LLC.
+       Released under the terms of the GNU General Public License, GPL, 
+       as published by the Free Software Foundation, either version 3 
+       of the License, or (at your option) any later version.
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
+    See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
+***********************************************************************/
+//-----------------------------------------------------------------------------
+//     Add or update Sales Invoice
+//
+function write_sales_invoice(&$invoice)
+{
+       global $Refs;
 
-// $bo_policy = 0, cancel remaining quantities on order
-// = 1, backorder remaining quantities 
+       $trans_no = $invoice->trans_no;
+       if (is_array($trans_no))
+               $trans_no = key($trans_no);
+
+       $date_ = $invoice->document_date;
+       $charge_shipping =$invoice->freight_cost;
 
-function add_sales_invoice(&$invoice, $date_, $due_date, $sales_order, $tax_group_id, 
-       $charge_shipping, $location, $ship_via, $sales_type, $reference, $memo_, $bo_policy)
-{
        begin_transaction();
-       
+
+       hook_db_prewrite($invoice, ST_SALESINVOICE);
        $company_data = get_company_prefs();
-       
-       $branch_data = get_branch_accounts($invoice->Branch);   
-       
-       $invoice_items_total = $invoice->get_items_total_dispatch($tax_group_id);
-       
-    $tax_total = 0;
-    $taxes = $invoice->get_taxes($tax_group_id, $charge_shipping);
-    foreach ($taxes as $taxitem)
-       $tax_total +=  $taxitem['Value'];
-
-       /*Now insert the debtor_trans */
-       
-       $invoice_no = add_customer_trans(10, $invoice->customer_id, $invoice->Branch, $date_, 
-               $reference, $invoice_items_total, 0, $tax_total, $charge_shipping, 
-       $sales_type, $sales_order, $ship_via, $due_date);
-       
-       // If balance of the order cancelled update sales order details quantity. 
-       foreach ($invoice->line_items as $order_line) 
-       {
-
-               if ($order_line->qty_dispatched != 0) 
-               {
-                       
-                       $line_taxfree_price = $order_line->taxfree_price($tax_group_id);
-                       $line_tax = $order_line->full_price() - $line_taxfree_price;
-               
-                       // Now update sales_order_details for the quantity invoiced 
-                       dispatch_sales_order_item($sales_order, $order_line->stock_id, 
-                               $order_line->qty_dispatched);
-                       
-                       /* add invoice details and stock movements */
-                       $memo_ = "";
-
-                       add_customer_trans_detail_item(10, $invoice_no, $order_line->stock_id,
-                               $order_line->item_description, $location, $date_, 
-                               -$order_line->qty_dispatched, $line_taxfree_price, $line_tax,
-                               $order_line->discount_percent, $memo_, $order_line->standard_cost);
-                                                                                               
-                       $stock_gl_code = get_stock_gl_code($order_line->stock_id);                                                                                              
-                                                                                                                       
-                       /* insert gl_trans to credit stock and debit cost of sales at standard cost*/
-                       if ($order_line->standard_cost != 0)
-                       {
-
-                               /*first the cost of sales entry*/
-                add_gl_trans_std_cost(10, $invoice_no, $date_, $stock_gl_code["cogs_account"], 
-                       $stock_gl_code["dimension_id"], $stock_gl_code["dimension2_id"], "", 
-                       $order_line->standard_cost * $order_line->qty_dispatched, 
-                       payment_person_types::customer(), $invoice->customer_id, 
-                                       "The cost of sales GL posting could not be inserted");
-                                                                               
-                               /*now the stock entry*/
-                               //$stock_gl_code = get_stock_gl_code($order_line->stock_id);
-                               
-                add_gl_trans_std_cost(10, $invoice_no, $date_, $stock_gl_code["inventory_account"], 0, 0, "", 
-                       (-$order_line->standard_cost * $order_line->qty_dispatched), 
-                       payment_person_types::customer(), $invoice->customer_id, 
-                                       "The stock side of the cost of sales GL posting could not be inserted");                                
-
-                       } /* end of if GL and stock integrated and standard cost !=0 */
-
-                       if ($order_line->price != 0)
-                       {
 
+       $branch_data = get_branch_accounts($invoice->Branch);
+
+       $customer = get_customer($invoice->customer_id);
+
+       add_new_exchange_rate($customer['curr_code'], $date_, $invoice->ex_rate);
+
+       // offer price values without freight costs
+       $items_total = $invoice->get_items_total_dispatch();
+       $freight_tax = $invoice->get_shipping_tax();
+
+       update_customer_trans_version(get_parent_type(ST_SALESINVOICE), $invoice->src_docs);
+
+       $ov_gst = 0;
+       $taxes = $invoice->get_taxes(); // all taxes with freight_tax
+
+       foreach ($taxes as $taxitem) {
+               $taxitem['Value'] =  round2($taxitem['Value'], user_price_dec());
+               $ov_gst +=  $taxitem['Value'];
+       }
+
+       if($invoice->tax_included==0) {
+           $items_added_tax = $ov_gst-$freight_tax;
+           $freight_added_tax = $freight_tax;
+       } else {
+           $items_added_tax = 0;
+           $freight_added_tax = 0;
+       }
+
+       /* Insert/update the debtor_trans */
+       $sales_order = $invoice->order_no;
+       if (is_array($sales_order))
+                       $sales_order = $sales_order[0]; // assume all crucial SO data are same for every delivery
+
+       if ($trans_no != 0) {
+         delete_comments(ST_SALESINVOICE, $trans_no);
+         void_gl_trans(ST_SALESINVOICE, $trans_no, true);
+         void_cust_allocations(ST_SALESINVOICE, $trans_no); // ?
+         void_trans_tax_details(ST_SALESINVOICE, $trans_no);
+    } 
+    $invoice_no = write_customer_trans(ST_SALESINVOICE, $trans_no, $invoice->customer_id,
+       $invoice->Branch, $date_, $invoice->reference, $items_total, 0,
+       $items_added_tax, $invoice->freight_cost, $freight_added_tax,
+       $invoice->sales_type, $sales_order, $invoice->ship_via, 
+       $invoice->due_date, 0, 0, $invoice->dimension_id, 
+       $invoice->dimension2_id, $invoice->payment); 
+       // 2008-06-14 extra $alloc, 2008-11-12 added dimension_id Joe Hunt
+
+       if ($trans_no == 0) {
+               $invoice->trans_no = array($invoice_no=>0);
+       }
+       $total = 0;
+       foreach ($invoice->line_items as $line_no => $invoice_line) {
+               $qty = $invoice_line->qty_dispatched;
+               $line_taxfree_price = get_tax_free_price_for_item($invoice_line->stock_id,
+                       $invoice_line->price * $qty, 0, $invoice->tax_included,
+                       $invoice->tax_group_array);
+
+               $line_tax = get_full_price_for_item($invoice_line->stock_id,
+                       $invoice_line->price * $qty, 0, $invoice->tax_included,
+                       $invoice->tax_group_array) - $line_taxfree_price;
+
+               write_customer_trans_detail_item(ST_SALESINVOICE, $invoice_no, $invoice_line->stock_id,
+                       $invoice_line->item_description, $invoice_line->qty_dispatched,
+                       $invoice_line->line_price(), $qty ? $line_tax/$qty : 0, $invoice_line->discount_percent,
+                       $invoice_line->standard_cost, $invoice_line->src_id,
+                       $trans_no ? $invoice_line->id : 0);
+
+               // Update delivery items for the quantity invoiced
+               if ($invoice_line->qty_old != $invoice_line->qty_dispatched)
+                       update_parent_line(ST_SALESINVOICE, $invoice_line->src_id, ($invoice_line->qty_dispatched-$invoice_line->qty_old));
+
+               if ($invoice_line->qty_dispatched != 0) {
+                       $stock_gl_code = get_stock_gl_code($invoice_line->stock_id);
+
+                       if ($invoice_line->line_price() != 0) {
                                //Post sales transaction to GL credit sales
-                               
-                add_gl_trans_customer(10, $invoice_no, $date_, $stock_gl_code["sales_account"], 
-                       $stock_gl_code["dimension_id"], $stock_gl_code["dimension2_id"], 
-                               (-$line_taxfree_price * $order_line->qty_dispatched), 
-                               $invoice->customer_id, "The sales price GL posting could not be inserted");
-                               
-                               if ($order_line->discount_percent != 0)
-                               {
-                                       
-                       add_gl_trans_customer(10, $invoice_no, $date_, 
-                                       $branch_data["sales_discount_account"], $stock_gl_code["dimension_id"], 
-                                       $stock_gl_code["dimension2_id"],
-                                       ($line_taxfree_price * $order_line->qty_dispatched * $order_line->discount_percent), 
-                                       $invoice->customer_id, "The sales discount GL posting could not be inserted");                                                  
-                               } /*end of if discount !=0 */
-                       } /*end of if sales integrated with debtors */
 
+                               // 2008-06-14. If there is a Branch Sales Account, then override with this,
+                               // else take the Item Sales Account
+                               $sales_account = ($branch_data['sales_account'] != "" ? $branch_data['sales_account'] : $stock_gl_code['sales_account']);
+                               // 2008-08-01. If there is a Customer Dimension, then override with this,
+                               // else take the Item Dimension (if any)
+                               $dim = ($invoice->dimension_id != $customer['dimension_id'] ? $invoice->dimension_id : 
+                                       ($customer['dimension_id'] != 0 ? $customer["dimension_id"] : $stock_gl_code["dimension_id"]));
+                               $dim2 = ($invoice->dimension2_id != $customer['dimension2_id'] ? $invoice->dimension2_id : 
+                                       ($customer['dimension2_id'] != 0 ? $customer["dimension2_id"] : $stock_gl_code["dimension2_id"]));
+                               $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $sales_account, $dim, $dim2,
+                                       -$line_taxfree_price ,
+                                       $invoice->customer_id, "The sales price GL posting could not be inserted");
+
+                               if ($invoice_line->discount_percent != 0) {
+
+                                       $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_,
+                                               $branch_data["sales_discount_account"], $dim, $dim2,
+                                               ($line_taxfree_price * $invoice_line->discount_percent),
+                                               $invoice->customer_id, "The sales discount GL posting could not be inserted");
+                               } /*end of if discount !=0 */
+                       }
                } /*quantity dispatched is more than 0 */
-       } /*end of order_line loop */
-
+       } /*end of delivery_line loop */
 
-       if ($bo_policy == 0)
-       {
-               // if cancelling any remaining quantities
-               close_sales_order($sales_order);
+       if (($items_total + $charge_shipping) != 0) {
+               $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $branch_data["receivables_account"], 0, 0,
+                       ($items_total + $charge_shipping + $items_added_tax + $freight_added_tax),
+                       $invoice->customer_id, "The total debtor GL posting could not be inserted");
        }
 
-       /*Post debtors transaction to GL debit debtors, credit freight re-charged and credit sales */
-       if (($invoice_items_total + $charge_shipping + $tax_total) != 0) 
-       {
-               
-       add_gl_trans_customer(10, $invoice_no, $date_, $branch_data["receivables_account"], 0, 0,
-                       ($invoice_items_total + $charge_shipping + $tax_total), 
-                       $invoice->customer_id, "The total debtor GL posting could not be inserted");                            
+       if ($charge_shipping != 0) {
+               $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $company_data["freight_act"], 0, 0,
+                       -$invoice->get_tax_free_shipping(), $invoice->customer_id,
+                       "The freight GL posting could not be inserted");
+       }
+       // post all taxes
+       foreach ($taxes as $taxitem) {
+
+               if ($taxitem['Net'] != 0) {
+                       $ex_rate = get_exchange_rate_from_home_currency(get_customer_currency($invoice->customer_id), $date_);
+                       add_trans_tax_details(ST_SALESINVOICE, $invoice_no, $taxitem['tax_type_id'],
+                               $taxitem['rate'], $invoice->tax_included, $taxitem['Value'],
+                                $taxitem['Net'], $ex_rate, $date_, $invoice->reference);
+
+                       $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $taxitem['sales_gl_code'], 0, 0,
+                               (-$taxitem['Value']), $invoice->customer_id,
+                               "A tax GL posting could not be inserted");
+               }
        }
 
-       if ($charge_shipping != 0) 
-       {
-               
-       add_gl_trans_customer(10, $invoice_no, $date_, $company_data["freight_act"], 0, 0,
-                       (-$charge_shipping), $invoice->customer_id, 
-                       "The freight GL posting could not be inserted");                                
+       /*Post a balance post if $total != 0 */
+       add_gl_balance(ST_SALESINVOICE, $invoice_no, $date_, -$total, PT_CUSTOMER, $invoice->customer_id);      
+
+       add_comments(10, $invoice_no, $date_, $invoice->Comments);
+
+       if ($trans_no == 0) {
+               $Refs->save(ST_SALESINVOICE, $invoice_no, $invoice->reference);
+               if ($invoice->payment_terms['cash_sale'] && $invoice->pos['pos_account']) {
+                       $amount = $items_total + $items_added_tax + $invoice->freight_cost 
+                               + $freight_added_tax;
+
+                       // to use debtors.pmt_discount on cash sale:
+                       // extend invoice entry page with final amount after discount 
+                       // and change line below.
+                       $discount = 0; // $invoice->cash_discount*$amount;
+                       $pmtno = write_customer_payment(0, $invoice->customer_id, 
+                               $invoice->Branch, $invoice->pos['pos_account'], $date_,
+                               $Refs->get_next(ST_CUSTPAYMENT), $amount-$discount, $discount,
+                               _('Cash invoice').' '.$invoice_no);
+                       add_cust_allocation($amount, ST_CUSTPAYMENT, $pmtno, ST_SALESINVOICE, $invoice_no);
+
+                       update_debtor_trans_allocation(ST_SALESINVOICE, $invoice_no, $amount);
+                       update_debtor_trans_allocation(ST_CUSTPAYMENT, $pmtno, $amount);
+               }
        }
-       
-    foreach ($taxes as $taxitem) 
-    {
-       if ($taxitem['Value'] != 0) 
-       {
-                       add_customer_trans_tax_detail_item(10, $invoice_no, $taxitem['tax_type_id'],
-                               $taxitem['rate'], $taxitem['included_in_price'], $taxitem['Value']);                    
-               
-               add_gl_trans_customer(10, $invoice_no, $date_, $taxitem['sales_gl_code'], 0, 0,
-                       (-$taxitem['Value']), $invoice->customer_id, 
-                       "A tax GL posting could not be inserted");
-       }       
-    }  
-    
-       add_comments(10, $invoice_no, $date_, $memo_);    
-       
-       add_forms_for_sys_type(10, $invoice_no, $location);
-       
-       references::save_last($reference, 10);  
-       
-       commit_transaction();   
-       
+       hook_db_postwrite($invoice, ST_SALESINVOICE);
+       commit_transaction();
+
        return $invoice_no;
 }
 
@@ -147,42 +191,45 @@ function add_sales_invoice(&$invoice, $date_, $due_date, $sales_order, $tax_grou
 function void_sales_invoice($type, $type_no)
 {
        begin_transaction();
-       
+
+       hook_db_prevoid($type, $type_no);
        void_bank_trans($type, $type_no, true);
        void_gl_trans($type, $type_no, true);
-       
-       // for invoices and credits related to invoices, 
-       // reverse all the changes in the sales order
-       $items_result = get_customer_trans_details($type, $type_no);
-       
-       $order = get_customer_trans_order($type, $type_no);
-       
-       if ($order) 
-       {
-               while ($row = db_fetch($items_result))
+
+       // reverse all the changes in parent document(s)
+
+       $parents = get_sales_parent_numbers($type, $type_no);
+
+       if ($parents !== 0) {
+               if ($type == ST_SALESINVOICE && count($parents) == 1 && get_reference(ST_CUSTDELIVERY, $parents[0]) == "auto")
+               {
+                       void_sales_delivery(ST_CUSTDELIVERY, $parents[0], false);
+                       $date_ = Today();
+                       add_audit_trail(ST_CUSTDELIVERY, $parents[0], $date_, _("Voided."));
+                       add_voided_entry(ST_CUSTDELIVERY, $parents[0], $date_, "");
+               }
+               else
                {
-                       dispatch_sales_order_item($order, $row["stock_id"], $row["quantity"]);                  
+                       $srcdetails = get_sales_parent_lines($type, $type_no);
+                       while ($row = db_fetch($srcdetails)) {
+                               update_parent_line($type, $row['id'], -$row['quantity']);
+                       }
                }
        }
-       
        // clear details after they've been reversed in the sales order
        void_customer_trans_details($type, $type_no);
-       
-       void_customer_trans_tax_details($type, $type_no);       
-       
-       void_cust_allocations($type, $type_no);
-       
-       // do this last because other voidings can depend on it - especially voiding
-       // DO NOT MOVE THIS ABOVE VOIDING or we can end up with trans with alloc < 0
-       void_customer_trans($type, $type_no);   
-       
-       commit_transaction();                   
-}
 
-//--------------------------------------------------------------------------------------------------
+       void_stock_move($type, $type_no); // in case of credit note with return
 
+       void_trans_tax_details($type, $type_no);
 
+       void_cust_allocations($type, $type_no);
 
+       // do this last because other voidings can depend on it - especially voiding
+       // DO NOT MOVE THIS ABOVE VOIDING or we can end up with trans with alloc < 0
+       void_customer_trans($type, $type_no);
 
+       commit_transaction();
+}
 
 ?>
\ No newline at end of file