sales/includes/db/payment_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   Write/update customer payment.
  14 */
  15 function write_customer_payment($trans_no, $customer_id, $branch_id, $bank_account,
  16         $date_, $ref, $amount, $discount, $memo_, $rate=0, $charge=0)
  17 {
  18         global $Refs;
  19
  20         begin_transaction();
  21         $args = func_get_args(); while (count($args) < 11) $args[] = 0;
  22         $args = (object)array_combine(array('trans_no', 'customer_id', 'branch_id', 'bank_account',
  23                 'date_', 'ref', 'amount', 'discount', 'memo_','rate','charge'), $args);
  24         hook_db_prewrite($args, ST_CUSTPAYMENT);
  25
  26         $company_record = get_company_prefs();
  27
  28         $payment_no = write_customer_trans(ST_CUSTPAYMENT, $trans_no, $customer_id, $branch_id,
  29                 $date_, $ref, $amount, $discount, 0, 0, 0, 0, 0, 0, "", 0, $rate);
  30
  31         $bank_gl_account = get_bank_gl_account($bank_account);
  32
  33         if ($trans_no != 0) {
  34           delete_comments(ST_CUSTPAYMENT, $trans_no);
  35           void_bank_trans(ST_CUSTPAYMENT, $trans_no, true);
  36           void_gl_trans(ST_CUSTPAYMENT, $trans_no, true);
  37           void_cust_allocations(ST_CUSTPAYMENT, $trans_no, $date_);
  38         }
  39         $total = 0;
  40         /* Bank account entry first */
  41         $total += add_gl_trans_customer(ST_CUSTPAYMENT, $payment_no, $date_,
  42                 $bank_gl_account, 0, 0, $amount - $charge,  $customer_id,
  43                 "Cannot insert a GL transaction for the bank account debit", $rate);
  44
  45         if ($branch_id != ANY_NUMERIC) {
  46
  47                 $branch_data = get_branch_accounts($branch_id);
  48
  49                 $debtors_account = $branch_data["receivables_account"];
  50                 $discount_account = $branch_data["payment_discount_account"];
  51
  52         } else {
  53                 $debtors_account = $company_record["debtors_act"];
  54                 $discount_account = $company_record["default_prompt_payment_act"];
  55         }
  56
  57         if (($discount + $amount) != 0) {
  58         /* Now Credit Debtors account with receipts + discounts */
  59         $total += add_gl_trans_customer(ST_CUSTPAYMENT, $payment_no, $date_,
  60                 $debtors_account, 0, 0, -($discount + $amount), $customer_id,
  61                 "Cannot insert a GL transaction for the debtors account credit", $rate);
  62         }
  63         if ($discount != 0)     {
  64                 /* Now Debit discount account with discounts allowed*/
  65                 $total += add_gl_trans_customer(ST_CUSTPAYMENT, $payment_no, $date_,
  66                         $discount_account, 0, 0, $discount, $customer_id,
  67                         "Cannot insert a GL transaction for the payment discount debit", $rate);
  68         }
  69
  70         if ($charge != 0)       {
  71                 /* Now Debit bank charge account with charges */
  72                 $charge_act = get_company_pref('bank_charge_act');
  73                 $total += add_gl_trans_customer(ST_CUSTPAYMENT, $payment_no, $date_,
  74                         $charge_act, 0, 0, $charge, $customer_id,
  75                         "Cannot insert a GL transaction for the payment bank charge debit", $rate);
  76         }
  77         /*Post a balance post if $total != 0 */
  78         add_gl_balance(ST_CUSTPAYMENT, $payment_no, $date_, -$total, PT_CUSTOMER, $customer_id);
  79
  80         /*now enter the bank_trans entry */
  81         add_bank_trans(ST_CUSTPAYMENT, $payment_no, $bank_account, $ref,
  82                 $date_, $amount - $charge, PT_CUSTOMER, $customer_id,
  83                 get_customer_currency($customer_id), "", $rate);
  84
  85         add_comments(ST_CUSTPAYMENT, $payment_no, $date_, $memo_);
  86
  87         $Refs->save(ST_CUSTPAYMENT, $payment_no, $ref);
  88
  89         $args->trans_no = $payment_no;
  90         hook_db_postwrite($args, ST_CUSTPAYMENT);
  91         commit_transaction();
  92
  93         return $payment_no;
  94 }
  95
  96 //-------------------------------------------------------------------------------------------------
  97
  98 function void_customer_payment($type, $type_no)
  99 {
 100         begin_transaction();
 101
 102         hook_db_prevoid($type, $type_no);
 103         void_bank_trans($type, $type_no, true);
 104         void_gl_trans($type, $type_no, true);
 105         void_cust_allocations($type, $type_no);
 106         void_customer_trans($type, $type_no);
 107
 108         commit_transaction();
 109 }
 110
 111
 112 ?>