var $price_factor; // ditto for price calculations
var $pos; // user assigned POS
- var $cash; // cash transaction - helper variable not stored in db
var $cash_account;
var $account_name;
var $cash_discount; // not used as of FA 2.1
var $payment_terms; // cached payment terms
var $credit;
+ // prepayment mode:
+ var $prepaid; // true for documents issued in prepayment mode
+ var $prep_amount; // prepayment required for SO, invoiced amount for prepaiament invoice
+ var $sum_paid; // sum of all allocated prepayments both to order and related invoices
+ var $alloc; // sum of payments allocated to this document
+ var $prepayments = array(); // allocation records for this document
//-------------------------------------------------------------------------
//
// $trans_no==0 => open new/direct document
- // $trans_no!=0 && $no_edit==false => update with parent constarints for reedition
- // $trans_no!=0 && $no_edit==true => read only: for view, or later child doc entry
+ // $trans_no!=0 && $prepare_child==false => update with parent constarints for reedition
+ // $trans_no!=0 && $prepare_child==true => prepare for child doc entry
+ // $prepare_child is set to ST_SALESINVOICE for prepayment invoices
//
- function Cart($type, $trans_no=0, $no_edit=false) {
+ function Cart($type, $trans_no=0, $prepare_child=false) {
/*Constructor function initialises a new shopping cart */
$this->line_items = array();
$this->sales_type = "";
$this->trans_type = ST_SALESORDER;
$this->dimension_id = 0;
$this->dimension2_id = 0;
- $this->read($type, $trans_no, $no_edit);
+ $this->pos = get_sales_point(user_pos());
+ $this->read($type, $trans_no, $prepare_child);
$this->cart_id = uniqid('');
}
//
// Prepare cart to new child document entry, just after initial parent doc read.
//
- function prepare_child()
+ function prepare_child($type)
{
global $Refs;
- $type = get_child_type($this->trans_type);
+ if ($type === true)
+ $type = get_child_type($this->trans_type);
$this->trans_type = $type;
$this->reference = $Refs->get_next($this->trans_type);
for($line_no = 0; $line_no < count($this->line_items); $line_no++) {
$line = &$this->line_items[$line_no];
$line->src_id = $line->id; // save src line ids for update
- $line->qty_dispatched = $type == ST_CUSTCREDIT ? '0' : $line->quantity - $line->qty_done;
+ $line->qty_dispatched = $type == ST_CUSTCREDIT ? '0' :
+ (($this->prepaid && $type == ST_SALESINVOICE) ? $line->quantity : $line->quantity - $line->qty_done);
$line->qty_old = 0;
}
unset($line);
- if ($type == ST_CUSTDELIVERY)
+ if ($type == ST_CUSTDELIVERY) {
$this->order_no = key($this->trans_no);
-
+ $cust = get_customer($this->customer_id);
+ $this->dimension_id = $cust['dimension_id'];
+ $this->dimension2_id = $cust['dimension2_id'];
+ }
if ($type == ST_SALESINVOICE) {
$this->due_date = get_invoice_duedate($this->payment, $this->document_date);
}
function set_parent_constraints($sodata, $src_no) {
$srcdetails = get_sales_parent_lines($this->trans_type, $src_no);
-
$src_type = get_parent_type($this->trans_type);
- if ($src_type == ST_SALESORDER || $src_type == 0) {
- $this->src_docs = array( $sodata['order_no']=>$sodata['version']);
- } else { // get src_data from debtor_trans
- $srcnum = array();
- while ($line = db_fetch($srcdetails)) {
- $srcnum[] = $line['debtor_trans_no'];
- }
- $this->src_docs = get_customer_trans_version($src_type, array_values($srcnum));
- }
+
// calculate & save: qtys on other docs and free qtys on src doc
- $line_no = 0;
+ $line_no = 0; $src_docs = array();
// Loop speed optimisation below depends on fact
// that child line_items contains subset of parent lines in _the_same_ order !
- while ($line_no < count($this->line_items) && $srcline = db_fetch($srcdetails)) {
+ while (($line_no < count($this->line_items)) && ($srcline = db_fetch($srcdetails))) {
$line = &$this->line_items[$line_no];
+ $src_docs[] = $src_type == ST_SALESORDER ? $srcline['order_no'] : $srcline['debtor_trans_no'];
if ($srcline['id'] == $line->src_id) {
if ($this->trans_type == ST_SALESINVOICE)
$line->src_no = $srcline['debtor_trans_no'];
$line->quantity += $srcline['quantity'] -
($src_type==ST_SALESORDER ? $srcline['qty_sent'] : $srcline['qty_done']); // add free qty on src doc
$line_no++;
- break;
}
}
+
+ if ($src_type == ST_SALESORDER || $src_type == 0) {
+ $this->src_docs = array( $sodata['order_no']=>$sodata['version']);
+ } else {
+ // get src_data from debtor_trans
+ $this->src_docs = get_customer_trans_version($src_type, array_unique($src_docs));
+ }
}
//-------------------------------------------------------------------------
// Reading document into cart
//
- function read($type, $trans_no = 0, $no_edit=false) {
+ function read($type, $trans_no=0, $prepare_child=false) {
global $SysPrefs, $Refs;
read_sales_order($trans_no[0], $this, $type);
} else { // other type of sales transaction
read_sales_trans($type, $trans_no, $this);
+ $this->prepayments = get_payments_for($trans_no[0], $type);
if ($this->order_no) { // free hand credit notes have no order_no
$sodata = get_sales_order_header($this->order_no, ST_SALESORDER);
$this->cust_ref = $sodata["customer_ref"];
// $this->customer_currency = $sodata["curr_code"];
$this->delivery_to = $sodata["deliver_to"];
$this->delivery_address = $sodata["delivery_address"];
- }
// child transaction reedition - update with parent info unless it is freehand
- if (!$no_edit)
+ if (!$this->is_prepaid() && !$prepare_child) // this is read for view/reedition
$this->set_parent_constraints($sodata, $trans_no[0]);
+ }
}
- // prepare qtys for derivative document entry (not used in display)
- if($no_edit) {
- for($line_no = 0; $line_no < count($this->line_items); $line_no++) {
- $line = &$this->line_items[$line_no];
- $line->src_id = $line->id; // save src line ids for update
- $line->qty_dispatched = $line->quantity - $line->qty_done;
- }
- }
+ // convert document into child and prepare qtys for entry
+ if ($prepare_child)
+ $this->prepare_child($prepare_child);
+
} else { // new document
$this->trans_type = $type;
$this->trans_no = 0;
$this->customer_id = get_global_customer();
else
$this->customer_id = '';
- $this->document_date = new_doc_date();
+ $this->document_date = new_doc_date();
if (!is_date_in_fiscalyear($this->document_date))
$this->document_date = end_fiscalyear();
$this->reference = $Refs->get_next($this->trans_type);
} else
$this->due_date =
add_days($this->document_date, $SysPrefs->default_delivery_required_by());
- $this->pos = user_pos();
- }
+ }
$this->credit = get_current_cust_credit($this->customer_id);
}
// Makes parent documents for direct delivery/invoice by recurent call.
// $policy - 0 or 1: writeoff/return for IV, back order/cancel for DN
function write($policy=0) {
+
begin_transaction(); // prevents partial database changes in case of direct delivery/invoice
- if (count($this->src_docs) == 0 && ($this->trans_type == ST_SALESINVOICE || $this->trans_type == ST_CUSTDELIVERY)) {
+ if ($this->reference != 'auto' && $this->trans_no == 0 && !is_new_reference($this->reference, $this->trans_type))
+ {
+ commit_transaction();
+ return -1;
+ }
+ if (count($this->src_docs) == 0 && ($this->trans_type == ST_SALESINVOICE || $this->trans_type == ST_CUSTDELIVERY) && !$this->is_prepaid()) {
// this is direct document - first add parent
- $src = (PHP_VERSION<5) ? $this : clone( $this ); // make local copy of this cart
- $src->trans_type = get_parent_type($src->trans_type);
- $src->reference = 'auto';
-
- $src->write(1);
- $type = $this->trans_type;
$ref = $this->reference;
$date = $this->document_date;
- // re-read document
- $this->read($src->trans_type, key($src->trans_no), true);
+ $due_date = $this->due_date;
+ $dimension_id = $this->dimension_id;
+ $dimension2_id = $this->dimension2_id;
+ $this->trans_type = get_parent_type($this->trans_type);
+
+ $this->reference = 'auto';
+ $trans_no = $this->write(1);
+
+ // re-read parent document converting it to child
+ $this->read($this->trans_type, $trans_no, true);
$this->document_date = $date;
$this->reference = $ref;
- $this->trans_type = $type;
- $this->src_docs= $this->trans_no;
- $this->trans_no = 0;
- $this->order_no= $this->trans_type==ST_CUSTDELIVERY ? key($src->trans_no) : $src->order_no;
+ $this->due_date = $due_date;
+ $this->dimension_id = $dimension_id;
+ $this->dimension2_id = $dimension2_id;
}
$this->reference = @html_entity_decode($this->reference, ENT_QUOTES);
$this->Comments = @html_entity_decode($this->Comments, ENT_QUOTES);
$this->customer_currency = $currency;
$this->payment = $payment;
$this->payment_terms = get_payment_terms($payment);
- $this->cash = $this->payment_terms['cash_sale'];
$this->cash_discount = $cdiscount;
- $pos = get_sales_point($this->pos);
- if (!$pos['cash_sale'] || !$pos['credit_sale'])
- $this->pos = -1; // mark not editable payment type
- if ($this->cash) {
- $this->Location = $pos['pos_location'];
- $this->location_name = $pos['location_name'];
- $this->cash_account = $pos['pos_account'];
- $this->account_name = $pos['bank_account_name'];
+ if ($this->payment_terms['cash_sale']) {
+ $this->Location = $this->pos['pos_location'];
+ $this->location_name = $this->pos['location_name'];
}
$this->credit = get_current_cust_credit($customer_id);
}
function get_shipping_tax()
{
- $tax_items = get_shipping_tax_as_array();
+ $tax_items = get_shipping_tax_as_array($this->tax_group_id);
$tax_rate = 0;
if ($tax_items != null) {
foreach ($tax_items as $item_tax) {
$index = $item_tax['tax_type_id'];
- if (isset($this->tax_group_array[$index])) {
+ if (isset($this->tax_group_array[$index]['rate'])) {
$tax_rate += $item_tax['rate'];
}
}
return $total;
}
+
+ /*
+ Returns true for documents issued in prepayment cycle.
+ */
+ function is_prepaid()
+ {
+ return $this->prepaid; //floatcmp($this->prep_amount, 0) > 0;
+ }
+ /*
+ Order is ready for delivery in prepament mode.
+ */
+ function is_released()
+ {
+ return floatcmp($this->sum_paid, $this->prep_amount) >= 0;
+ }
+
+ /*
+ Check whether order has been already invoiced/send or not.
+ */
+ function is_started()
+ {
+ if ($this->trans_no==0)
+ return false;
+ $order_no = array_keys($this->trans_no);
+
+ return is_sales_order_started(reset($order_no));
+ }
+
+ /*
+ Check payment terms and prepayments selected for this invoice,
+ and updates partial/final invoice value respectively.
+ */
+ function update_payments()
+ {
+ $remainder = prepaid_invoice_remainder($this->order_no);
+
+ // recalculate prepaid part from payments
+ if ($this->payment_terms['days_before_due'] < 0)
+ { // this is partial invoice for selected prepayments made.
+ $paid = 0;
+ foreach($this->prepayments as $payment)
+ $paid += $payment['amt'];
+ $this->prep_amount = min($remainder, $paid);
+ } else // this is final invoice
+ $this->prep_amount = $remainder;
+ }
} /* end of class defintion */
class line_details
projects / fa-stable.git / blobdiff