# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: GNU General Public License v3. See license.txt import json import frappe from frappe import _, throw from frappe.model import child_table_fields, default_fields from frappe.model.meta import get_field_precision from frappe.query_builder.functions import CombineDatetime, IfNull, Sum from frappe.utils import add_days, add_months, cint, cstr, flt, getdate from erpnext import get_company_currency from erpnext.accounts.doctype.pricing_rule.pricing_rule import ( get_pricing_rule_for_item, set_transaction_type, ) from erpnext.setup.doctype.brand.brand import get_brand_defaults from erpnext.setup.doctype.item_group.item_group import get_item_group_defaults from erpnext.setup.utils import get_exchange_rate from erpnext.stock.doctype.item.item import get_item_defaults, get_uom_conv_factor from erpnext.stock.doctype.item_manufacturer.item_manufacturer import get_item_manufacturer_part_no from erpnext.stock.doctype.price_list.price_list import get_price_list_details sales_doctypes = ["Quotation", "Sales Order", "Delivery Note", "Sales Invoice", "POS Invoice"] purchase_doctypes = [ "Material Request", "Supplier Quotation", "Purchase Order", "Purchase Receipt", "Purchase Invoice", ] @frappe.whitelist() def get_item_details(args, doc=None, for_validate=False, overwrite_warehouse=True): """ args = { "item_code": "", "warehouse": None, "customer": "", "conversion_rate": 1.0, "selling_price_list": None, "price_list_currency": None, "plc_conversion_rate": 1.0, "doctype": "", "name": "", "supplier": None, "transaction_date": None, "conversion_rate": 1.0, "buying_price_list": None, "is_subcontracted": 0/1, "ignore_pricing_rule": 0/1 "project": "" "set_warehouse": "" } """ args = process_args(args) for_validate = process_string_args(for_validate) overwrite_warehouse = process_string_args(overwrite_warehouse) item = frappe.get_cached_doc("Item", args.item_code) validate_item_details(args, item) if isinstance(doc, str): doc = json.loads(doc) if doc: args["transaction_date"] = doc.get("transaction_date") or doc.get("posting_date") if doc.get("doctype") == "Purchase Invoice": args["bill_date"] = doc.get("bill_date") out = get_basic_details(args, item, overwrite_warehouse) get_item_tax_template(args, item, out) out["item_tax_rate"] = get_item_tax_map( args.company, args.get("item_tax_template") if out.get("item_tax_template") is None else out.get("item_tax_template"), as_json=True, ) get_party_item_code(args, item, out) set_valuation_rate(out, args) update_party_blanket_order(args, out) # Never try to find a customer price if customer is set in these Doctype current_customer = args.customer if args.get("doctype") in ["Purchase Order", "Purchase Receipt", "Purchase Invoice"]: args.customer = None out.update(get_price_list_rate(args, item)) args.customer = current_customer if args.customer and cint(args.is_pos): out.update(get_pos_profile_item_details(args.company, args, update_data=True)) if ( args.get("doctype") == "Material Request" and args.get("material_request_type") == "Material Transfer" ): out.update(get_bin_details(args.item_code, args.get("from_warehouse"))) elif out.get("warehouse"): if doc and doc.get("doctype") == "Purchase Order": # calculate company_total_stock only for po bin_details = get_bin_details( args.item_code, out.warehouse, args.company, include_child_warehouses=True ) else: bin_details = get_bin_details(args.item_code, out.warehouse, include_child_warehouses=True) out.update(bin_details) # update args with out, if key or value not exists for key, value in out.items(): if args.get(key) is None: args[key] = value data = get_pricing_rule_for_item(args, doc=doc, for_validate=for_validate) out.update(data) update_stock(args, out) if args.transaction_date and item.lead_time_days: out.schedule_date = out.lead_time_date = add_days(args.transaction_date, item.lead_time_days) if args.get("is_subcontracted"): out.bom = args.get("bom") or get_default_bom(args.item_code) get_gross_profit(out) if args.doctype == "Material Request": out.rate = args.rate or out.price_list_rate out.amount = flt(args.qty) * flt(out.rate) out = remove_standard_fields(out) return out def remove_standard_fields(details): for key in child_table_fields + default_fields: details.pop(key, None) return details def update_stock(args, out): if ( ( args.get("doctype") == "Delivery Note" or (args.get("doctype") == "Sales Invoice" and args.get("update_stock")) ) and out.warehouse and out.stock_qty > 0 ): if out.has_serial_no and args.get("batch_no"): reserved_so = get_so_reservation_for_item(args) out.batch_no = args.get("batch_no") out.serial_no = get_serial_no(out, args.serial_no, sales_order=reserved_so) elif out.has_serial_no: reserved_so = get_so_reservation_for_item(args) out.serial_no = get_serial_no(out, args.serial_no, sales_order=reserved_so) if not out.serial_no: out.pop("serial_no", None) def set_valuation_rate(out, args): if frappe.db.exists("Product Bundle", args.item_code, cache=True): valuation_rate = 0.0 bundled_items = frappe.get_doc("Product Bundle", args.item_code) for bundle_item in bundled_items.items: valuation_rate += flt( get_valuation_rate(bundle_item.item_code, args.company, out.get("warehouse")).get( "valuation_rate" ) * bundle_item.qty ) out.update({"valuation_rate": valuation_rate}) else: out.update(get_valuation_rate(args.item_code, args.company, out.get("warehouse"))) def process_args(args): if isinstance(args, str): args = json.loads(args) args = frappe._dict(args) if not args.get("price_list"): args.price_list = args.get("selling_price_list") or args.get("buying_price_list") if not args.item_code and args.barcode: args.item_code = get_item_code(barcode=args.barcode) elif not args.item_code and args.serial_no: args.item_code = get_item_code(serial_no=args.serial_no) set_transaction_type(args) return args def process_string_args(args): if isinstance(args, str): args = json.loads(args) return args @frappe.whitelist() def get_item_code(barcode=None, serial_no=None): if barcode: item_code = frappe.db.get_value("Item Barcode", {"barcode": barcode}, fieldname=["parent"]) if not item_code: frappe.throw(_("No Item with Barcode {0}").format(barcode)) elif serial_no: item_code = frappe.db.get_value("Serial No", serial_no, "item_code") if not item_code: frappe.throw(_("No Item with Serial No {0}").format(serial_no)) return item_code def validate_item_details(args, item): if not args.company: throw(_("Please specify Company")) from erpnext.stock.doctype.item.item import validate_end_of_life validate_end_of_life(item.name, item.end_of_life, item.disabled) if cint(item.has_variants): msg = f"Item {item.name} is a template, please select one of its variants" throw(_(msg), title=_("Template Item Selected")) elif args.transaction_type == "buying" and args.doctype != "Material Request": if args.get("is_subcontracted"): if args.get("is_old_subcontracting_flow"): if item.is_sub_contracted_item != 1: throw(_("Item {0} must be a Sub-contracted Item").format(item.name)) else: if item.is_stock_item: throw(_("Item {0} must be a Non-Stock Item").format(item.name)) def get_basic_details(args, item, overwrite_warehouse=True): """ :param args: { "item_code": "", "warehouse": None, "customer": "", "conversion_rate": 1.0, "selling_price_list": None, "price_list_currency": None, "price_list_uom_dependant": None, "plc_conversion_rate": 1.0, "doctype": "", "name": "", "supplier": None, "transaction_date": None, "conversion_rate": 1.0, "buying_price_list": None, "is_subcontracted": 0/1, "ignore_pricing_rule": 0/1 "project": "", barcode: "", serial_no: "", currency: "", update_stock: "", price_list: "", company: "", order_type: "", is_pos: "", project: "", qty: "", stock_qty: "", conversion_factor: "", against_blanket_order: 0/1 } :param item: `item_code` of Item object :return: frappe._dict """ if not item: item = frappe.get_doc("Item", args.get("item_code")) if item.variant_of: item.update_template_tables() item_defaults = get_item_defaults(item.name, args.company) item_group_defaults = get_item_group_defaults(item.name, args.company) brand_defaults = get_brand_defaults(item.name, args.company) defaults = frappe._dict( { "item_defaults": item_defaults, "item_group_defaults": item_group_defaults, "brand_defaults": brand_defaults, } ) warehouse = get_item_warehouse(item, args, overwrite_warehouse, defaults) if args.get("doctype") == "Material Request" and not args.get("material_request_type"): args["material_request_type"] = frappe.db.get_value( "Material Request", args.get("name"), "material_request_type", cache=True ) expense_account = None if args.get("doctype") == "Purchase Invoice" and item.is_fixed_asset: from erpnext.assets.doctype.asset_category.asset_category import get_asset_category_account expense_account = get_asset_category_account( fieldname="fixed_asset_account", item=args.item_code, company=args.company ) # Set the UOM to the Default Sales UOM or Default Purchase UOM if configured in the Item Master if not args.get("uom"): if args.get("doctype") in sales_doctypes: args.uom = item.sales_uom if item.sales_uom else item.stock_uom elif (args.get("doctype") in ["Purchase Order", "Purchase Receipt", "Purchase Invoice"]) or ( args.get("doctype") == "Material Request" and args.get("material_request_type") == "Purchase" ): args.uom = item.purchase_uom if item.purchase_uom else item.stock_uom else: args.uom = item.stock_uom # Set stock UOM in args, so that it can be used while fetching item price args.stock_uom = item.stock_uom if args.get("batch_no") and item.name != frappe.get_cached_value( "Batch", args.get("batch_no"), "item" ): args["batch_no"] = "" out = frappe._dict( { "item_code": item.name, "item_name": item.item_name, "description": cstr(item.description).strip(), "image": cstr(item.image).strip(), "warehouse": warehouse, "income_account": get_default_income_account( args, item_defaults, item_group_defaults, brand_defaults ), "expense_account": expense_account or get_default_expense_account(args, item_defaults, item_group_defaults, brand_defaults), "discount_account": get_default_discount_account(args, item_defaults), "provisional_expense_account": get_provisional_account(args, item_defaults), "cost_center": get_default_cost_center( args, item_defaults, item_group_defaults, brand_defaults ), "has_serial_no": item.has_serial_no, "has_batch_no": item.has_batch_no, "batch_no": args.get("batch_no"), "uom": args.uom, "stock_uom": item.stock_uom, "min_order_qty": flt(item.min_order_qty) if args.doctype == "Material Request" else "", "qty": flt(args.qty) or 1.0, "stock_qty": flt(args.qty) or 1.0, "price_list_rate": 0.0, "base_price_list_rate": 0.0, "rate": 0.0, "base_rate": 0.0, "amount": 0.0, "base_amount": 0.0, "net_rate": 0.0, "net_amount": 0.0, "discount_percentage": 0.0, "discount_amount": flt(args.discount_amount) or 0.0, "supplier": get_default_supplier(args, item_defaults, item_group_defaults, brand_defaults), "update_stock": args.get("update_stock") if args.get("doctype") in ["Sales Invoice", "Purchase Invoice"] else 0, "delivered_by_supplier": item.delivered_by_supplier if args.get("doctype") in ["Sales Order", "Sales Invoice"] else 0, "is_fixed_asset": item.is_fixed_asset, "last_purchase_rate": item.last_purchase_rate if args.get("doctype") in ["Purchase Order"] else 0, "transaction_date": args.get("transaction_date"), "against_blanket_order": args.get("against_blanket_order"), "bom_no": item.get("default_bom"), "weight_per_unit": args.get("weight_per_unit") or item.get("weight_per_unit"), "weight_uom": args.get("weight_uom") or item.get("weight_uom"), "grant_commission": item.get("grant_commission"), } ) if item.get("enable_deferred_revenue") or item.get("enable_deferred_expense"): out.update(calculate_service_end_date(args, item)) # calculate conversion factor if item.stock_uom == args.uom: out.conversion_factor = 1.0 else: out.conversion_factor = args.conversion_factor or get_conversion_factor(item.name, args.uom).get( "conversion_factor" ) args.conversion_factor = out.conversion_factor out.stock_qty = out.qty * out.conversion_factor args.stock_qty = out.stock_qty # calculate last purchase rate if args.get("doctype") in purchase_doctypes and not frappe.db.get_single_value( "Buying Settings", "disable_last_purchase_rate" ): from erpnext.buying.doctype.purchase_order.purchase_order import item_last_purchase_rate out.last_purchase_rate = item_last_purchase_rate( args.name, args.conversion_rate, item.name, out.conversion_factor ) # if default specified in item is for another company, fetch from company for d in [ ["Account", "income_account", "default_income_account"], ["Account", "expense_account", "default_expense_account"], ["Cost Center", "cost_center", "cost_center"], ["Warehouse", "warehouse", ""], ]: if not out[d[1]]: out[d[1]] = frappe.get_cached_value("Company", args.company, d[2]) if d[2] else None for fieldname in ("item_name", "item_group", "brand", "stock_uom"): out[fieldname] = item.get(fieldname) if args.get("manufacturer"): part_no = get_item_manufacturer_part_no(args.get("item_code"), args.get("manufacturer")) if part_no: out["manufacturer_part_no"] = part_no else: out["manufacturer_part_no"] = None out["manufacturer"] = None else: data = frappe.get_value( "Item", item.name, ["default_item_manufacturer", "default_manufacturer_part_no"], as_dict=1 ) if data: out.update( { "manufacturer": data.default_item_manufacturer, "manufacturer_part_no": data.default_manufacturer_part_no, } ) child_doctype = args.doctype + " Item" meta = frappe.get_meta(child_doctype) if meta.get_field("barcode"): update_barcode_value(out) if out.get("weight_per_unit"): out["total_weight"] = out.weight_per_unit * out.stock_qty return out def get_item_warehouse(item, args, overwrite_warehouse, defaults=None): if not defaults: defaults = frappe._dict( { "item_defaults": get_item_defaults(item.name, args.company), "item_group_defaults": get_item_group_defaults(item.name, args.company), "brand_defaults": get_brand_defaults(item.name, args.company), } ) if overwrite_warehouse or not args.warehouse: warehouse = ( args.get("set_warehouse") or defaults.item_defaults.get("default_warehouse") or defaults.item_group_defaults.get("default_warehouse") or defaults.brand_defaults.get("default_warehouse") or args.get("warehouse") ) if not warehouse: defaults = frappe.defaults.get_defaults() or {} warehouse_exists = frappe.db.exists( "Warehouse", {"name": defaults.default_warehouse, "company": args.company} ) if defaults.get("default_warehouse") and warehouse_exists: warehouse = defaults.default_warehouse else: warehouse = args.get("warehouse") if not warehouse: default_warehouse = frappe.db.get_single_value("Stock Settings", "default_warehouse") if frappe.db.get_value("Warehouse", default_warehouse, "company") == args.company: return default_warehouse return warehouse def update_barcode_value(out): barcode_data = get_barcode_data([out]) # If item has one barcode then update the value of the barcode field if barcode_data and len(barcode_data.get(out.item_code)) == 1: out["barcode"] = barcode_data.get(out.item_code)[0] def get_barcode_data(items_list): # get itemwise batch no data # exmaple: {'LED-GRE': [Batch001, Batch002]} # where LED-GRE is item code, SN0001 is serial no and Pune is warehouse itemwise_barcode = {} for item in items_list: barcodes = frappe.db.get_all( "Item Barcode", filters={"parent": item.item_code}, fields="barcode" ) for barcode in barcodes: if item.item_code not in itemwise_barcode: itemwise_barcode.setdefault(item.item_code, []) itemwise_barcode[item.item_code].append(barcode.get("barcode")) return itemwise_barcode @frappe.whitelist() def get_item_tax_info(company, tax_category, item_codes, item_rates=None, item_tax_templates=None): out = {} if item_tax_templates is None: item_tax_templates = {} if item_rates is None: item_rates = {} if isinstance(item_codes, (str,)): item_codes = json.loads(item_codes) if isinstance(item_rates, (str,)): item_rates = json.loads(item_rates) if isinstance(item_tax_templates, (str,)): item_tax_templates = json.loads(item_tax_templates) for item_code in item_codes: if not item_code or item_code[1] in out or not item_tax_templates.get(item_code[1]): continue out[item_code[1]] = {} item = frappe.get_cached_doc("Item", item_code[0]) args = { "company": company, "tax_category": tax_category, "net_rate": item_rates.get(item_code[1]), } if item_tax_templates: args.update({"item_tax_template": item_tax_templates.get(item_code[1])}) get_item_tax_template(args, item, out[item_code[1]]) out[item_code[1]]["item_tax_rate"] = get_item_tax_map( company, out[item_code[1]].get("item_tax_template"), as_json=True ) return out def get_item_tax_template(args, item, out): """ args = { "tax_category": None "item_tax_template": None } """ item_tax_template = None if item.taxes: item_tax_template = _get_item_tax_template(args, item.taxes, out) if not item_tax_template: item_group = item.item_group while item_group and not item_tax_template: item_group_doc = frappe.get_cached_doc("Item Group", item_group) item_tax_template = _get_item_tax_template(args, item_group_doc.taxes, out) item_group = item_group_doc.parent_item_group def _get_item_tax_template(args, taxes, out=None, for_validate=False): if out is None: out = {} taxes_with_validity = [] taxes_with_no_validity = [] for tax in taxes: tax_company = frappe.get_cached_value("Item Tax Template", tax.item_tax_template, "company") if tax_company == args["company"]: if tax.valid_from or tax.maximum_net_rate: # In purchase Invoice first preference will be given to supplier invoice date # if supplier date is not present then posting date validation_date = args.get("bill_date") or args.get("transaction_date") if getdate(tax.valid_from) <= getdate(validation_date) and is_within_valid_range(args, tax): taxes_with_validity.append(tax) else: taxes_with_no_validity.append(tax) if taxes_with_validity: taxes = sorted( taxes_with_validity, key=lambda i: i.valid_from or tax.maximum_net_rate, reverse=True ) else: taxes = taxes_with_no_validity if for_validate: return [ tax.item_tax_template for tax in taxes if ( cstr(tax.tax_category) == cstr(args.get("tax_category")) and (tax.item_tax_template not in taxes) ) ] # all templates have validity and no template is valid if not taxes_with_validity and (not taxes_with_no_validity): return None # do not change if already a valid template if args.get("item_tax_template") in {t.item_tax_template for t in taxes}: out["item_tax_template"] = args.get("item_tax_template") return args.get("item_tax_template") for tax in taxes: if cstr(tax.tax_category) == cstr(args.get("tax_category")): out["item_tax_template"] = tax.item_tax_template return tax.item_tax_template return None def is_within_valid_range(args, tax): if not flt(tax.maximum_net_rate): # No range specified, just ignore return True elif flt(tax.minimum_net_rate) <= flt(args.get("net_rate")) <= flt(tax.maximum_net_rate): return True return False @frappe.whitelist() def get_item_tax_map(company, item_tax_template, as_json=True): item_tax_map = {} if item_tax_template: template = frappe.get_cached_doc("Item Tax Template", item_tax_template) for d in template.taxes: if frappe.get_cached_value("Account", d.tax_type, "company") == company: item_tax_map[d.tax_type] = d.tax_rate return json.dumps(item_tax_map) if as_json else item_tax_map @frappe.whitelist() def calculate_service_end_date(args, item=None): args = process_args(args) if not item: item = frappe.get_cached_doc("Item", args.item_code) doctype = args.get("parenttype") or args.get("doctype") if doctype == "Sales Invoice": enable_deferred = "enable_deferred_revenue" no_of_months = "no_of_months" account = "deferred_revenue_account" else: enable_deferred = "enable_deferred_expense" no_of_months = "no_of_months_exp" account = "deferred_expense_account" service_start_date = args.service_start_date if args.service_start_date else args.transaction_date service_end_date = add_months(service_start_date, item.get(no_of_months)) deferred_detail = {"service_start_date": service_start_date, "service_end_date": service_end_date} deferred_detail[enable_deferred] = item.get(enable_deferred) deferred_detail[account] = get_default_deferred_account(args, item, fieldname=account) return deferred_detail def get_default_income_account(args, item, item_group, brand): return ( item.get("income_account") or item_group.get("income_account") or brand.get("income_account") or args.income_account ) def get_default_expense_account(args, item, item_group, brand): return ( item.get("expense_account") or item_group.get("expense_account") or brand.get("expense_account") or args.expense_account ) def get_provisional_account(args, item): return item.get("default_provisional_account") or args.default_provisional_account def get_default_discount_account(args, item): return item.get("default_discount_account") or args.discount_account def get_default_deferred_account(args, item, fieldname=None): if item.get("enable_deferred_revenue") or item.get("enable_deferred_expense"): return ( item.get(fieldname) or args.get(fieldname) or frappe.get_cached_value("Company", args.company, "default_" + fieldname) ) else: return None def get_default_cost_center(args, item=None, item_group=None, brand=None, company=None): cost_center = None if not company and args.get("company"): company = args.get("company") if args.get("project"): cost_center = frappe.db.get_value("Project", args.get("project"), "cost_center", cache=True) if not cost_center and (item and item_group and brand): if args.get("customer"): cost_center = ( item.get("selling_cost_center") or item_group.get("selling_cost_center") or brand.get("selling_cost_center") ) else: cost_center = ( item.get("buying_cost_center") or item_group.get("buying_cost_center") or brand.get("buying_cost_center") ) elif not cost_center and args.get("item_code") and company: for method in ["get_item_defaults", "get_item_group_defaults", "get_brand_defaults"]: path = "erpnext.stock.get_item_details.{0}".format(method) data = frappe.get_attr(path)(args.get("item_code"), company) if data and (data.selling_cost_center or data.buying_cost_center): return data.selling_cost_center or data.buying_cost_center if not cost_center and args.get("cost_center"): cost_center = args.get("cost_center") if ( company and cost_center and frappe.get_cached_value("Cost Center", cost_center, "company") != company ): return None if not cost_center and company: cost_center = frappe.get_cached_value("Company", company, "cost_center") return cost_center def get_default_supplier(args, item, item_group, brand): return ( item.get("default_supplier") or item_group.get("default_supplier") or brand.get("default_supplier") ) def get_price_list_rate(args, item_doc, out=None): if out is None: out = frappe._dict() meta = frappe.get_meta(args.parenttype or args.doctype) if meta.get_field("currency") or args.get("currency"): if not args.get("price_list_currency") or not args.get("plc_conversion_rate"): # if currency and plc_conversion_rate exist then # `get_price_list_currency_and_exchange_rate` has already been called pl_details = get_price_list_currency_and_exchange_rate(args) args.update(pl_details) if meta.get_field("currency"): validate_conversion_rate(args, meta) price_list_rate = get_price_list_rate_for(args, item_doc.name) # variant if price_list_rate is None and item_doc.variant_of: price_list_rate = get_price_list_rate_for(args, item_doc.variant_of) # insert in database if price_list_rate is None: if args.price_list and args.rate: insert_item_price(args) return out out.price_list_rate = ( flt(price_list_rate) * flt(args.plc_conversion_rate) / flt(args.conversion_rate) ) if frappe.db.get_single_value("Buying Settings", "disable_last_purchase_rate"): return out if not out.price_list_rate and args.transaction_type == "buying": from erpnext.stock.doctype.item.item import get_last_purchase_details out.update(get_last_purchase_details(item_doc.name, args.name, args.conversion_rate)) return out def insert_item_price(args): """Insert Item Price if Price List and Price List Rate are specified and currency is the same""" if frappe.db.get_value( "Price List", args.price_list, "currency", cache=True ) == args.currency and cint( frappe.db.get_single_value("Stock Settings", "auto_insert_price_list_rate_if_missing") ): if frappe.has_permission("Item Price", "write"): price_list_rate = ( (flt(args.rate) + flt(args.discount_amount)) / args.get("conversion_factor") if args.get("conversion_factor") else (flt(args.rate) + flt(args.discount_amount)) ) item_price = frappe.db.get_value( "Item Price", {"item_code": args.item_code, "price_list": args.price_list, "currency": args.currency}, ["name", "price_list_rate"], as_dict=1, ) if item_price and item_price.name: if item_price.price_list_rate != price_list_rate and frappe.db.get_single_value( "Stock Settings", "update_existing_price_list_rate" ): frappe.db.set_value("Item Price", item_price.name, "price_list_rate", price_list_rate) frappe.msgprint( _("Item Price updated for {0} in Price List {1}").format(args.item_code, args.price_list), alert=True, ) else: item_price = frappe.get_doc( { "doctype": "Item Price", "price_list": args.price_list, "item_code": args.item_code, "currency": args.currency, "price_list_rate": price_list_rate, "uom": args.stock_uom, } ) item_price.insert() frappe.msgprint( _("Item Price added for {0} in Price List {1}").format(args.item_code, args.price_list), alert=True, ) def get_item_price(args, item_code, ignore_party=False): """ Get name, price_list_rate from Item Price based on conditions Check if the desired qty is within the increment of the packing list. :param args: dict (or frappe._dict) with mandatory fields price_list, uom optional fields transaction_date, customer, supplier :param item_code: str, Item Doctype field item_code """ ip = frappe.qb.DocType("Item Price") query = ( frappe.qb.from_(ip) .select(ip.name, ip.price_list_rate, ip.uom) .where( (ip.item_code == item_code) & (ip.price_list == args.get("price_list")) & (IfNull(ip.uom, "").isin(["", args.get("uom")])) & (IfNull(ip.batch_no, "").isin(["", args.get("batch_no")])) ) .orderby(ip.valid_from, order=frappe.qb.desc) .orderby(IfNull(ip.batch_no, ""), order=frappe.qb.desc) .orderby(ip.uom, order=frappe.qb.desc) ) if not ignore_party: if args.get("customer"): query = query.where(ip.customer == args.get("customer")) elif args.get("supplier"): query = query.where(ip.supplier == args.get("supplier")) else: query = query.where((IfNull(ip.customer, "") == "") & (IfNull(ip.supplier, "") == "")) if args.get("transaction_date"): query = query.where( (IfNull(ip.valid_from, "2000-01-01") <= args["transaction_date"]) & (IfNull(ip.valid_upto, "2500-12-31") >= args["transaction_date"]) ) return query.run() def get_price_list_rate_for(args, item_code): """ :param customer: link to Customer DocType :param supplier: link to Supplier DocType :param price_list: str (Standard Buying or Standard Selling) :param item_code: str, Item Doctype field item_code :param qty: Desired Qty :param transaction_date: Date of the price """ item_price_args = { "item_code": item_code, "price_list": args.get("price_list"), "customer": args.get("customer"), "supplier": args.get("supplier"), "uom": args.get("uom"), "transaction_date": args.get("transaction_date"), "batch_no": args.get("batch_no"), } item_price_data = 0 price_list_rate = get_item_price(item_price_args, item_code) if price_list_rate: desired_qty = args.get("qty") if desired_qty and check_packing_list(price_list_rate[0][0], desired_qty, item_code): item_price_data = price_list_rate else: for field in ["customer", "supplier"]: del item_price_args[field] general_price_list_rate = get_item_price( item_price_args, item_code, ignore_party=args.get("ignore_party") ) if not general_price_list_rate and args.get("uom") != args.get("stock_uom"): item_price_args["uom"] = args.get("stock_uom") general_price_list_rate = get_item_price( item_price_args, item_code, ignore_party=args.get("ignore_party") ) if general_price_list_rate: item_price_data = general_price_list_rate if item_price_data: if item_price_data[0][2] == args.get("uom"): return item_price_data[0][1] elif not args.get("price_list_uom_dependant"): return flt(item_price_data[0][1] * flt(args.get("conversion_factor", 1))) else: return item_price_data[0][1] def check_packing_list(price_list_rate_name, desired_qty, item_code): """ Check if the desired qty is within the increment of the packing list. :param price_list_rate_name: Name of Item Price :param desired_qty: Desired Qt :param item_code: str, Item Doctype field item_code :param qty: Desired Qt """ flag = True item_price = frappe.get_doc("Item Price", price_list_rate_name) if item_price.packing_unit: packing_increment = desired_qty % item_price.packing_unit if packing_increment != 0: flag = False return flag def validate_conversion_rate(args, meta): from erpnext.controllers.accounts_controller import validate_conversion_rate company_currency = frappe.get_cached_value("Company", args.company, "default_currency") if not args.conversion_rate and args.currency == company_currency: args.conversion_rate = 1.0 if ( not args.ignore_conversion_rate and args.conversion_rate == 1 and args.currency != company_currency ): args.conversion_rate = ( get_exchange_rate(args.currency, company_currency, args.transaction_date, "for_buying") or 1.0 ) # validate currency conversion rate validate_conversion_rate( args.currency, args.conversion_rate, meta.get_label("conversion_rate"), args.company ) args.conversion_rate = flt( args.conversion_rate, get_field_precision(meta.get_field("conversion_rate"), frappe._dict({"fields": args})), ) if args.price_list: if not args.plc_conversion_rate and args.price_list_currency == frappe.db.get_value( "Price List", args.price_list, "currency", cache=True ): args.plc_conversion_rate = 1.0 # validate price list currency conversion rate if not args.get("price_list_currency"): throw(_("Price List Currency not selected")) else: validate_conversion_rate( args.price_list_currency, args.plc_conversion_rate, meta.get_label("plc_conversion_rate"), args.company, ) if meta.get_field("plc_conversion_rate"): args.plc_conversion_rate = flt( args.plc_conversion_rate, get_field_precision(meta.get_field("plc_conversion_rate"), frappe._dict({"fields": args})), ) def get_party_item_code(args, item_doc, out): if args.transaction_type == "selling" and args.customer: out.customer_item_code = None if args.quotation_to and args.quotation_to != "Customer": return customer_item_code = item_doc.get("customer_items", {"customer_name": args.customer}) if customer_item_code: out.customer_item_code = customer_item_code[0].ref_code else: customer_group = frappe.get_cached_value("Customer", args.customer, "customer_group") customer_group_item_code = item_doc.get("customer_items", {"customer_group": customer_group}) if customer_group_item_code and not customer_group_item_code[0].customer_name: out.customer_item_code = customer_group_item_code[0].ref_code if args.transaction_type == "buying" and args.supplier: item_supplier = item_doc.get("supplier_items", {"supplier": args.supplier}) out.supplier_part_no = item_supplier[0].supplier_part_no if item_supplier else None def get_pos_profile_item_details(company, args, pos_profile=None, update_data=False): res = frappe._dict() if not frappe.flags.pos_profile and not pos_profile: pos_profile = frappe.flags.pos_profile = get_pos_profile(company, args.get("pos_profile")) if pos_profile: for fieldname in ("income_account", "cost_center", "warehouse", "expense_account"): if (not args.get(fieldname) or update_data) and pos_profile.get(fieldname): res[fieldname] = pos_profile.get(fieldname) if res.get("warehouse"): res.actual_qty = get_bin_details( args.item_code, res.warehouse, include_child_warehouses=True ).get("actual_qty") return res @frappe.whitelist() def get_pos_profile(company, pos_profile=None, user=None): if pos_profile: return frappe.get_cached_doc("POS Profile", pos_profile) if not user: user = frappe.session["user"] pf = frappe.qb.DocType("POS Profile") pfu = frappe.qb.DocType("POS Profile User") query = ( frappe.qb.from_(pf) .left_join(pfu) .on(pf.name == pfu.parent) .select(pf.star) .where((pfu.user == user) & (pfu.default == 1)) ) if company: query = query.where(pf.company == company) pos_profile = query.run(as_dict=True) if not pos_profile and company: pos_profile = ( frappe.qb.from_(pf) .left_join(pfu) .on(pf.name == pfu.parent) .select(pf.star) .where((pf.company == company) & (pf.disabled == 0)) ).run(as_dict=True) return pos_profile and pos_profile[0] or None def get_serial_nos_by_fifo(args, sales_order=None): if frappe.db.get_single_value("Stock Settings", "automatically_set_serial_nos_based_on_fifo"): sn = frappe.qb.DocType("Serial No") query = ( frappe.qb.from_(sn) .select(sn.name) .where((sn.item_code == args.item_code) & (sn.warehouse == args.warehouse)) .orderby(CombineDatetime(sn.purchase_date, sn.purchase_time)) .limit(abs(cint(args.stock_qty))) ) if sales_order: query = query.where(sn.sales_order == sales_order) if args.batch_no: query = query.where(sn.batch_no == args.batch_no) serial_nos = query.run(as_list=True) serial_nos = [s[0] for s in serial_nos] return "\n".join(serial_nos) @frappe.whitelist() def get_conversion_factor(item_code, uom): variant_of = frappe.db.get_value("Item", item_code, "variant_of", cache=True) filters = {"parent": item_code, "uom": uom} if variant_of: filters["parent"] = ("in", (item_code, variant_of)) conversion_factor = frappe.db.get_value("UOM Conversion Detail", filters, "conversion_factor") if not conversion_factor: stock_uom = frappe.db.get_value("Item", item_code, "stock_uom") conversion_factor = get_uom_conv_factor(uom, stock_uom) return {"conversion_factor": conversion_factor or 1.0} @frappe.whitelist() def get_projected_qty(item_code, warehouse): return { "projected_qty": frappe.db.get_value( "Bin", {"item_code": item_code, "warehouse": warehouse}, "projected_qty" ) } @frappe.whitelist() def get_bin_details(item_code, warehouse, company=None, include_child_warehouses=False): bin_details = {"projected_qty": 0, "actual_qty": 0, "reserved_qty": 0} if warehouse: from frappe.query_builder.functions import Coalesce, Sum from erpnext.stock.doctype.warehouse.warehouse import get_child_warehouses warehouses = get_child_warehouses(warehouse) if include_child_warehouses else [warehouse] bin = frappe.qb.DocType("Bin") bin_details = ( frappe.qb.from_(bin) .select( Coalesce(Sum(bin.projected_qty), 0).as_("projected_qty"), Coalesce(Sum(bin.actual_qty), 0).as_("actual_qty"), Coalesce(Sum(bin.reserved_qty), 0).as_("reserved_qty"), ) .where((bin.item_code == item_code) & (bin.warehouse.isin(warehouses))) ).run(as_dict=True)[0] if company: bin_details["company_total_stock"] = get_company_total_stock(item_code, company) return bin_details def get_company_total_stock(item_code, company): bin = frappe.qb.DocType("Bin") wh = frappe.qb.DocType("Warehouse") return ( frappe.qb.from_(bin) .inner_join(wh) .on(bin.warehouse == wh.name) .select(Sum(bin.actual_qty)) .where((wh.company == company) & (bin.item_code == item_code)) ).run()[0][0] @frappe.whitelist() def get_serial_no_details(item_code, warehouse, stock_qty, serial_no): args = frappe._dict( {"item_code": item_code, "warehouse": warehouse, "stock_qty": stock_qty, "serial_no": serial_no} ) serial_no = get_serial_no(args) return {"serial_no": serial_no} @frappe.whitelist() def get_bin_details_and_serial_nos( item_code, warehouse, has_batch_no=None, stock_qty=None, serial_no=None ): bin_details_and_serial_nos = {} bin_details_and_serial_nos.update(get_bin_details(item_code, warehouse)) if flt(stock_qty) > 0: if has_batch_no: args = frappe._dict({"item_code": item_code, "warehouse": warehouse, "stock_qty": stock_qty}) serial_no = get_serial_no(args) bin_details_and_serial_nos.update({"serial_no": serial_no}) return bin_details_and_serial_nos bin_details_and_serial_nos.update( get_serial_no_details(item_code, warehouse, stock_qty, serial_no) ) return bin_details_and_serial_nos @frappe.whitelist() def get_batch_qty_and_serial_no(batch_no, stock_qty, warehouse, item_code, has_serial_no): batch_qty_and_serial_no = {} batch_qty_and_serial_no.update(get_batch_qty(batch_no, warehouse, item_code)) if (flt(batch_qty_and_serial_no.get("actual_batch_qty")) >= flt(stock_qty)) and has_serial_no: args = frappe._dict( {"item_code": item_code, "warehouse": warehouse, "stock_qty": stock_qty, "batch_no": batch_no} ) serial_no = get_serial_no(args) batch_qty_and_serial_no.update({"serial_no": serial_no}) return batch_qty_and_serial_no @frappe.whitelist() def get_batch_qty(batch_no, warehouse, item_code): from erpnext.stock.doctype.batch import batch if batch_no: return {"actual_batch_qty": batch.get_batch_qty(batch_no, warehouse)} @frappe.whitelist() def apply_price_list(args, as_doc=False): """Apply pricelist on a document-like dict object and return as {'parent': dict, 'children': list} :param args: See below :param as_doc: Updates value in the passed dict args = { "doctype": "", "name": "", "items": [{"doctype": "", "name": "", "item_code": "", "brand": "", "item_group": ""}, ...], "conversion_rate": 1.0, "selling_price_list": None, "price_list_currency": None, "price_list_uom_dependant": None, "plc_conversion_rate": 1.0, "doctype": "", "name": "", "supplier": None, "transaction_date": None, "conversion_rate": 1.0, "buying_price_list": None, "ignore_pricing_rule": 0/1 } """ args = process_args(args) parent = get_price_list_currency_and_exchange_rate(args) args.update(parent) children = [] if "items" in args: item_list = args.get("items") args.update(parent) for item in item_list: args_copy = frappe._dict(args.copy()) args_copy.update(item) item_details = apply_price_list_on_item(args_copy) children.append(item_details) if as_doc: args.price_list_currency = (parent.price_list_currency,) args.plc_conversion_rate = parent.plc_conversion_rate if args.get("items"): for i, item in enumerate(args.get("items")): for fieldname in children[i]: # if the field exists in the original doc # update the value if fieldname in item and fieldname not in ("name", "doctype"): item[fieldname] = children[i][fieldname] return args else: return {"parent": parent, "children": children} def apply_price_list_on_item(args): item_doc = frappe.db.get_value("Item", args.item_code, ["name", "variant_of"], as_dict=1) item_details = get_price_list_rate(args, item_doc) item_details.update(get_pricing_rule_for_item(args)) return item_details def get_price_list_currency_and_exchange_rate(args): if not args.price_list: return {} if args.doctype in ["Quotation", "Sales Order", "Delivery Note", "Sales Invoice"]: args.update({"exchange_rate": "for_selling"}) elif args.doctype in ["Purchase Order", "Purchase Receipt", "Purchase Invoice"]: args.update({"exchange_rate": "for_buying"}) price_list_details = get_price_list_details(args.price_list) price_list_currency = price_list_details.get("currency") price_list_uom_dependant = price_list_details.get("price_list_uom_dependant") plc_conversion_rate = args.plc_conversion_rate company_currency = get_company_currency(args.company) if (not plc_conversion_rate) or ( price_list_currency and args.price_list_currency and price_list_currency != args.price_list_currency ): # cksgb 19/09/2016: added args.transaction_date as posting_date argument for get_exchange_rate plc_conversion_rate = ( get_exchange_rate( price_list_currency, company_currency, args.transaction_date, args.exchange_rate ) or plc_conversion_rate ) return frappe._dict( { "price_list_currency": price_list_currency, "price_list_uom_dependant": price_list_uom_dependant, "plc_conversion_rate": plc_conversion_rate or 1, } ) @frappe.whitelist() def get_default_bom(item_code=None): def _get_bom(item): bom = frappe.get_all( "BOM", dict(item=item, is_active=True, is_default=True, docstatus=1), limit=1 ) return bom[0].name if bom else None if not item_code: return bom_name = _get_bom(item_code) template_item = frappe.db.get_value("Item", item_code, "variant_of") if not bom_name and template_item: bom_name = _get_bom(template_item) return bom_name @frappe.whitelist() def get_valuation_rate(item_code, company, warehouse=None): item = get_item_defaults(item_code, company) item_group = get_item_group_defaults(item_code, company) brand = get_brand_defaults(item_code, company) # item = frappe.get_doc("Item", item_code) if item.get("is_stock_item"): if not warehouse: warehouse = ( item.get("default_warehouse") or item_group.get("default_warehouse") or brand.get("default_warehouse") ) return frappe.db.get_value( "Bin", {"item_code": item_code, "warehouse": warehouse}, ["valuation_rate"], as_dict=True ) or {"valuation_rate": 0} elif not item.get("is_stock_item"): pi_item = frappe.qb.DocType("Purchase Invoice Item") valuation_rate = ( frappe.qb.from_(pi_item) .select((Sum(pi_item.base_net_amount) / Sum(pi_item.qty * pi_item.conversion_factor))) .where((pi_item.docstatus == 1) & (pi_item.item_code == item_code)) ).run() if valuation_rate: return {"valuation_rate": valuation_rate[0][0] or 0.0} else: return {"valuation_rate": 0.0} def get_gross_profit(out): if out.valuation_rate: out.update({"gross_profit": ((out.base_rate - out.valuation_rate) * out.stock_qty)}) return out @frappe.whitelist() def get_serial_no(args, serial_nos=None, sales_order=None): serial_no = None if isinstance(args, str): args = json.loads(args) args = frappe._dict(args) if args.get("doctype") == "Sales Invoice" and not args.get("update_stock"): return "" if args.get("warehouse") and args.get("stock_qty") and args.get("item_code"): has_serial_no = frappe.get_value("Item", {"item_code": args.item_code}, "has_serial_no") if args.get("batch_no") and has_serial_no == 1: return get_serial_nos_by_fifo(args, sales_order) elif has_serial_no == 1: args = json.dumps( { "item_code": args.get("item_code"), "warehouse": args.get("warehouse"), "stock_qty": args.get("stock_qty"), } ) args = process_args(args) serial_no = get_serial_nos_by_fifo(args, sales_order) if not serial_no and serial_nos: # For POS serial_no = serial_nos return serial_no def update_party_blanket_order(args, out): if out["against_blanket_order"]: blanket_order_details = get_blanket_order_details(args) if blanket_order_details: out.update(blanket_order_details) @frappe.whitelist() def get_blanket_order_details(args): if isinstance(args, str): args = frappe._dict(json.loads(args)) blanket_order_details = None if args.item_code: bo = frappe.qb.DocType("Blanket Order") bo_item = frappe.qb.DocType("Blanket Order Item") query = ( frappe.qb.from_(bo) .from_(bo_item) .select(bo_item.rate.as_("blanket_order_rate"), bo.name.as_("blanket_order")) .where( (bo.company == args.company) & (bo_item.item_code == args.item_code) & (bo.docstatus == 1) & (bo.name == bo_item.parent) ) ) if args.customer and args.doctype == "Sales Order": query = query.where(bo.customer == args.customer) elif args.supplier and args.doctype == "Purchase Order": query = query.where(bo.supplier == args.supplier) if args.blanket_order: query = query.where(bo.name == args.blanket_order) if args.transaction_date: query = query.where(bo.to_date >= args.transaction_date) blanket_order_details = query.run(as_dict=True) blanket_order_details = blanket_order_details[0] if blanket_order_details else "" return blanket_order_details def get_so_reservation_for_item(args): reserved_so = None if args.get("against_sales_order"): if get_reserved_qty_for_so(args.get("against_sales_order"), args.get("item_code")): reserved_so = args.get("against_sales_order") elif args.get("against_sales_invoice"): sales_order = frappe.db.get_all( "Sales Invoice Item", filters={ "parent": args.get("against_sales_invoice"), "item_code": args.get("item_code"), "docstatus": 1, }, fields="sales_order", ) if sales_order and sales_order[0]: if get_reserved_qty_for_so(sales_order[0].sales_order, args.get("item_code")): reserved_so = sales_order[0] elif args.get("sales_order"): if get_reserved_qty_for_so(args.get("sales_order"), args.get("item_code")): reserved_so = args.get("sales_order") return reserved_so def get_reserved_qty_for_so(sales_order, item_code): reserved_qty = frappe.db.get_value( "Sales Order Item", filters={ "parent": sales_order, "item_code": item_code, "ensure_delivery_based_on_produced_serial_no": 1, }, fieldname="sum(qty)", ) return reserved_qty or 0