lambda-erp 0.1.0__py3-none-any.whl

lambda_erp/selling/quotation.py

@@ -0,0 +1,263 @@
+"""
+Quotation (Sales Offer / Proposal).
+
+A Quotation is the first step in the sales cycle:
+  Quotation -> Sales Order -> Delivery Note -> Sales Invoice
+
+It represents an offer to a customer with pricing, validity dates, and terms.
+Key behaviors:
+- Does NOT create GL entries (it's just a proposal)
+- Can be converted to a Sales Order via make_sales_order()
+- Tracks status: Draft -> Submitted/Open -> Ordered/Lost/Expired
+"""
+
+from lambda_erp.model import Document
+from lambda_erp.utils import _dict, flt, getdate, nowdate, new_name
+from lambda_erp.database import get_db
+from lambda_erp.controllers.taxes_and_totals import calculate_taxes_and_totals
+from lambda_erp.controllers.defaults import set_default_currency
+from lambda_erp.exceptions import ValidationError
+
+class Quotation(Document):
+    DOCTYPE = "Quotation"
+    CHILD_TABLES = {
+        "items": ("Quotation Item", None),
+        "taxes": ("Sales Taxes and Charges", None),
+    }
+    PREFIX = "QTN"
+
+    LINK_FIELDS = {
+        "customer": "Customer",
+        "company": "Company",
+    }
+    CHILD_LINK_FIELDS = {
+        "items": {
+            "item_code": "Item",
+            "warehouse": "Warehouse",
+        },
+        "taxes": {
+            "account_head": "Account",
+            "cost_center": "Cost Center",
+        },
+    }
+
+    def validate(self):
+        """Validate the quotation before saving.
+
+        Mirrors the reference implementation's Quotation.validate() which calls:
+        - super().validate() (SellingController -> AccountsController -> TransactionBase)
+        - validate_uom_is_integer
+        - validate_valid_till
+        - set_customer_name
+        """
+        if not self.customer:
+            raise ValidationError("Customer is required")
+        if not self.get("items"):
+            raise ValidationError("At least one item is required")
+        if not self.transaction_date:
+            self.transaction_date = nowdate()
+
+        self._validate_valid_till()
+        self._set_customer_name()
+        self._set_item_defaults()
+
+        from lambda_erp.controllers.pricing_rule import apply_pricing_rules
+        apply_pricing_rules(self)
+
+        set_default_currency(self, "Customer", "customer")
+
+        # Calculate taxes and totals (the core shared calculation)
+        calculate_taxes_and_totals(self)
+
+    def _validate_valid_till(self):
+        if self.valid_till and getdate(self.valid_till) < getdate(self.transaction_date):
+            raise ValidationError("Valid till date cannot be before transaction date")
+
+    def _set_customer_name(self):
+        if not self.customer_name and self.customer:
+            db = get_db()
+            self.customer_name = db.get_value("Customer", self.customer, "customer_name")
+
+    def _set_item_defaults(self):
+        """Fill in item names and rates from master data."""
+        db = get_db()
+        for item in self.get("items"):
+            if item.get("item_code") and not item.get("item_name"):
+                item_data = db.get_value(
+                    "Item", item["item_code"], ["item_name", "description", "stock_uom", "standard_rate"]
+                )
+                if item_data:
+                    item["item_name"] = item_data.item_name
+                    item["description"] = item.get("description") or item_data.description
+                    item["uom"] = item.get("uom") or item_data.stock_uom
+                    if not item.get("rate") and not item.get("price_list_rate"):
+                        item["rate"] = flt(item_data.standard_rate)
+
+    def on_submit(self):
+        """On submit, set status to Open."""
+        self._data["status"] = "Open"
+        self._persist()
+
+    def on_cancel(self):
+        pass
+
+    def is_expired(self):
+        """Check if quotation validity has expired."""
+        if self.valid_till:
+            return getdate(self.valid_till) < getdate(nowdate())
+        return False
+
+def make_sales_order(quotation_name):
+    """Convert a Quotation into a Sales Order.
+
+    This is the standard document flow: Quotation -> Sales Order.
+
+    the reference implementation uses get_mapped_doc() which copies fields from source to target
+    based on a mapping configuration. We do the same thing directly.
+    """
+    from lambda_erp.selling.sales_order import SalesOrder
+
+    db = get_db()
+    quotation = Quotation.load(quotation_name)
+
+    if quotation.docstatus != 1:
+        raise ValidationError("Quotation must be submitted before creating Sales Order")
+
+    if quotation.is_expired():
+        raise ValidationError("Validity period of this quotation has ended")
+
+    # Map Quotation fields to Sales Order
+    so = SalesOrder(
+        customer=quotation.customer,
+        customer_name=quotation.customer_name,
+        company=quotation.company,
+        currency=quotation.currency,
+        conversion_rate=quotation.conversion_rate,
+        transaction_date=nowdate(),
+    )
+
+    # Map items
+    for item in quotation.get("items"):
+        so.append("items", _dict(
+            item_code=item.get("item_code"),
+            item_name=item.get("item_name"),
+            description=item.get("description"),
+            qty=item.get("qty"),
+            uom=item.get("uom"),
+            rate=item.get("rate"),
+            price_list_rate=item.get("price_list_rate"),
+            discount_percentage=item.get("discount_percentage"),
+            warehouse=item.get("warehouse"),
+            quotation_item=item.get("name"),
+        ))
+
+    # Map taxes
+    for tax in quotation.get("taxes") or []:
+        so.append("taxes", _dict(
+            charge_type=tax.get("charge_type"),
+            account_head=tax.get("account_head"),
+            description=tax.get("description"),
+            rate=tax.get("rate"),
+            tax_amount=0,  # will be recalculated
+            included_in_print_rate=tax.get("included_in_print_rate"),
+        ))
+
+    # Update quotation status
+    db.set_value("Quotation", quotation_name, "status", "Ordered")
+
+    return so
+
+def make_sales_invoice_from_quotation(quotation_name):
+    """Convert a Quotation directly into a Sales Invoice (skip Sales Order)."""
+    from lambda_erp.accounting.sales_invoice import SalesInvoice
+
+    db = get_db()
+    quotation = Quotation.load(quotation_name)
+
+    if quotation.docstatus != 1:
+        raise ValidationError("Quotation must be submitted before creating Sales Invoice")
+
+    if quotation.is_expired():
+        raise ValidationError("Validity period of this quotation has ended")
+
+    sinv = SalesInvoice(
+        customer=quotation.customer,
+        customer_name=quotation.customer_name,
+        company=quotation.company,
+        currency=quotation.currency,
+        conversion_rate=quotation.conversion_rate,
+        posting_date=nowdate(),
+    )
+
+    for item in quotation.get("items"):
+        sinv.append("items", _dict(
+            item_code=item.get("item_code"),
+            item_name=item.get("item_name"),
+            description=item.get("description"),
+            qty=item.get("qty"),
+            uom=item.get("uom"),
+            rate=item.get("rate"),
+            price_list_rate=item.get("price_list_rate"),
+            discount_percentage=item.get("discount_percentage"),
+            warehouse=item.get("warehouse"),
+        ))
+
+    for tax in quotation.get("taxes") or []:
+        sinv.append("taxes", _dict(
+            charge_type=tax.get("charge_type"),
+            account_head=tax.get("account_head"),
+            description=tax.get("description"),
+            rate=tax.get("rate"),
+            tax_amount=0,
+            included_in_print_rate=tax.get("included_in_print_rate"),
+        ))
+
+    db.set_value("Quotation", quotation_name, "status", "Ordered")
+
+    return sinv
+
+def make_delivery_note_from_quotation(quotation_name):
+    """Convert a Quotation directly into a Delivery Note (skip Sales Order)."""
+    from lambda_erp.stock.delivery_note import DeliveryNote
+
+    db = get_db()
+    quotation = Quotation.load(quotation_name)
+
+    if quotation.docstatus != 1:
+        raise ValidationError("Quotation must be submitted before creating Delivery Note")
+
+    if quotation.is_expired():
+        raise ValidationError("Validity period of this quotation has ended")
+
+    dn = DeliveryNote(
+        customer=quotation.customer,
+        customer_name=quotation.customer_name,
+        company=quotation.company,
+        currency=quotation.currency,
+        conversion_rate=quotation.conversion_rate,
+        posting_date=nowdate(),
+    )
+
+    for item in quotation.get("items"):
+        dn.append("items", _dict(
+            item_code=item.get("item_code"),
+            item_name=item.get("item_name"),
+            description=item.get("description"),
+            qty=item.get("qty"),
+            uom=item.get("uom"),
+            rate=item.get("rate"),
+            warehouse=item.get("warehouse"),
+        ))
+
+    for tax in quotation.get("taxes") or []:
+        dn.append("taxes", _dict(
+            charge_type=tax.get("charge_type"),
+            account_head=tax.get("account_head"),
+            description=tax.get("description"),
+            rate=tax.get("rate"),
+            tax_amount=0,
+        ))
+
+    db.set_value("Quotation", quotation_name, "status", "Ordered")
+
+    return dn

