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 // if ($writeoff_acc==0) return goods into $cart->Location
14 // if src_docs!=0 => credit invoice else credit note
16 function write_credit_note(&$credit_note, $write_off_acc)
20 $credit_invoice = is_array($credit_note->src_docs) ?
21 reset(array_keys($credit_note->src_docs)) : $credit_note->src_docs;
23 $credit_date = $credit_note->document_date;
24 $tax_group_id = $credit_note->tax_group_id;
26 $trans_no = $credit_note->trans_no;
27 if (is_array($trans_no)) {
28 $trans_no = key($trans_no);
31 $credit_type = $write_off_acc == 0 ? 'Return' : 'WriteOff';
34 hook_db_prewrite($credit_note, ST_CUSTCREDIT);
36 $company_data = get_company_prefs();
37 $branch_data = get_branch_accounts($credit_note->Branch);
39 $credit_note_total = $credit_note->get_items_total_dispatch();
40 $freight_tax = $credit_note->get_shipping_tax();
42 $taxes = $credit_note->get_taxes();
45 foreach ($taxes as $taxitem) {
46 $taxitem['Value'] = round2($taxitem['Value'], user_price_dec());
47 $tax_total += $taxitem['Value'];
50 if ($credit_note->tax_included == 0) {
51 $items_added_tax = $tax_total-$freight_tax;
52 $freight_added_tax = $freight_tax;
55 $freight_added_tax = 0;
57 // 2006-06-14. If the Customer Branch AR Account is set to a Bank Account,
58 // the transaction will be settled at once.
59 if (is_bank_account($branch_data['receivables_account']))
60 $alloc = $credit_note_total + $items_added_tax + $credit_note->freight_cost + $freight_added_tax;
64 // $sales_order=$invoice->order_no; //?
65 // if (is_array($sales_order)) $sales_order = $sales_order[0]; //?
66 if (!isset($credit_note->order_no))
67 $credit_note->order_no = 0;
69 /*Now insert the Credit Note into the debtor_trans table with the allocations as calculated above*/
70 // all amounts in debtor's currency
71 $credit_no = write_customer_trans(ST_CUSTCREDIT, $trans_no, $credit_note->customer_id,
72 $credit_note->Branch, $credit_date, $credit_note->reference,
73 $credit_note_total, 0, $items_added_tax,
74 $credit_note->freight_cost, $freight_added_tax,
75 $credit_note->sales_type, $credit_note->order_no, $credit_note->ship_via,
76 null, $alloc, 0, $credit_note->dimension_id, $credit_note->dimension2_id,
77 $credit_note->payment);
78 // 2008-06-14 extra $alloc, 2008-11-12 dimension_id Joe Hunt
81 $credit_note->trans_no = array($credit_no=>0);
83 delete_comments(ST_CUSTCREDIT, $credit_no);
84 void_cust_allocations(ST_CUSTCREDIT, $credit_no, $credit_date);
85 void_gl_trans(ST_CUSTCREDIT, $credit_no, true);
86 void_stock_move(ST_CUSTCREDIT, $credit_no);
87 void_trans_tax_details(ST_CUSTCREDIT, $credit_no);
89 if ($credit_invoice) {
90 update_customer_trans_version(get_parent_type(ST_CUSTCREDIT), $credit_note->src_docs );
92 $total = $credit_note_total + $credit_note->freight_cost + $items_added_tax
95 if (!credit_sales_invoice_allocate($credit_invoice, $credit_no, $total, $credit_date))
100 foreach ($credit_note->line_items as $credit_line) {
102 if ($credit_invoice && $credit_line->qty_dispatched!=$credit_line->qty_old ) {
103 update_parent_line(ST_CUSTCREDIT, $credit_line->src_id,($credit_line->qty_dispatched
104 -$credit_line->qty_old));
107 $line_taxfree_price = get_tax_free_price_for_item($credit_line->stock_id, $credit_line->price,
108 0, $credit_note->tax_included, $credit_note->tax_group_array);
110 $line_tax = get_full_price_for_item($credit_line->stock_id, $credit_line->price,
111 0, $credit_note->tax_included, $credit_note->tax_group_array) - $line_taxfree_price;
113 write_customer_trans_detail_item(ST_CUSTCREDIT, $credit_no, $credit_line->stock_id,
114 $credit_line->item_description, $credit_line->qty_dispatched,
115 $credit_line->line_price(), $line_tax, $credit_line->discount_percent,
116 $credit_line->standard_cost, $credit_line->src_id, $trans_no==0 ? 0: $credit_line->id);
118 add_credit_movements_item($credit_note, $credit_line,
119 $credit_type, $line_taxfree_price+$line_tax, $credit_invoice);
121 $total += add_gl_trans_credit_costs($credit_note, $credit_line, $credit_no,
122 $credit_date, $credit_type, $write_off_acc, $branch_data);
123 } /*end of credit_line loop */
125 /*Post credit note transaction to GL credit debtors,
126 debit freight re-charged and debit sales */
128 if (($credit_note_total + $credit_note->freight_cost) != 0) {
130 $total += add_gl_trans_customer(ST_CUSTCREDIT, $credit_no, $credit_date, $branch_data["receivables_account"], 0, 0,
131 -($credit_note_total + $credit_note->freight_cost + $items_added_tax + $freight_added_tax),
132 $credit_note->customer_id,
133 "The total debtor GL posting for the credit note could not be inserted");
136 if ($credit_note->freight_cost != 0) {
137 $total += add_gl_trans_customer(ST_CUSTCREDIT, $credit_no, $credit_date, $company_data["freight_act"], 0, 0,
138 $credit_note->get_tax_free_shipping(), $credit_note->customer_id,
139 "The freight GL posting for this credit note could not be inserted");
142 foreach ($taxes as $taxitem) {
143 if ($taxitem['Net'] != 0) {
145 $ex_rate = get_exchange_rate_from_home_currency(get_customer_currency($credit_note->customer_id), $credit_note->document_date);
146 add_trans_tax_details(ST_CUSTCREDIT, $credit_no, $taxitem['tax_type_id'],
147 $taxitem['rate'], $credit_note->tax_included, $taxitem['Value'],
148 $taxitem['Net'], $ex_rate,
149 $credit_note->document_date, $credit_note->reference);
151 $total += add_gl_trans_customer(ST_CUSTCREDIT, $credit_no, $credit_date, $taxitem['sales_gl_code'], 0, 0,
152 $taxitem['Value'], $credit_note->customer_id,
153 "A tax GL posting for this credit note could not be inserted");
156 /*Post a balance post if $total != 0 */
157 add_gl_balance(ST_CUSTCREDIT, $credit_no, $credit_date, -$total, PT_CUSTOMER, $credit_note->customer_id);
159 add_comments(ST_CUSTCREDIT, $credit_no, $credit_date, $credit_note->Comments);
161 if ($trans_no == 0) {
162 $Refs->save(ST_CUSTCREDIT, $credit_no, $credit_note->reference);
164 hook_db_postwrite($credit_note, ST_CUSTCREDIT);
165 commit_transaction();
170 //----------------------------------------------------------------------------------------
171 // Insert a stock movement coming back in to show the credit note and
172 // a reversing stock movement to show the write off
174 function add_credit_movements_item(&$credit_note, &$credit_line,
175 $credit_type, $price, $credited_invoice=0)
178 if ($credit_type == "Return") {
180 $reference = "Return ";
181 if ($credited_invoice) {
182 $reference .= "Ex Inv: " . $credited_invoice;
185 } elseif ($credit_type == "WriteOff") {
187 $reference = "WriteOff ";
188 if ($credited_invoice)
189 $reference .= "Ex Inv: " . $credited_invoice;
191 add_stock_move_customer(ST_CUSTCREDIT, $credit_line->stock_id,
192 key($credit_note->trans_no), $credit_note->Location,
193 $credit_note->document_date, $reference, -$credit_line->qty_dispatched,
194 $credit_line->standard_cost, 0, $price,
195 $credit_line->discount_percent);
198 add_stock_move_customer(ST_CUSTCREDIT, $credit_line->stock_id,
199 key($credit_note->trans_no), $credit_note->Location,
200 $credit_note->document_date, $reference, $credit_line->qty_dispatched,
201 $credit_line->standard_cost, 0, $price,
202 $credit_line->discount_percent);
206 //----------------------------------------------------------------------------------------
208 function add_gl_trans_credit_costs($order, $order_line, $credit_no, $date_,
209 $credit_type, $write_off_gl_code, &$branch_data)
211 $stock_gl_codes = get_stock_gl_code($order_line->stock_id);
212 $customer = get_customer($order->customer_id);
213 // 2008-08-01. If there is a Customer Dimension, then override with this,
214 // else take the Item Dimension (if any)
215 $dim = ($order->dimension_id != $customer['dimension_id'] ? $order->dimension_id :
216 ($customer['dimension_id'] != 0 ? $customer["dimension_id"] : $stock_gl_codes["dimension_id"]));
217 $dim2 = ($order->dimension2_id != $customer['dimension2_id'] ? $order->dimension2_id :
218 ($customer['dimension2_id'] != 0 ? $customer["dimension2_id"] : $stock_gl_codes["dimension2_id"]));
221 /* insert gl_trans to credit stock and debit cost of sales at standard cost*/
222 $standard_cost = get_standard_cost($order_line->stock_id);
223 if ($standard_cost != 0) {
224 /*first the cost of sales entry*/
226 $total += add_gl_trans_std_cost(ST_CUSTCREDIT, $credit_no, $date_, $stock_gl_codes["cogs_account"],
227 $dim, $dim2, "", -($standard_cost * $order_line->qty_dispatched),
228 PT_CUSTOMER, $order->customer_id,
229 "The cost of sales GL posting could not be inserted");
231 /*now the stock entry*/
232 if ($credit_type == "WriteOff") {
233 $stock_entry_account = $write_off_gl_code;
235 $stock_gl_code = get_stock_gl_code($order_line->stock_id);
236 $stock_entry_account = $stock_gl_code["inventory_account"];
239 $total += add_gl_trans_std_cost(ST_CUSTCREDIT, $credit_no, $date_, $stock_entry_account, 0, 0,
240 "", ($standard_cost * $order_line->qty_dispatched),
241 PT_CUSTOMER, $order->customer_id,
242 "The stock side (or write off) of the cost of sales GL posting could not be inserted");
244 } /* end of if GL and stock integrated and standard cost !=0 */
246 if ($order_line->line_price() != 0) {
248 $line_taxfree_price =
249 get_tax_free_price_for_item($order_line->stock_id, $order_line->price,
250 0, $order->tax_included, $order->tax_group_array);
252 $line_tax = get_full_price_for_item($order_line->stock_id, $order_line->price,
253 0, $order->tax_included, $order->tax_group_array) - $line_taxfree_price;
256 //Post sales transaction to GL credit sales
258 // 2008-06-14. If there is a Branch Sales Account, then override with this,
259 // else take the Item Sales Account
260 if ($branch_data['sales_account'] != "")
261 $sales_account = $branch_data['sales_account'];
263 $sales_account = $stock_gl_codes['sales_account'];
264 $total += add_gl_trans_customer(ST_CUSTCREDIT, $credit_no, $date_, $sales_account, $dim, $dim2,
265 ($line_taxfree_price * $order_line->qty_dispatched), $order->customer_id,
266 "The credit note GL posting could not be inserted");
268 if ($order_line->discount_percent != 0) {
270 $total += add_gl_trans_customer(ST_CUSTCREDIT, $credit_no, $date_, $branch_data["sales_discount_account"],
271 $dim, $dim2, -($line_taxfree_price * $order_line->qty_dispatched * $order_line->discount_percent),
273 "The credit note discount GL posting could not be inserted");
275 } /*end of if discount !=0 */
276 } /*if line_price!=0 */