2 /**********************************************************************
3 Copyright (C) FrontAccounting, LLC.
4 Released under the terms of the GNU Affero General Public License,
5 AGPL, as published by the Free Software Foundation, either version
6 3 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/agpl-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)
18 $credit_invoice = is_array($credit_note->src_docs) ?
19 reset(array_keys($credit_note->src_docs)) : $credit_note->src_docs;
21 $credit_date = $credit_note->document_date;
22 $tax_group_id = $credit_note->tax_group_id;
24 $trans_no = $credit_note->trans_no;
25 if (is_array($trans_no)) {
26 $trans_no = key($trans_no);
29 $credit_type = $write_off_acc == 0 ? 'Return' : 'WriteOff';
33 $company_data = get_company_prefs();
34 $branch_data = get_branch_accounts($credit_note->Branch);
36 $credit_note_total = $credit_note->get_items_total_dispatch();
37 $freight_tax = $credit_note->get_shipping_tax();
39 $taxes = $credit_note->get_taxes();
42 foreach ($taxes as $taxitem) {
43 $tax_total += $taxitem['Value'];
46 if ($credit_note->tax_included == 0) {
47 $items_added_tax = $tax_total-$freight_tax;
48 $freight_added_tax = $freight_tax;
51 $freight_added_tax = 0;
53 // 2006-06-14. If the Customer Branch AR Account is set to a Bank Account,
54 // the transaction will be settled at once.
55 if (is_bank_account($branch_data['receivables_account']))
56 $alloc = $credit_note_total + $items_added_tax + $credit_note->freight_cost + $freight_added_tax;
60 // $sales_order=$invoice->order_no; //?
61 // if (is_array($sales_order)) $sales_order = $sales_order[0]; //?
62 if (!isset($credit_note->order_no))
63 $credit_note->order_no = 0;
65 /*Now insert the Credit Note into the debtor_trans table with the allocations as calculated above*/
66 // all amounts in debtor's currency
67 $credit_no = write_customer_trans(11, $trans_no, $credit_note->customer_id,
68 $credit_note->Branch, $credit_date, $credit_note->reference,
69 $credit_note_total, 0, $items_added_tax,
70 $credit_note->freight_cost, $freight_added_tax,
71 $credit_note->sales_type,
72 $credit_note->order_no, $credit_invoice, $credit_note->ship_via,
73 null, $alloc, 0, $credit_note->dimension_id, $credit_note->dimension2_id);
74 // 2008-06-14 extra $alloc, 2008-11-12 dimension_id Joe Hunt
77 $credit_note->trans_no = array($credit_no=>0);
78 set_document_parent($credit_note);
80 delete_comments(11, $credit_no);
81 void_cust_allocations(11, $credit_no, $credit_date);
82 void_gl_trans(11, $credit_no, true);
83 void_stock_move(11, $credit_no);
84 void_trans_tax_details(11, $credit_no);
86 if ($credit_invoice) {
87 $invoice_alloc_balance = get_DebtorTrans_allocation_balance(10, $credit_invoice);
88 update_customer_trans_version(get_parent_type(11), $credit_note->src_docs );
89 if ($invoice_alloc_balance > 0) { //the invoice is not already fully allocated
90 $total = $credit_note_total + $credit_note->freight_cost +
91 $items_added_tax + $freight_added_tax;
93 $allocate_amount = ($invoice_alloc_balance > $total) ? $total : $invoice_alloc_balance;
94 /*Now insert the allocation record if > 0 */
95 if ($allocate_amount != 0) {
96 update_debtor_trans_allocation(10, $credit_invoice, $allocate_amount);
97 update_debtor_trans_allocation(11, $credit_no, $allocate_amount); // ***
98 add_cust_allocation($allocate_amount, 11, $credit_no, 10, $credit_invoice);
99 // Exchange Variations Joe Hunt 2008-09-20 ////////////////////////////////////////
101 exchange_variation(11, $credit_no, 10, $credit_invoice, $credit_date,
102 $allocate_amount, payment_person_types::customer());
104 ///////////////////////////////////////////////////////////////////////////
111 foreach ($credit_note->line_items as $credit_line) {
113 if ($credit_invoice && $credit_line->qty_dispatched!=$credit_line->qty_old ) {
114 update_parent_line(11, $credit_line->src_id,($credit_line->qty_dispatched
115 -$credit_line->qty_old));
118 $line_taxfree_price = get_tax_free_price_for_item($credit_line->stock_id, $credit_line->price,
119 0, $credit_note->tax_included, $credit_note->tax_group_array);
121 $line_tax = get_full_price_for_item($credit_line->stock_id, $credit_line->price,
122 0, $credit_note->tax_included, $credit_note->tax_group_array) - $line_taxfree_price;
124 write_customer_trans_detail_item(11, $credit_no, $credit_line->stock_id,
125 $credit_line->item_description, $credit_line->qty_dispatched,
126 $credit_line->line_price(), $line_tax, $credit_line->discount_percent,
127 $credit_line->standard_cost, $trans_no==0 ? 0: $credit_line->id);
129 add_credit_movements_item($credit_note, $credit_line,
130 $credit_type, $line_taxfree_price+$line_tax, $credit_invoice);
132 $total += add_gl_trans_credit_costs($credit_note, $credit_line, $credit_no,
133 $credit_date, $credit_type, $write_off_acc, $branch_data);
134 } /*end of credit_line loop */
136 /*Post credit note transaction to GL credit debtors,
137 debit freight re-charged and debit sales */
139 if (($credit_note_total + $credit_note->freight_cost) != 0) {
141 $total += add_gl_trans_customer(11, $credit_no, $credit_date, $branch_data["receivables_account"], 0, 0,
142 -($credit_note_total + $credit_note->freight_cost + $items_added_tax + $freight_added_tax),
143 $credit_note->customer_id,
144 "The total debtor GL posting for the credit note could not be inserted");
147 if ($credit_note->freight_cost !=0) {
148 $total += add_gl_trans_customer(11, $credit_no, $credit_date, $company_data["freight_act"], 0, 0,
149 $credit_note->get_tax_free_shipping(), $credit_note->customer_id,
150 "The freight GL posting for this credit note could not be inserted");
153 foreach ($taxes as $taxitem) {
154 if ($taxitem['Net'] != 0) {
156 add_trans_tax_details(11, $credit_no, $taxitem['tax_type_id'],
157 $taxitem['rate'], $credit_note->tax_included, $taxitem['Value'],
158 $taxitem['Net'], $credit_note->document_date, $credit_note->reference);
160 $total += add_gl_trans_customer(11, $credit_no, $credit_date, $taxitem['sales_gl_code'], 0, 0,
161 $taxitem['Value'], $credit_note->customer_id,
162 "A tax GL posting for this credit note could not be inserted");
165 /*Post a balance post if $total != 0 */
166 add_gl_balance(11, $credit_no, $credit_date, -$total, payment_person_types::customer(), $credit_note->customer_id);
168 add_comments(11, $credit_no, $credit_date, $credit_note->Comments);
170 if ($trans_no == 0) {
171 references::save_last($credit_note->reference, 11);
174 commit_transaction();
179 //----------------------------------------------------------------------------------------
180 // Insert a stock movement coming back in to show the credit note and
181 // a reversing stock movement to show the write off
183 function add_credit_movements_item(&$credit_note, &$credit_line,
184 $credit_type, $price, $credited_invoice=0)
187 if ($credit_type == "Return") {
189 $reference = "Return ";
190 if ($credited_invoice) {
191 $reference .= "Ex Inv: " . $credited_invoice;
194 } elseif ($credit_type == "WriteOff") {
196 $reference = "WriteOff ";
197 if ($credited_invoice)
198 $reference .= "Ex Inv: " . $credited_invoice;
200 add_stock_move_customer(11, $credit_line->stock_id,
201 key($credit_note->trans_no), $credit_note->Location,
202 $credit_note->document_date, $reference, -$credit_line->qty_dispatched,
203 $credit_line->standard_cost, 0, $price,
204 $credit_line->discount_percent);
207 add_stock_move_customer(11, $credit_line->stock_id,
208 key($credit_note->trans_no), $credit_note->Location,
209 $credit_note->document_date, $reference, $credit_line->qty_dispatched,
210 $credit_line->standard_cost, 0, $price,
211 $credit_line->discount_percent);
215 //----------------------------------------------------------------------------------------
217 function add_gl_trans_credit_costs($order, $order_line, $credit_no, $date_,
218 $credit_type, $write_off_gl_code, &$branch_data)
220 $stock_gl_codes = get_stock_gl_code($order_line->stock_id);
221 $customer = get_customer($order->customer_id);
222 // 2008-08-01. If there is a Customer Dimension, then override with this,
223 // else take the Item Dimension (if any)
224 $dim = ($order->dimension_id != $customer['dimension_id'] ? $order->dimension_id :
225 ($customer['dimension_id'] != 0 ? $customer["dimension_id"] : $stock_gl_codes["dimension_id"]));
226 $dim2 = ($order->dimension2_id != $customer['dimension2_id'] ? $order->dimension2_id :
227 ($customer['dimension2_id'] != 0 ? $customer["dimension2_id"] : $stock_gl_codes["dimension2_id"]));
230 /* insert gl_trans to credit stock and debit cost of sales at standard cost*/
231 $standard_cost = get_standard_cost($order_line->stock_id);
232 if ($standard_cost != 0) {
233 /*first the cost of sales entry*/
235 $total += add_gl_trans_std_cost(11, $credit_no, $date_, $stock_gl_codes["cogs_account"],
236 $dim, $dim2, "", -($standard_cost * $order_line->qty_dispatched),
237 payment_person_types::customer(), $order->customer_id,
238 "The cost of sales GL posting could not be inserted");
240 /*now the stock entry*/
241 if ($credit_type == "WriteOff") {
242 $stock_entry_account = $write_off_gl_code;
244 $stock_gl_code = get_stock_gl_code($order_line->stock_id);
245 $stock_entry_account = $stock_gl_code["inventory_account"];
248 $total += add_gl_trans_std_cost(11, $credit_no, $date_, $stock_entry_account, 0, 0,
249 "", ($standard_cost * $order_line->qty_dispatched),
250 payment_person_types::customer(), $order->customer_id,
251 "The stock side (or write off) of the cost of sales GL posting could not be inserted");
253 } /* end of if GL and stock integrated and standard cost !=0 */
255 if ($order_line->line_price() != 0) {
257 $line_taxfree_price =
258 get_tax_free_price_for_item($order_line->stock_id, $order_line->price,
259 0, $order->tax_included, $order->tax_group_array);
261 $line_tax = get_full_price_for_item($order_line->stock_id, $order_line->price,
262 0, $order->tax_included, $order->tax_group_array) - $line_taxfree_price;
265 //Post sales transaction to GL credit sales
267 // 2008-06-14. If there is a Branch Sales Account, then override with this,
268 // else take the Item Sales Account
269 if ($branch_data['sales_account'] != "")
270 $sales_account = $branch_data['sales_account'];
272 $sales_account = $stock_gl_codes['sales_account'];
273 $total += add_gl_trans_customer(11, $credit_no, $date_, $sales_account, $dim, $dim2,
274 ($line_taxfree_price * $order_line->qty_dispatched), $order->customer_id,
275 "The credit note GL posting could not be inserted");
277 if ($order_line->discount_percent != 0) {
279 $total += add_gl_trans_customer(11, $credit_no, $date_, $branch_data["sales_discount_account"],
280 $dim, $dim2, -($line_taxfree_price * $order_line->qty_dispatched * $order_line->discount_percent),
282 "The credit note discount GL posting could not be inserted");
284 } /*end of if discount !=0 */
285 } /*if line_price!=0 */