lambda_erp/selling/sales_order.py

@@ -0,0 +1,214 @@
+"""
+Sales Order.
+
+Sales Order sits between Quotation and Invoice in the sales cycle:
+  Quotation -> Sales Order -> Delivery Note -> Sales Invoice
+
+Key behaviors:
+- Does NOT create GL entries (no financial impact yet)
+- Reserves stock (updates ordered_qty in Bin)
+- Tracks delivery and billing status (per_delivered, per_billed)
+- Can be converted to Sales Invoice via make_sales_invoice()
+"""
+
+from lambda_erp.model import Document
+from lambda_erp.utils import _dict, flt, getdate, nowdate
+from lambda_erp.database import get_db
+from lambda_erp.controllers.taxes_and_totals import calculate_taxes_and_totals
+from lambda_erp.controllers.defaults import set_default_currency
+from lambda_erp.exceptions import ValidationError
+
+class SalesOrder(Document):
+    DOCTYPE = "Sales Order"
+    CHILD_TABLES = {
+        "items": ("Sales Order Item", None),
+        "taxes": ("Sales Taxes and Charges", None),
+    }
+    PREFIX = "SO"
+
+    LINK_FIELDS = {
+        "customer": "Customer",
+        "company": "Company",
+    }
+    CHILD_LINK_FIELDS = {
+        "items": {
+            "item_code": "Item",
+            "warehouse": "Warehouse",
+        },
+        "taxes": {
+            "account_head": "Account",
+            "cost_center": "Cost Center",
+        },
+    }
+
+    def validate(self):
+        """Validate sales order.
+
+        Mirrors the reference implementation's SalesOrder.validate() which calls the full controller
+        chain: SellingController -> StockController -> AccountsController.
+        """
+        if not self.customer:
+            raise ValidationError("Customer is required")
+        if not self.get("items"):
+            raise ValidationError("At least one item is required")
+        if not self.transaction_date:
+            self.transaction_date = nowdate()
+
+        self._set_customer_name()
+        self._set_item_defaults()
+        self._validate_delivery_date()
+
+        from lambda_erp.controllers.pricing_rule import apply_pricing_rules
+        apply_pricing_rules(self)
+
+        set_default_currency(self, "Customer", "customer")
+
+        # Calculate taxes and totals
+        calculate_taxes_and_totals(self)
+
+        self._set_status()
+
+    def _set_customer_name(self):
+        if not self.customer_name and self.customer:
+            db = get_db()
+            self.customer_name = db.get_value("Customer", self.customer, "customer_name")
+
+    def _set_item_defaults(self):
+        """Fill in item names and rates from master data."""
+        db = get_db()
+        for item in self.get("items"):
+            if item.get("item_code") and not item.get("item_name"):
+                item_data = db.get_value(
+                    "Item", item["item_code"],
+                    ["item_name", "description", "stock_uom", "standard_rate"]
+                )
+                if item_data:
+                    item["item_name"] = item_data.item_name
+                    item["description"] = item.get("description") or item_data.description
+                    item["uom"] = item.get("uom") or item_data.stock_uom
+                    if not item.get("rate") and not item.get("price_list_rate"):
+                        item["rate"] = flt(item_data.standard_rate)
+
+    def _validate_delivery_date(self):
+        if self.delivery_date and getdate(self.delivery_date) < getdate(self.transaction_date):
+            raise ValidationError("Expected delivery date cannot be before order date")
+
+    def _set_status(self):
+        """Set status based on delivery and billing."""
+        if self.docstatus == 0:
+            self._data["status"] = "Draft"
+        elif self.docstatus == 2:
+            self._data["status"] = "Cancelled"
+        elif self.docstatus == 1:
+            per_delivered = flt(self.per_delivered)
+            per_billed = flt(self.per_billed)
+
+            if per_delivered >= 100 and per_billed >= 100:
+                self._data["status"] = "Completed"
+            elif per_delivered > 0 and per_delivered < 100:
+                self._data["status"] = "To Deliver"
+            elif per_billed > 0 and per_billed < 100:
+                self._data["status"] = "To Bill"
+            else:
+                self._data["status"] = "To Deliver and Bill"
+
+    def on_submit(self):
+        """On submit, update stock reservations (ordered_qty in Bin).
+
+        In the reference implementation, submitting a Sales Order updates the Bin.ordered_qty
+        so that MRP/stock planning can account for upcoming demand.
+        """
+        self._update_reserved_qty(1)
+
+    def on_cancel(self):
+        """Reverse stock reservations."""
+        self._update_reserved_qty(-1)
+
+    def _update_reserved_qty(self, direction=1):
+        """Update Bin.reserved_qty for each item+warehouse."""
+        db = get_db()
+        for item in self.get("items"):
+            if item.get("warehouse") and item.get("item_code"):
+                qty = flt(item.get("qty", 0)) * direction
+                bin_data = db.get_value(
+                    "Bin",
+                    {"item_code": item["item_code"], "warehouse": item["warehouse"]},
+                    ["name", "reserved_qty"],
+                )
+                if bin_data:
+                    new_reserved = flt(bin_data.reserved_qty) + qty
+                    db.set_value("Bin", bin_data.name, "reserved_qty", max(0, new_reserved))
+        db.commit()
+
+    def update_delivery_status(self):
+        """Update per_delivered based on delivered quantities."""
+        total_qty = sum(flt(item.get("qty")) for item in self.get("items"))
+        delivered_qty = sum(flt(item.get("delivered_qty")) for item in self.get("items"))
+        if total_qty:
+            self._data["per_delivered"] = flt(delivered_qty / total_qty * 100, 2)
+        self._set_status()
+        self._persist()
+
+    def update_billing_status(self):
+        """Update per_billed based on billed quantities."""
+        total_qty = sum(flt(item.get("qty")) for item in self.get("items"))
+        billed_qty = sum(flt(item.get("billed_qty")) for item in self.get("items"))
+        if total_qty:
+            self._data["per_billed"] = flt(billed_qty / total_qty * 100, 2)
+        self._set_status()
+        self._persist()
+
+def make_sales_invoice(sales_order_name):
+    """Convert a Sales Order into a Sales Invoice.
+
+    This is the standard flow: Sales Order -> Sales Invoice.
+    """
+    from lambda_erp.accounting.sales_invoice import SalesInvoice
+
+    db = get_db()
+    so = SalesOrder.load(sales_order_name)
+
+    if so.docstatus != 1:
+        raise ValidationError("Sales Order must be submitted before creating Sales Invoice")
+
+    si = SalesInvoice(
+        customer=so.customer,
+        customer_name=so.customer_name,
+        company=so.company,
+        currency=so.currency,
+        conversion_rate=so.conversion_rate,
+        posting_date=nowdate(),
+        sales_order=so.name,
+    )
+
+    for item in so.get("items"):
+        unbilled_qty = flt(item.get("qty")) - flt(item.get("billed_qty"))
+        if unbilled_qty <= 0:
+            continue
+
+        si.append("items", _dict(
+            item_code=item.get("item_code"),
+            item_name=item.get("item_name"),
+            description=item.get("description"),
+            qty=unbilled_qty,
+            uom=item.get("uom"),
+            rate=item.get("rate"),
+            price_list_rate=item.get("price_list_rate"),
+            discount_percentage=item.get("discount_percentage"),
+            warehouse=item.get("warehouse"),
+            cost_center=item.get("cost_center"),
+            sales_order=so.name,
+            sales_order_item=item.get("name"),
+        ))
+
+    for tax in so.get("taxes") or []:
+        si.append("taxes", _dict(
+            charge_type=tax.get("charge_type"),
+            account_head=tax.get("account_head"),
+            description=tax.get("description"),
+            rate=tax.get("rate"),
+            tax_amount=0,
+            included_in_print_rate=tax.get("included_in_print_rate"),
+        ))
+
+    return si