Prevent saving zero qty lines in database.
[fa-stable.git] / 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         $company_data = get_company_prefs();
29
30         $branch_data = get_branch_accounts($invoice->Branch);
31
32         $customer = get_customer($invoice->customer_id);
33
34         // offer price values without freight costs
35         $items_total = $invoice->get_items_total_dispatch();
36         $freight_tax = $invoice->get_shipping_tax();
37
38         $delivery_no = $invoice->src_docs;
39         if (is_array($delivery_no))
40                 $delivery_no = 0;
41
42         update_customer_trans_version(get_parent_type(ST_SALESINVOICE), $invoice->src_docs);
43
44         $ov_gst = 0;
45         $taxes = $invoice->get_taxes(); // all taxes with freight_tax
46
47         foreach ($taxes as $taxitem) {
48                 $taxitem['Value'] =  round2($taxitem['Value'], user_price_dec());
49                 $ov_gst +=  $taxitem['Value'];
50         }
51
52         if($invoice->tax_included==0) {
53             $items_added_tax = $ov_gst-$freight_tax;
54             $freight_added_tax = $freight_tax;
55         } else {
56             $items_added_tax = 0;
57             $freight_added_tax = 0;
58         }
59         // 2006-06-14. If the Customer Branch AR Account is set to a Bank Account,
60         // the transaction will be settled at once.
61         if (is_bank_account($branch_data['receivables_account']))
62                 $alloc = $items_total + $items_added_tax + $invoice->freight_cost + $freight_added_tax;
63         else
64                 $alloc = 0;
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         $invoice_no = write_customer_trans(ST_SALESINVOICE, $trans_no, $invoice->customer_id,
72                 $invoice->Branch, $date_, $invoice->reference, $items_total, 0,
73                 $items_added_tax, $invoice->freight_cost, $freight_added_tax,
74                 $invoice->sales_type, $sales_order, $delivery_no,
75                 $invoice->ship_via, $invoice->due_date, $alloc, 0, $invoice->dimension_id, $invoice->dimension2_id); 
76                 // 2008-06-14 extra $alloc, 2008-11-12 added dimension_id Joe Hunt
77
78         if ($trans_no == 0) {
79                 $invoice->trans_no = array($invoice_no=>0);
80                 set_document_parent($invoice);
81         } else {
82                 delete_comments(ST_SALESINVOICE, $invoice_no);
83                 void_gl_trans(ST_SALESINVOICE, $invoice_no, true);
84                 void_cust_allocations(ST_SALESINVOICE, $invoice_no); // ?
85                 void_trans_tax_details(ST_SALESINVOICE, $invoice_no);
86         }
87         $total = 0;
88         foreach ($invoice->line_items as $line_no => $invoice_line) {
89                 if ($invoice_line->qty_dispatched == 0) {
90                         unset($invoice->line_items[$line_no]);
91                         continue;
92                 }
93                 $line_taxfree_price = get_tax_free_price_for_item($invoice_line->stock_id,
94                         $invoice_line->price, 0, $invoice->tax_included,
95                         $invoice->tax_group_array);
96
97                 $line_tax = get_full_price_for_item($invoice_line->stock_id,
98                         $invoice_line->price, 0, $invoice->tax_included,
99                         $invoice->tax_group_array) - $line_taxfree_price;
100
101                 write_customer_trans_detail_item(ST_SALESINVOICE, $invoice_no, $invoice_line->stock_id,
102                         $invoice_line->item_description, $invoice_line->qty_dispatched,
103                         $invoice_line->line_price(), $line_tax, $invoice_line->discount_percent,
104                         $invoice_line->standard_cost,
105                         $trans_no ? $invoice_line->id : 0);
106
107                 // Update delivery items for the quantity invoiced
108                 if ($invoice_line->qty_old != $invoice_line->qty_dispatched)
109                         update_parent_line(ST_SALESINVOICE, $invoice_line->src_id, ($invoice_line->qty_dispatched-$invoice_line->qty_old));
110
111                 if ($invoice_line->qty_dispatched != 0) {
112                         $stock_gl_code = get_stock_gl_code($invoice_line->stock_id);
113
114                         if ($invoice_line->line_price() != 0) {
115                                 //Post sales transaction to GL credit sales
116
117                                 // 2008-06-14. If there is a Branch Sales Account, then override with this,
118                                 // else take the Item Sales Account
119                                 $sales_account = ($branch_data['sales_account'] != "" ? $branch_data['sales_account'] : $stock_gl_code['sales_account']);
120                                 // 2008-08-01. If there is a Customer Dimension, then override with this,
121                                 // else take the Item Dimension (if any)
122                                 $dim = ($invoice->dimension_id != $customer['dimension_id'] ? $invoice->dimension_id : 
123                                         ($customer['dimension_id'] != 0 ? $customer["dimension_id"] : $stock_gl_code["dimension_id"]));
124                                 $dim2 = ($invoice->dimension2_id != $customer['dimension2_id'] ? $invoice->dimension2_id : 
125                                         ($customer['dimension2_id'] != 0 ? $customer["dimension2_id"] : $stock_gl_code["dimension2_id"]));
126                                 $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $sales_account, $dim, $dim2,
127                                         (-$line_taxfree_price * $invoice_line->qty_dispatched),
128                                         $invoice->customer_id, "The sales price GL posting could not be inserted");
129
130                                 if ($invoice_line->discount_percent != 0) {
131
132                                         $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_,
133                                                 $branch_data["sales_discount_account"], $dim, $dim2,
134                                                 ($line_taxfree_price * $invoice_line->qty_dispatched * $invoice_line->discount_percent),
135                                                 $invoice->customer_id, "The sales discount GL posting could not be inserted");
136                                 } /*end of if discount !=0 */
137                         }
138                 } /*quantity dispatched is more than 0 */
139         } /*end of delivery_line loop */
140
141         if (($items_total + $charge_shipping) != 0) {
142                 $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $branch_data["receivables_account"], 0, 0,
143                         ($items_total + $charge_shipping + $items_added_tax + $freight_added_tax),
144                         $invoice->customer_id, "The total debtor GL posting could not be inserted");
145         }
146
147         if ($charge_shipping != 0) {
148                 $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $company_data["freight_act"], 0, 0,
149                         -$invoice->get_tax_free_shipping(), $invoice->customer_id,
150                         "The freight GL posting could not be inserted");
151         }
152         // post all taxes
153         foreach ($taxes as $taxitem) {
154
155                 if ($taxitem['Net'] != 0) {
156                         $ex_rate = get_exchange_rate_from_home_currency(get_customer_currency($invoice->customer_id), $date_);
157                         add_trans_tax_details(ST_SALESINVOICE, $invoice_no, $taxitem['tax_type_id'],
158                                 $taxitem['rate'], $invoice->tax_included, $taxitem['Value'],
159                                  $taxitem['Net'], $ex_rate, $date_, $invoice->reference);
160
161                         $total += add_gl_trans_customer(ST_SALESINVOICE, $invoice_no, $date_, $taxitem['sales_gl_code'], 0, 0,
162                                 (-$taxitem['Value']), $invoice->customer_id,
163                                 "A tax GL posting could not be inserted");
164                 }
165         }
166
167         /*Post a balance post if $total != 0 */
168         add_gl_balance(ST_SALESINVOICE, $invoice_no, $date_, -$total, PT_CUSTOMER, $invoice->customer_id);      
169
170         add_comments(10, $invoice_no, $date_, $invoice->Comments);
171
172         if ($trans_no == 0) {
173                 $Refs->save(ST_SALESINVOICE, $invoice_no, $invoice->reference);
174                 if ($invoice->cash) {
175                         $amount = $items_total + $items_added_tax + $invoice->freight_cost 
176                                 + $freight_added_tax;
177
178                         // to use debtors.pmt_discount on cash sale:
179                         // extend invoice entry page with final amount after discount 
180                         // and change line below.
181                         $discount = 0; // $invoice->cash_discount*$amount;
182                         $pmtno = write_customer_payment(0, $invoice->customer_id, 
183                                 $invoice->Branch, $invoice->cash_account, $date_,
184                                 $Refs->get_next(ST_CUSTPAYMENT), $amount-$discount, $discount,
185                                 _('Cash invoice').' '.$invoice_no);
186                         add_cust_allocation($amount, ST_CUSTPAYMENT, $pmtno, ST_SALESINVOICE, $invoice_no);
187
188                         update_debtor_trans_allocation(ST_SALESINVOICE, $invoice_no, $amount);
189                         update_debtor_trans_allocation(ST_CUSTPAYMENT, $pmtno, $amount);
190                 }
191         }
192         commit_transaction();
193
194         return $invoice_no;
195 }
196
197 //--------------------------------------------------------------------------------------------------
198
199 function void_sales_invoice($type, $type_no)
200 {
201         begin_transaction();
202
203         void_bank_trans($type, $type_no, true);
204         void_gl_trans($type, $type_no, true);
205
206         // reverse all the changes in parent document(s)
207         $items_result = get_customer_trans_details($type, $type_no);
208
209         $deliveries = get_parent_trans($type, $type_no);
210
211         if ($deliveries !== 0) {
212                 $srcdetails = get_customer_trans_details(get_parent_type($type), $deliveries);
213                 while ($row = db_fetch($items_result)) {
214                         $src_line = db_fetch($srcdetails);
215                         update_parent_line($type, $src_line['id'], -$row['quantity']);
216                 }
217         }
218         // clear details after they've been reversed in the sales order
219         void_customer_trans_details($type, $type_no);
220
221         void_trans_tax_details($type, $type_no);
222
223         void_cust_allocations($type, $type_no);
224
225         // do this last because other voidings can depend on it - especially voiding
226         // DO NOT MOVE THIS ABOVE VOIDING or we can end up with trans with alloc < 0
227         void_customer_trans($type, $type_no);
228
229         commit_transaction();
230 }
231
232 ?>