3 //----------------------------------------------------------------------------------------
4 // if ($writeoff_acc==0) return goods into $cart->Location
5 // if src_docs!=0 => credit invoice else credit note
7 function write_credit_note($credit_note, $write_off_acc)
9 $credit_invoice = count($credit_note->src_docs) ? key($credit_note->src_docs) : 0;
12 $credit_date = $credit_note->document_date;
13 $tax_group_id = $credit_note->tax_group_id;
15 $trans_no = $credit_note->trans_no;
16 if (is_array($trans_no)) {
17 $trans_no = key($trans_no);
20 $credit_type = $write_off_acc == 0 ? 'Return' : 'Writeoff';
24 $company_data = get_company_prefs();
25 $branch_data = get_branch_accounts($credit_note->Branch);
27 $credit_note_total = $credit_note->get_items_total_dispatch();
28 $freight_tax = $credit_note->get_shipping_tax();
30 $taxes = $credit_note->get_taxes();
33 foreach ($taxes as $taxitem) {
34 $tax_total += $taxitem['Value'];
37 if ($credit_note->tax_included == 0) {
38 $items_added_tax = $tax_total-$freight_tax;
39 $freight_added_tax = $freight_tax;
42 $freight_added_tax = 0;
45 // $sales_order=$invoice->order_no; //?
46 // if (is_array($sales_order)) $sales_order = $sales_order[0]; //?
47 if (!isset($credit_note->order_no))
48 $credit_note->order_no = 0;
50 /*Now insert the Credit Note into the debtor_trans table with the allocations as calculated above*/
51 // all amounts in debtor's currency
52 $credit_no = write_customer_trans(11, $trans_no, $credit_note->customer_id,
53 $credit_note->Branch, $credit_date, $credit_note->reference,
54 $credit_note_total, 0, $items_added_tax,
55 $credit_note->freight_cost, $freight_added_tax,
56 $credit_note->sales_type,
57 $credit_note->order_no, $credit_invoice, $credit_note->ship_via
58 //, $credit_note->due_date
62 $credit_note->trans_no = array($credit_no=>0);
63 set_document_parent($credit_note);
65 delete_comments(11, $credit_no);
66 void_cust_allocations(11, $credit_no);
67 void_gl_trans(11, $credit_no, true);
68 void_stock_move(11, $credit_no);
69 void_customer_trans_tax_details(11, $credit_no);
72 if ($credit_invoice) {
73 $invoice_alloc_balance = get_DebtorTrans_allocation_balance(10, $credit_invoice);
74 update_customer_trans_version(get_parent_type(11), $credit_note->src_docs );
75 if ($invoice_alloc_balance > 0) { /*the invoice is not already fully allocated */
76 $total = $credit_note_total + $credit_note->freight_cost +
77 $items_added_tax + $freight_added_tax;
79 $allocate_amount = ($invoice_alloc_balance > $total) ? $total : $invoice_alloc_balance;
80 /*Now insert the allocation record if > 0 */
81 if ($allocate_amount != 0) {
82 update_debtor_trans_allocation(10, $credit_invoice, $allocate_amount);
83 update_debtor_trans_allocation(11, $credit_no, $allocate_amount); // ***
84 add_cust_allocation($allocate_amount, 11, $credit_no, 10, $credit_invoice);
89 foreach ($credit_note->line_items as $credit_line) {
91 if ($credit_invoice && $credit_line->qty_dispatched!=$credit_line->qty_old ) {
92 update_parent_line(11, $credit_line->id,($credit_line->qty_dispatched
93 -$credit_line->qty_old));
96 $line_taxfree_price = get_tax_free_price_for_item($credit_line->stock_id, $credit_line->price,
97 0, $credit_note->tax_included, $credit_note->tax_group_array);
99 $line_tax = get_full_price_for_item($credit_line->stock_id, $credit_line->price,
100 0, $credit_note->tax_included, $credit_note->tax_group_array) - $line_taxfree_price;
102 write_customer_trans_detail_item(11, $credit_no, $credit_line->stock_id,
103 $credit_line->item_description, $credit_line->qty_dispatched,
104 $credit_line->line_price(), $line_tax, $credit_line->discount_percent,
105 $credit_line->standard_cost, $trans_no==0 ? 0: $credit_line->id);
107 add_credit_movements_item($credit_note, $credit_line,
108 $credit_type, $line_taxfree_price+$line_tax, $credit_invoice);
110 add_gl_trans_credit_costs($credit_note, $credit_line, $credit_no,
111 $credit_date, $credit_type, $write_off_acc, $branch_data);
112 } /*end of credit_line loop */
114 /*Post credit note transaction to GL credit debtors,
115 debit freight re-charged and debit sales */
117 if (($credit_note_total + $credit_note->freight_cost) != 0) {
119 add_gl_trans_customer(11, $credit_no, $credit_date, $branch_data["receivables_account"], 0, 0,
120 -($credit_note_total + $credit_note->freight_cost + $items_added_tax + $freight_added_tax),
121 $credit_note->customer_id,
122 "The total debtor GL posting for the credit note could not be inserted");
125 if ($credit_note->freight_cost !=0) {
126 add_gl_trans_customer(11, $credit_no, $credit_date, $company_data["freight_act"], 0, 0,
127 $credit_note->get_tax_free_shipping(), $credit_note->customer_id,
128 "The freight GL posting for this credit note could not be inserted");
131 foreach ($taxes as $taxitem) {
132 if ($taxitem['Value'] != 0) {
134 add_customer_trans_tax_detail_item(11, $credit_no, $taxitem['tax_type_id'],
135 $taxitem['rate'], $credit_note->tax_included, $taxitem['Value']);
137 add_gl_trans_customer(11, $credit_no, $credit_date, $taxitem['sales_gl_code'], 0, 0,
138 $taxitem['Value'], $credit_note->customer_id,
139 "A tax GL posting for this credit note could not be inserted");
143 add_comments(11, $credit_no, $credit_date, $credit_note->Comments);
145 if ($trans_no == 0) {
146 references::save_last($credit_note->reference, 11);
149 commit_transaction();
154 //----------------------------------------------------------------------------------------
155 // Insert a stock movement coming back in to show the credit note and
156 // a reversing stock movement to show the write off
158 function add_credit_movements_item(&$credit_note, &$credit_line,
159 $credit_type, $price, $credited_invoice=0)
162 if ($credit_type == "Return") {
164 $reference = "Return ";
165 if ($credited_invoice) {
166 $reference .= "Ex Inv: " . $credited_invoice;
169 } elseif ($credit_type == "WriteOff") {
171 $reference = "WriteOff ";
172 if ($credited_invoice)
173 $reference .= "Ex Inv: " . $credited_invoice;
175 add_stock_move_customer(11, $credit_line->stock_id,
176 key($credit_note->trans_no), $credit_note->Location,
177 $credit_note->document_date, $reference, -$credit_line->qty_dispatched,
178 $credit_line->standard_cost, 0, $price,
179 $credit_line->discount_percent);
182 add_stock_move_customer(11, $credit_line->stock_id,
183 key($credit_note->trans_no), $credit_note->Location,
184 $credit_note->document_date, $reference, $credit_line->qty_dispatched,
185 $credit_line->standard_cost, 0, $price,
186 $credit_line->discount_percent);
190 //----------------------------------------------------------------------------------------
192 function add_gl_trans_credit_costs($order, $order_line, $credit_no, $date_,
193 $credit_type, $write_off_gl_code, &$branch_data)
195 $stock_gl_codes = get_stock_gl_code($order_line->stock_id);
197 /* insert gl_trans to credit stock and debit cost of sales at standard cost*/
198 if ($order_line->standard_cost != 0) {
199 /*first the cost of sales entry*/
201 add_gl_trans_std_cost(11, $credit_no, $date_, $stock_gl_codes["cogs_account"],
202 $stock_gl_codes["dimension_id"], $stock_gl_codes["dimension2_id"], "",
203 -($order_line->standard_cost * $order_line->qty_dispatched),
204 payment_person_types::customer(), $order->customer_id,
205 "The cost of sales GL posting could not be inserted");
207 /*now the stock entry*/
208 if ($credit_type == "WriteOff") {
209 $stock_entry_account = $write_off_gl_code;
211 $stock_gl_code = get_stock_gl_code($order_line->stock_id);
212 $stock_entry_account = $stock_gl_code["inventory_account"];
215 add_gl_trans_std_cost(11, $credit_no, $date_, $stock_entry_account, 0, 0,
216 "", ($order_line->standard_cost * $order_line->qty_dispatched),
217 payment_person_types::customer(), $order->customer_id,
218 "The stock side (or write off) of the cost of sales GL posting could not be inserted");
220 } /* end of if GL and stock integrated and standard cost !=0 */
222 if ($order_line->line_price() != 0) {
224 $line_taxfree_price =
225 get_tax_free_price_for_item($order_line->stock_id, $order_line->price,
226 0, $order->tax_included, $order->tax_group_array);
228 $line_tax = get_full_price_for_item($order_line->stock_id, $order_line->price,
229 0, $order->tax_included, $order->tax_group_array) - $line_taxfree_price;
232 //Post sales transaction to GL credit sales
234 add_gl_trans_customer(11, $credit_no, $date_, $stock_gl_codes["sales_account"], 0, 0,
235 ($line_taxfree_price * $order_line->qty_dispatched), $order->customer_id,
236 "The credit note GL posting could not be inserted");
238 if ($order_line->discount_percent != 0) {
240 add_gl_trans_customer(11, $credit_no, $date_, $branch_data["sales_discount_account"], 0, 0,
241 -($line_taxfree_price * $order_line->qty_dispatched * $order_line->discount_percent),
243 "The credit note discount GL posting could not be inserted");
245 } /*end of if discount !=0 */
246 } /*if line_price!=0 */